GI.GstVideo.Objects.VideoAggregatorPad

No description available in the introspection data.

Exported types

newtype VideoAggregatorPad

Memory-managed wrapper type.

Constructors

VideoAggregatorPad (ManagedPtr VideoAggregatorPad)

Instances

GObject VideoAggregatorPad

Defined in GI.GstVideo.Objects.VideoAggregatorPad

Methods

gobjectType :: IO GType

HasParentTypes VideoAggregatorPad

Defined in GI.GstVideo.Objects.VideoAggregatorPad

type ParentTypes VideoAggregatorPad

Defined in GI.GstVideo.Objects.VideoAggregatorPad

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

class (GObject o, IsDescendantOf VideoAggregatorPad o) => IsVideoAggregatorPad o

Type class for types which can be safely cast to VideoAggregatorPad, for instance with toVideoAggregatorPad.

Instances

(GObject o, IsDescendantOf VideoAggregatorPad o) => IsVideoAggregatorPad o

Defined in GI.GstVideo.Objects.VideoAggregatorPad

toVideoAggregatorPad :: (MonadIO m, IsVideoAggregatorPad o) => o -> m VideoAggregatorPad

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

noVideoAggregatorPad :: Maybe VideoAggregatorPad

A convenience alias for Nothing :: Maybe VideoAggregatorPad.

Methods

getCurrentBuffer

videoAggregatorPadGetCurrentBuffer

Arguments

:: (HasCallStack, MonadIO m, IsVideoAggregatorPad a)

=> a

pad: a VideoAggregatorPad

-> m Buffer

Returns: The currently queued buffer

Returns the currently queued buffer that is going to be used for the current output frame.

This must only be called from the aggregate_frames() virtual method, or from the prepare_frame() virtual method of the aggregator pads.

The return value is only valid until aggregate_frames() or prepare_frames() returns.

getPreparedFrame

videoAggregatorPadGetPreparedFrame

Arguments

:: (HasCallStack, MonadIO m, IsVideoAggregatorPad a)

=> a

pad: a VideoAggregatorPad

-> m VideoFrame

Returns: The currently prepared video frame

Returns the currently prepared video frame that has to be aggregated into the current output frame.

This must only be called from the aggregate_frames() virtual method, or from the prepare_frame() virtual method of the aggregator pads.

The return value is only valid until aggregate_frames() or prepare_frames() returns.

hasCurrentBuffer

videoAggregatorPadHasCurrentBuffer

Arguments

:: (HasCallStack, MonadIO m, IsVideoAggregatorPad a)

=> a

pad: a VideoAggregatorPad

-> m Bool

Returns: True if the pad has currently a buffer queued

Checks if the pad currently has a buffer queued that is going to be used for the current output frame.

This must only be called from the aggregate_frames() virtual method, or from the prepare_frame() virtual method of the aggregator pads.

setNeedsAlpha

videoAggregatorPadSetNeedsAlpha

Arguments

:: (HasCallStack, MonadIO m, IsVideoAggregatorPad a)

=> a

pad: a VideoAggregatorPad

-> Bool

needsAlpha: True if this pad requires alpha output

-> m ()

Allows selecting that this pad requires an output format with alpha

Properties

repeatAfterEos

No description available in the introspection data.

constructVideoAggregatorPadRepeatAfterEos :: IsVideoAggregatorPad o => Bool -> IO (GValueConstruct o)

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

getVideoAggregatorPadRepeatAfterEos :: (MonadIO m, IsVideoAggregatorPad o) => o -> m Bool

Get the value of the “repeat-after-eos” property. When overloading is enabled, this is equivalent to

get videoAggregatorPad #repeatAfterEos

setVideoAggregatorPadRepeatAfterEos :: (MonadIO m, IsVideoAggregatorPad o) => o -> Bool -> m ()

Set the value of the “repeat-after-eos” property. When overloading is enabled, this is equivalent to

set videoAggregatorPad [ #repeatAfterEos := value ]

zorder

No description available in the introspection data.

constructVideoAggregatorPadZorder :: IsVideoAggregatorPad o => Word32 -> IO (GValueConstruct o)

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

getVideoAggregatorPadZorder :: (MonadIO m, IsVideoAggregatorPad o) => o -> m Word32

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

get videoAggregatorPad #zorder

setVideoAggregatorPadZorder :: (MonadIO m, IsVideoAggregatorPad o) => o -> Word32 -> m ()

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

set videoAggregatorPad [ #zorder := value ]