GstVideo.VideoVBIEncoder

Fields

None

Methods

class

new (format, pixel_width)

add_ancillary (composite, DID, SDID_block_number, data)

copy ()

free ()

write_line (data)

Details

class GstVideo.VideoVBIEncoder

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

New in version 1.16.

classmethod new(format, pixel_width)
Parameters:
Returns:

The new GstVideo.VideoVBIEncoder or None if the format and/or pixel_width is not supported.

Return type:

GstVideo.VideoVBIEncoder or None

Create a new GstVideo.VideoVBIEncoder for the specified format and pixel_width.

New in version 1.16.

add_ancillary(composite, DID, SDID_block_number, data)
Parameters:

  • composite (bool) – True if composite ADF should be created, component otherwise

  • DID (int) – The Data Identifier

  • SDID_block_number (int) – The Secondary Data Identifier (if type 2) or the Data Block Number (if type 1)

  • data (bytes) – The user data content of the Ancillary packet. Does not contain the ADF, DID, SDID nor CS.

Returns:

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

Return type:

bool

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).

New in version 1.16.

copy()
Return type:

GstVideo.VideoVBIEncoder

free()

Frees the self.

New in version 1.16.

write_line(data)
Parameters:

data (int) –