Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.GstVideo.Structs.VideoCodecState

Contents

Exported types
Methods
Properties

Description

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 gstVideoDecoderSetOutputState() or gstVideoEncoderSetOutputState() methods.

Synopsis

newtype VideoCodecState = VideoCodecState (ManagedPtr VideoCodecState)
newZeroVideoCodecState :: MonadIO m => m VideoCodecState
noVideoCodecState :: Maybe VideoCodecState
videoCodecStateRef :: (HasCallStack, MonadIO m) => VideoCodecState -> m VideoCodecState
videoCodecStateUnref :: (HasCallStack, MonadIO m) => VideoCodecState -> m ()
clearVideoCodecStateAllocationCaps :: MonadIO m => VideoCodecState -> m ()
getVideoCodecStateAllocationCaps :: MonadIO m => VideoCodecState -> m (Maybe Caps)
setVideoCodecStateAllocationCaps :: MonadIO m => VideoCodecState -> Ptr Caps -> m ()
clearVideoCodecStateCaps :: MonadIO m => VideoCodecState -> m ()
getVideoCodecStateCaps :: MonadIO m => VideoCodecState -> m (Maybe Caps)
setVideoCodecStateCaps :: MonadIO m => VideoCodecState -> Ptr Caps -> m ()
clearVideoCodecStateCodecData :: MonadIO m => VideoCodecState -> m ()
getVideoCodecStateCodecData :: MonadIO m => VideoCodecState -> m (Maybe Buffer)
setVideoCodecStateCodecData :: MonadIO m => VideoCodecState -> Ptr Buffer -> m ()
getVideoCodecStateInfo :: MonadIO m => VideoCodecState -> m VideoInfo

Exported types

newtype VideoCodecState Source #

Memory-managed wrapper type.

Constructors

VideoCodecState (ManagedPtr VideoCodecState)

Instances

Instances details

Eq VideoCodecState Source #
Instance details Defined in GI.GstVideo.Structs.VideoCodecState Methods (==) :: VideoCodecState -> VideoCodecState -> Bool # (/=) :: VideoCodecState -> VideoCodecState -> Bool #
BoxedObject VideoCodecState Source #
Instance details Defined in GI.GstVideo.Structs.VideoCodecState Methods boxedType :: VideoCodecState -> IO GType #
IsGValue VideoCodecState Source #	Convert `VideoCodecState` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.GstVideo.Structs.VideoCodecState Methods toGValue :: VideoCodecState -> IO GValue # fromGValue :: GValue -> IO VideoCodecState #
tag ~ 'AttrSet => Constructible VideoCodecState tag Source #
Instance details Defined in GI.GstVideo.Structs.VideoCodecState Methods new :: MonadIO m => (ManagedPtr VideoCodecState -> VideoCodecState) -> [AttrOp VideoCodecState tag] -> m VideoCodecState #

newZeroVideoCodecState :: MonadIO m => m VideoCodecState Source #

Construct a VideoCodecState struct initialized to zero.

noVideoCodecState :: Maybe VideoCodecState Source #

A convenience alias for Nothing :: Maybe VideoCodecState.

Methods

Overloaded methods

ref

videoCodecStateRef Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoCodecState	`state`: a `VideoCodecState`
-> m VideoCodecState	Returns: `buf`

Increases the refcount of the given state by one.

unref

videoCodecStateUnref Source #

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

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

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

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

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

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

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

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

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

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

set videoCodecState [ #codecData := value ]

info

The VideoInfo describing the stream

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

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

get videoCodecState #info