gi-gstbase-1.0.23: GStreamerBase bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.GstBase.Objects.AggregatorPad

Description

Pads managed by a GstAggregor subclass.

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

Since: 1.14

Synopsis

Exported types

newtype AggregatorPad Source #

Memory-managed wrapper type.

Constructors

AggregatorPad (ManagedPtr AggregatorPad) 

Instances

Instances details
Eq AggregatorPad Source # 
Instance details

Defined in GI.GstBase.Objects.AggregatorPad

GObject AggregatorPad Source # 
Instance details

Defined in GI.GstBase.Objects.AggregatorPad

ManagedPtrNewtype AggregatorPad Source # 
Instance details

Defined in GI.GstBase.Objects.AggregatorPad

Methods

toManagedPtr :: AggregatorPad -> ManagedPtr AggregatorPad

TypedObject AggregatorPad Source # 
Instance details

Defined in GI.GstBase.Objects.AggregatorPad

Methods

glibType :: IO GType

IsGValue AggregatorPad Source #

Convert AggregatorPad to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.GstBase.Objects.AggregatorPad

Methods

toGValue :: AggregatorPad -> IO GValue

fromGValue :: GValue -> IO AggregatorPad

HasParentTypes AggregatorPad Source # 
Instance details

Defined in GI.GstBase.Objects.AggregatorPad

type ParentTypes AggregatorPad Source # 
Instance details

Defined in GI.GstBase.Objects.AggregatorPad

type ParentTypes AggregatorPad = '[Pad, Object, Object]

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

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

Instances

Instances details
(GObject o, IsDescendantOf AggregatorPad o) => IsAggregatorPad o Source # 
Instance details

Defined in GI.GstBase.Objects.AggregatorPad

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

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

Methods

Overloaded methods

dropBuffer

aggregatorPadDropBuffer Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 bufferConsumed

Since: 1.16

constructAggregatorPadEmitSignals :: (IsAggregatorPad o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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 Source #

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 () Source #

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 () Source #

No description available in the introspection data.

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

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

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

Connect a signal handler for the bufferConsumed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after aggregatorPad #bufferConsumed callback

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

Connect a signal handler for the bufferConsumed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on aggregatorPad #bufferConsumed callback