GI.GstBase.Objects.AggregatorPad

Pads managed by a GstAggregor subclass.

This class used to live in gst-plugins-bad and was moved to core.

Since: 1.14

Exported types

newtype AggregatorPad

Memory-managed wrapper type.

Constructors

AggregatorPad (ManagedPtr AggregatorPad)

Instances

GObject AggregatorPad

Defined in GI.GstBase.Objects.AggregatorPad

Methods

gobjectType :: IO GType

HasParentTypes AggregatorPad

Defined in GI.GstBase.Objects.AggregatorPad

type ParentTypes AggregatorPad

Defined in GI.GstBase.Objects.AggregatorPad

type ParentTypes AggregatorPad = Pad ': (Object ': (Object ': ([] :: [Type])))

class (GObject o, IsDescendantOf AggregatorPad o) => IsAggregatorPad o

Type class for types which can be safely cast to AggregatorPad, for instance with toAggregatorPad.

Instances

(GObject o, IsDescendantOf AggregatorPad o) => IsAggregatorPad o

Defined in GI.GstBase.Objects.AggregatorPad

toAggregatorPad :: (MonadIO m, IsAggregatorPad o) => o -> m AggregatorPad

Cast to AggregatorPad, for types for which this is known to be safe. For general casts, use castTo.

noAggregatorPad :: Maybe AggregatorPad

A convenience alias for Nothing :: Maybe AggregatorPad.

Methods

dropBuffer

aggregatorPadDropBuffer

Arguments

:: (HasCallStack, MonadIO m, IsAggregatorPad a)

=> a

pad: the pad where to drop any pending buffer

-> m Bool

Returns: TRUE if there was a buffer queued in pad, or FALSE if not.

Drop the buffer currently queued in pad.

hasBuffer

aggregatorPadHasBuffer

Arguments

:: (HasCallStack, MonadIO m, IsAggregatorPad a)

=> a

pad: the pad to check the buffer on

-> m Bool

Returns: True if the pad has a buffer available as the next thing.

This checks if a pad has a buffer available that will be returned by a call to aggregatorPadPeekBuffer or aggregatorPadPopBuffer.

Since: 1.14.1

isEos

aggregatorPadIsEos

Arguments

:: (HasCallStack, MonadIO m, IsAggregatorPad a)

=> a

pad: an aggregator pad

-> m Bool

Returns: True if the pad is EOS, otherwise False.

No description available in the introspection data.

peekBuffer

aggregatorPadPeekBuffer

Arguments

:: (HasCallStack, MonadIO m, IsAggregatorPad a)

=> a

pad: the pad to get buffer from

-> m Buffer

Returns: A reference to the buffer in pad or NULL if no buffer was queued. You should unref the buffer after usage.

No description available in the introspection data.

popBuffer

aggregatorPadPopBuffer

Arguments

:: (HasCallStack, MonadIO m, IsAggregatorPad a)

=> a

pad: the pad to get buffer from

-> m Buffer

Returns: The buffer in pad or NULL if no buffer was queued. You should unref the buffer after usage.

Steal the ref to the buffer currently queued in pad.

Properties

emitSignals

Enables the emission of signals such as AggregatorPad::buffer-consumed

Since: 1.16

constructAggregatorPadEmitSignals :: IsAggregatorPad o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “emit-signals” property. This is rarely needed directly, but it is used by new.

getAggregatorPadEmitSignals :: (MonadIO m, IsAggregatorPad o) => o -> m Bool

Get the value of the “emit-signals” property. When overloading is enabled, this is equivalent to

get aggregatorPad #emitSignals

setAggregatorPadEmitSignals :: (MonadIO m, IsAggregatorPad o) => o -> Bool -> m ()

Set the value of the “emit-signals” property. When overloading is enabled, this is equivalent to

set aggregatorPad [ #emitSignals := value ]

Signals

bufferConsumed

type AggregatorPadBufferConsumedCallback = Buffer -> IO ()

No description available in the introspection data.

type C_AggregatorPadBufferConsumedCallback = Ptr () -> Ptr Buffer -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

afterAggregatorPadBufferConsumed :: (IsAggregatorPad a, MonadIO m) => a -> AggregatorPadBufferConsumedCallback -> m SignalHandlerId

Connect a signal handler for the “buffer-consumed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after aggregatorPad #bufferConsumed callback

genClosure_AggregatorPadBufferConsumed :: MonadIO m => AggregatorPadBufferConsumedCallback -> m (GClosure C_AggregatorPadBufferConsumedCallback)

Wrap the callback into a GClosure.

mk_AggregatorPadBufferConsumedCallback :: C_AggregatorPadBufferConsumedCallback -> IO (FunPtr C_AggregatorPadBufferConsumedCallback)

Generate a function pointer callable from C code, from a C_AggregatorPadBufferConsumedCallback.

noAggregatorPadBufferConsumedCallback :: Maybe AggregatorPadBufferConsumedCallback

A convenience synonym for Nothing :: Maybe AggregatorPadBufferConsumedCallback.

onAggregatorPadBufferConsumed :: (IsAggregatorPad a, MonadIO m) => a -> AggregatorPadBufferConsumedCallback -> m SignalHandlerId

Connect a signal handler for the “buffer-consumed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on aggregatorPad #bufferConsumed callback

wrap_AggregatorPadBufferConsumedCallback :: AggregatorPadBufferConsumedCallback -> C_AggregatorPadBufferConsumedCallback

Wrap a AggregatorPadBufferConsumedCallback into a C_AggregatorPadBufferConsumedCallback.