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

GI.GstVideo.Structs.VideoVBIEncoder

Contents

Exported types
Methods

Description

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

Since: 1.16

Synopsis

newtype VideoVBIEncoder = VideoVBIEncoder (ManagedPtr VideoVBIEncoder)
videoVBIEncoderAddAncillary :: (HasCallStack, MonadIO m) => VideoVBIEncoder -> Bool -> Word8 -> Word8 -> ByteString -> m Bool
videoVBIEncoderCopy :: (HasCallStack, MonadIO m) => VideoVBIEncoder -> m VideoVBIEncoder
videoVBIEncoderFree :: (HasCallStack, MonadIO m) => VideoVBIEncoder -> m ()
videoVBIEncoderNew :: (HasCallStack, MonadIO m) => VideoFormat -> Word32 -> m (Maybe VideoVBIEncoder)
videoVBIEncoderWriteLine :: (HasCallStack, MonadIO m) => VideoVBIEncoder -> Word8 -> m ()

Exported types

newtype VideoVBIEncoder Source #

Memory-managed wrapper type.

Constructors

VideoVBIEncoder (ManagedPtr VideoVBIEncoder)

Instances

Instances details

Eq VideoVBIEncoder Source #
Instance details Defined in GI.GstVideo.Structs.VideoVBIEncoder Methods (==) :: VideoVBIEncoder -> VideoVBIEncoder -> Bool # (/=) :: VideoVBIEncoder -> VideoVBIEncoder -> Bool #
GBoxed VideoVBIEncoder Source #
Instance details Defined in GI.GstVideo.Structs.VideoVBIEncoder
ManagedPtrNewtype VideoVBIEncoder Source #
Instance details Defined in GI.GstVideo.Structs.VideoVBIEncoder Methods toManagedPtr :: VideoVBIEncoder -> ManagedPtr VideoVBIEncoder
TypedObject VideoVBIEncoder Source #
Instance details Defined in GI.GstVideo.Structs.VideoVBIEncoder Methods glibType :: IO GType
HasParentTypes VideoVBIEncoder Source #
Instance details Defined in GI.GstVideo.Structs.VideoVBIEncoder
IsGValue (Maybe VideoVBIEncoder) Source #	Convert `VideoVBIEncoder` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.GstVideo.Structs.VideoVBIEncoder Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe VideoVBIEncoder -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe VideoVBIEncoder)
type ParentTypes VideoVBIEncoder Source #
Instance details Defined in GI.GstVideo.Structs.VideoVBIEncoder type ParentTypes VideoVBIEncoder = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

addAncillary, copy, free, writeLine.

Getters

None.

Setters

None.

addAncillary

videoVBIEncoderAddAncillary Source #

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

No description available in the introspection data.

free

videoVBIEncoderFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoVBIEncoder	`encoder`: a `VideoVBIEncoder`
-> m ()

Frees the encoder.

Since: 1.16

new

videoVBIEncoderNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoFormat	`format`: a `VideoFormat`
-> Word32	`pixelWidth`: The width in pixel to use
-> m (Maybe 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 () Source #

No description available in the introspection data.