GI.GstVideo.Structs.VideoCodecState

Structure representing the state of an incoming or outgoing video stream for encoders and decoders.

Decoders and encoders will receive such a state through their respective setFormat vmethods.

Decoders and encoders can set the downstream state, by using the videoDecoderSetOutputState or videoEncoderSetOutputState methods.

Exported types

newtype VideoCodecState

Memory-managed wrapper type.

Constructors

VideoCodecState (ManagedPtr VideoCodecState)

Instances

Eq VideoCodecState

Defined in GI.GstVideo.Structs.VideoCodecState

Methods

(==) :: VideoCodecState -> VideoCodecState -> Bool

(/=) :: VideoCodecState -> VideoCodecState -> Bool

GBoxed VideoCodecState

Defined in GI.GstVideo.Structs.VideoCodecState

ManagedPtrNewtype VideoCodecState

Defined in GI.GstVideo.Structs.VideoCodecState

Methods

toManagedPtr :: VideoCodecState -> ManagedPtr VideoCodecState

TypedObject VideoCodecState

Defined in GI.GstVideo.Structs.VideoCodecState

Methods

glibType :: IO GType

HasParentTypes VideoCodecState

Defined in GI.GstVideo.Structs.VideoCodecState

tag ~ 'AttrSet => Constructible VideoCodecState tag

Defined in GI.GstVideo.Structs.VideoCodecState

Methods

new :: MonadIO m => (ManagedPtr VideoCodecState -> VideoCodecState) -> [AttrOp VideoCodecState tag] -> m VideoCodecState

IsGValue (Maybe VideoCodecState)

Convert VideoCodecState to and from GValue. See toGValue and fromGValue.

Defined in GI.GstVideo.Structs.VideoCodecState

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe VideoCodecState -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe VideoCodecState)

type ParentTypes VideoCodecState

Defined in GI.GstVideo.Structs.VideoCodecState

type ParentTypes VideoCodecState = '[] :: [Type]

newZeroVideoCodecState :: MonadIO m => m VideoCodecState

Construct a VideoCodecState struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

ref, unref.

Getters

None.

Setters

None.

ref

videoCodecStateRef

Arguments

:: (HasCallStack, MonadIO m)

=> VideoCodecState

state: a VideoCodecState

-> m VideoCodecState

Returns: buf

Increases the refcount of the given state by one.

unref

videoCodecStateUnref

Arguments

:: (HasCallStack, MonadIO m)

=> VideoCodecState

state: a VideoCodecState

-> m ()

Decreases the refcount of the state. If the refcount reaches 0, the state will be freed.

Properties

allocationCaps

The Caps for allocation query and pool negotiation. Since: 1.10

clearVideoCodecStateAllocationCaps :: MonadIO m => VideoCodecState -> m ()

Set the value of the “allocation_caps” field to Nothing. When overloading is enabled, this is equivalent to

clear #allocationCaps

getVideoCodecStateAllocationCaps :: MonadIO m => VideoCodecState -> m (Maybe Caps)

Get the value of the “allocation_caps” field. When overloading is enabled, this is equivalent to

get videoCodecState #allocationCaps

setVideoCodecStateAllocationCaps :: MonadIO m => VideoCodecState -> Ptr Caps -> m ()

Set the value of the “allocation_caps” field. When overloading is enabled, this is equivalent to

set videoCodecState [ #allocationCaps := value ]

caps

The Caps used in the caps negotiation of the pad.

clearVideoCodecStateCaps :: MonadIO m => VideoCodecState -> m ()

Set the value of the “caps” field to Nothing. When overloading is enabled, this is equivalent to

clear #caps

getVideoCodecStateCaps :: MonadIO m => VideoCodecState -> m (Maybe Caps)

Get the value of the “caps” field. When overloading is enabled, this is equivalent to

get videoCodecState #caps

setVideoCodecStateCaps :: MonadIO m => VideoCodecState -> Ptr Caps -> m ()

Set the value of the “caps” field. When overloading is enabled, this is equivalent to

set videoCodecState [ #caps := value ]

codecData

a Buffer corresponding to the 'codec_data' field of a stream, or NULL.

clearVideoCodecStateCodecData :: MonadIO m => VideoCodecState -> m ()

Set the value of the “codec_data” field to Nothing. When overloading is enabled, this is equivalent to

clear #codecData

getVideoCodecStateCodecData :: MonadIO m => VideoCodecState -> m (Maybe Buffer)

Get the value of the “codec_data” field. When overloading is enabled, this is equivalent to

get videoCodecState #codecData

setVideoCodecStateCodecData :: MonadIO m => VideoCodecState -> Ptr Buffer -> m ()

Set the value of the “codec_data” field. When overloading is enabled, this is equivalent to

set videoCodecState [ #codecData := value ]

contentLightLevel

Content light level information for the stream.

Since: 1.20

clearVideoCodecStateContentLightLevel :: MonadIO m => VideoCodecState -> m ()

Set the value of the “content_light_level” field to Nothing. When overloading is enabled, this is equivalent to

clear #contentLightLevel

getVideoCodecStateContentLightLevel :: MonadIO m => VideoCodecState -> m (Maybe VideoContentLightLevel)

Get the value of the “content_light_level” field. When overloading is enabled, this is equivalent to

get videoCodecState #contentLightLevel

setVideoCodecStateContentLightLevel :: MonadIO m => VideoCodecState -> Ptr VideoContentLightLevel -> m ()

Set the value of the “content_light_level” field. When overloading is enabled, this is equivalent to

set videoCodecState [ #contentLightLevel := value ]

info

The VideoInfo describing the stream

getVideoCodecStateInfo :: MonadIO m => VideoCodecState -> m VideoInfo

Get the value of the “info” field. When overloading is enabled, this is equivalent to

get videoCodecState #info

masteringDisplayInfo

Mastering display color volume information (HDR metadata) for the stream.

Since: 1.20

clearVideoCodecStateMasteringDisplayInfo :: MonadIO m => VideoCodecState -> m ()

Set the value of the “mastering_display_info” field to Nothing. When overloading is enabled, this is equivalent to

clear #masteringDisplayInfo

getVideoCodecStateMasteringDisplayInfo :: MonadIO m => VideoCodecState -> m (Maybe VideoMasteringDisplayInfo)

Get the value of the “mastering_display_info” field. When overloading is enabled, this is equivalent to

get videoCodecState #masteringDisplayInfo

setVideoCodecStateMasteringDisplayInfo :: MonadIO m => VideoCodecState -> Ptr VideoMasteringDisplayInfo -> m ()

Set the value of the “mastering_display_info” field. When overloading is enabled, this is equivalent to

set videoCodecState [ #masteringDisplayInfo := value ]