GstVideo-1.0 ▶ GstVideo ▶ VideoVBIEncoderSince 1.16

constructor

• new VideoVBIEncoder(
      format: GstVideo.VideoFormat,
      pixel_width: number,
  ): VideoVBIEncoder

  Parameters

  • format: GstVideo.VideoFormat
  • pixel_width: number

  Returns VideoVBIEncoder

Static$gtype

Since 1.16add_ancillary

• add_ancillary(
      composite: boolean,
      DID: number,
      SDID_block_number: number,
      data: string | Uint8Array<ArrayBufferLike>,
  ): boolean

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

  Parameters

  • composite: boolean

    true if composite ADF should be created, component otherwise

  • DID: number

    The Data Identifier

  • SDID_block_number: number

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

  • data: string | Uint8Array<ArrayBufferLike>

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

  Returns boolean

  true if enough space was left in the current line, false otherwise.

  Since

  1.16

copy

• copy(): VideoVBIEncoder

  Returns VideoVBIEncoder

Since 1.16free

• free(): void

  Frees the encoder.

  Returns void

  Since

  1.16

write_line

• write_line(data: string | Uint8Array<ArrayBufferLike>): void

  data needs to have the correct size and alignment for the configured video format of encoder.

  Parameters

  • data: string | Uint8Array<ArrayBufferLike>

    The line to write to

  Returns void

Staticnew

• new(format: GstVideo.VideoFormat, pixel_width: number): VideoVBIEncoder

  Parameters

  • format: GstVideo.VideoFormat
  • pixel_width: number

  Returns VideoVBIEncoder