Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- newtype VideoCodecState = VideoCodecState (ManagedPtr VideoCodecState)
- newZeroVideoCodecState :: MonadIO m => m 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 ()
- clearVideoCodecStateContentLightLevel :: MonadIO m => VideoCodecState -> m ()
- getVideoCodecStateContentLightLevel :: MonadIO m => VideoCodecState -> m (Maybe VideoContentLightLevel)
- setVideoCodecStateContentLightLevel :: MonadIO m => VideoCodecState -> Ptr VideoContentLightLevel -> m ()
- getVideoCodecStateInfo :: MonadIO m => VideoCodecState -> m VideoInfo
- clearVideoCodecStateMasteringDisplayInfo :: MonadIO m => VideoCodecState -> m ()
- getVideoCodecStateMasteringDisplayInfo :: MonadIO m => VideoCodecState -> m (Maybe VideoMasteringDisplayInfo)
- setVideoCodecStateMasteringDisplayInfo :: MonadIO m => VideoCodecState -> Ptr VideoMasteringDisplayInfo -> m ()
Exported types
newtype VideoCodecState Source #
Memory-managed wrapper type.
Instances
newZeroVideoCodecState :: MonadIO m => m VideoCodecState Source #
Construct a VideoCodecState
struct initialized to zero.
Methods
Click to display all available methods, including inherited ones
ref
:: (HasCallStack, MonadIO m) | |
=> VideoCodecState |
|
-> m VideoCodecState | Returns: |
Increases the refcount of the given state by one.
unref
:: (HasCallStack, MonadIO m) | |
=> 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 ]
contentLightLevel
Content light level information for the stream.
Since: 1.20
clearVideoCodecStateContentLightLevel :: MonadIO m => VideoCodecState -> m () Source #
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) Source #
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 () Source #
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 Source #
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 () Source #
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) Source #
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 () Source #
Set the value of the “mastering_display_info
” field.
When overloading is enabled, this is equivalent to
set
videoCodecState [ #masteringDisplayInfo:=
value ]