GI.GstVideo.Structs.AncillaryMeta

Meta for carrying SMPTE-291M Ancillary data. Note that all the ADF fields (dID to checksum) are 10bit values with parity/non-parity high-bits set.

Since: 1.24

Exported types

newtype AncillaryMeta

Memory-managed wrapper type.

Constructors

AncillaryMeta (ManagedPtr AncillaryMeta)

Instances

Eq AncillaryMeta

Defined in GI.GstVideo.Structs.AncillaryMeta

Methods

(==) :: AncillaryMeta -> AncillaryMeta -> Bool

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

BoxedPtr AncillaryMeta

Defined in GI.GstVideo.Structs.AncillaryMeta

Methods

boxedPtrCopy :: AncillaryMeta -> IO AncillaryMeta

boxedPtrFree :: AncillaryMeta -> IO ()

CallocPtr AncillaryMeta

Defined in GI.GstVideo.Structs.AncillaryMeta

Methods

boxedPtrCalloc :: IO (Ptr AncillaryMeta)

ManagedPtrNewtype AncillaryMeta

Defined in GI.GstVideo.Structs.AncillaryMeta

Methods

toManagedPtr :: AncillaryMeta -> ManagedPtr AncillaryMeta

tag ~ 'AttrSet => Constructible AncillaryMeta tag

Defined in GI.GstVideo.Structs.AncillaryMeta

Methods

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

newZeroAncillaryMeta :: MonadIO m => m AncillaryMeta

Construct a AncillaryMeta struct initialized to zero.

Methods

getInfo

ancillaryMetaGetInfo :: (HasCallStack, MonadIO m) => m MetaInfo

No description available in the introspection data.

Properties

cNotYChannel

Which channel (luminance or chrominance) the ancillary data is located. 0 if content is SD or stored in the luminance channel (default). 1 if HD and stored in the chrominance channel.

getAncillaryMetaCNotYChannel :: MonadIO m => AncillaryMeta -> m Bool

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

get ancillaryMeta #cNotYChannel

setAncillaryMetaCNotYChannel :: MonadIO m => AncillaryMeta -> Bool -> m ()

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

set ancillaryMeta [ #cNotYChannel := value ]

checksum

The checksum of the ADF

getAncillaryMetaChecksum :: MonadIO m => AncillaryMeta -> m Word16

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

get ancillaryMeta #checksum

setAncillaryMetaChecksum :: MonadIO m => AncillaryMeta -> Word16 -> m ()

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

set ancillaryMeta [ #checksum := value ]

dID

Data Identified

getAncillaryMetaDID :: MonadIO m => AncillaryMeta -> m Word16

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

get ancillaryMeta #dID

setAncillaryMetaDID :: MonadIO m => AncillaryMeta -> Word16 -> m ()

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

set ancillaryMeta [ #dID := value ]

data

The User data

getAncillaryMetaData :: MonadIO m => AncillaryMeta -> m Word16

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

get ancillaryMeta #data

setAncillaryMetaData :: MonadIO m => AncillaryMeta -> Word16 -> m ()

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

set ancillaryMeta [ #data := value ]

dataCount

The amount of user data

getAncillaryMetaDataCount :: MonadIO m => AncillaryMeta -> m Word16

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

get ancillaryMeta #dataCount

setAncillaryMetaDataCount :: MonadIO m => AncillaryMeta -> Word16 -> m ()

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

set ancillaryMeta [ #dataCount := value ]

field

The field where the ancillary data is located

getAncillaryMetaField :: MonadIO m => AncillaryMeta -> m AncillaryMetaField

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

get ancillaryMeta #field

setAncillaryMetaField :: MonadIO m => AncillaryMeta -> AncillaryMetaField -> m ()

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

set ancillaryMeta [ #field := value ]

line

The line on which the ancillary data is located (max 11bit). There are two special values: 0x7ff if no line is specified (default), 0x7fe to specify the ancillary data is on any valid line before active video

getAncillaryMetaLine :: MonadIO m => AncillaryMeta -> m Word16

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

get ancillaryMeta #line

setAncillaryMetaLine :: MonadIO m => AncillaryMeta -> Word16 -> m ()

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

set ancillaryMeta [ #line := value ]

meta

Parent Meta

getAncillaryMetaMeta :: MonadIO m => AncillaryMeta -> m Meta

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

get ancillaryMeta #meta

offset

The location of the ancillary data packet in a SDI raster relative to the start of active video (max 12bits). A value of 0 means the ADF of the ancillary packet starts immediately following SAV. There are 3 special values: 0xfff: No specified location (default), 0xffe: within HANC data space, 0xffd: within the ancillary data space located between SAV and EAV

getAncillaryMetaOffset :: MonadIO m => AncillaryMeta -> m Word16

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

get ancillaryMeta #offset

setAncillaryMetaOffset :: MonadIO m => AncillaryMeta -> Word16 -> m ()

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

set ancillaryMeta [ #offset := value ]

sDIDBlockNumber

Secondary Data identification (if type 2) or Data block number (if type 1)

getAncillaryMetaSDIDBlockNumber :: MonadIO m => AncillaryMeta -> m Word16

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

get ancillaryMeta #sDIDBlockNumber

setAncillaryMetaSDIDBlockNumber :: MonadIO m => AncillaryMeta -> Word16 -> m ()

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

set ancillaryMeta [ #sDIDBlockNumber := value ]