GI.GstVideo.Structs.VideoVBIEncoder

An encoder for writing ancillary data to the Vertical Blanking Interval lines of component signals.

Since: 1.16

Exported types

newtype VideoVBIEncoder

Memory-managed wrapper type.

Constructors

VideoVBIEncoder (ManagedPtr VideoVBIEncoder)

Instances

BoxedObject VideoVBIEncoder

Defined in GI.GstVideo.Structs.VideoVBIEncoder

Methods

boxedType :: VideoVBIEncoder -> IO GType

noVideoVBIEncoder :: Maybe VideoVBIEncoder

A convenience alias for Nothing :: Maybe VideoVBIEncoder.

Methods

addAncillary

videoVBIEncoderAddAncillary

Arguments

:: (HasCallStack, MonadIO m)

=> VideoVBIEncoder

encoder: a VideoVBIEncoder

-> Bool

composite: True if composite ADF should be created, component otherwise

-> Word8

dID: The Data Identifier

-> Word8

sDIDBlockNumber: The Secondary Data Identifier (if type 2) or the Data Block Number (if type 1)

-> ByteString

data: The user data content of the Ancillary packet. Does not contain the ADF, DID, SDID nor CS.

-> m Bool

Returns: True if enough space was left in the current line, False otherwise.

Stores Video Ancillary data, according to SMPTE-291M specification.

Note that the contents of the data are always read as 8bit data (i.e. do not contain the parity check bits).

Since: 1.16

copy

videoVBIEncoderCopy :: (HasCallStack, MonadIO m) => VideoVBIEncoder -> m VideoVBIEncoder

No description available in the introspection data.

free

videoVBIEncoderFree

Arguments

:: (HasCallStack, MonadIO m)

=> VideoVBIEncoder

encoder: a VideoVBIEncoder

-> m ()

Frees the encoder.

Since: 1.16

new

videoVBIEncoderNew

Arguments

:: (HasCallStack, MonadIO m)

=> VideoFormat

format: a VideoFormat

-> Word32

pixelWidth: The width in pixel to use

-> m VideoVBIEncoder

Returns: The new VideoVBIEncoder or Nothing if the format and/or pixelWidth is not supported.

Create a new VideoVBIEncoder for the specified format and pixelWidth.

Since: 1.16

writeLine

videoVBIEncoderWriteLine :: (HasCallStack, MonadIO m) => VideoVBIEncoder -> Word8 -> m ()

No description available in the introspection data.