Struct gstreamer_video::VideoVBIEncoder

pub struct VideoVBIEncoder { /* private fields */ }

Available on crate feature v1_16 only.

Implementations

impl VideoVBIEncoder

pub fn try_new( format: VideoFormat, pixel_width: u32 ) -> Result<VideoVBIEncoder, VideoVBIError>

pub fn add_did_ancillary( &mut self, adf_mode: VideoAFDDescriptionMode, did: VideoAncillaryDID, block_number: u8, data: &[u8] ) -> Result<(), VideoVBIError>

Adds the provided ancillary data as a DID and block number AFD.

pub fn add_did16_ancillary( &mut self, adf_mode: VideoAFDDescriptionMode, did16: VideoAncillaryDID16, data: &[u8] ) -> Result<(), VideoVBIError>

Adds the provided ancillary data as a DID16 (DID & SDID) AFD.

pub fn add_ancillary( &mut self, adf_mode: VideoAFDDescriptionMode, did: u8, sdid_block_number: u8, data: &[u8] ) -> Result<(), VideoVBIError>

pub fn line_buffer_len(&self) -> usize

Returns the buffer length needed to store the line.

pub fn write_line(&mut self, data: &mut [u8]) -> Result<usize, VideoVBIError>

Writes the ancillaries encoded for VBI to the provided buffer.

Use Self::line_buffer_len to get the expected buffer length.

Resets the internal state, so this VideoVBIEncoder can be reused for subsequent VBI encodings.

Returns

• Ok with the written length in bytes in the line buffer containing the encoded ancilliaries previously added using VideoVBIEncoder::add_ancillary, VideoVBIEncoder::add_did_ancillary or VideoVBIEncoder::add_did16_ancillary.
• Err if the ancillary could not be added.

Trait Implementations

impl Debug for VideoVBIEncoder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for VideoVBIEncoder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for VideoVBIEncoder

fn cmp(&self, other: &VideoVBIEncoder) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for VideoVBIEncoder

fn eq(&self, other: &VideoVBIEncoder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for VideoVBIEncoder

fn partial_cmp(&self, other: &VideoVBIEncoder) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> TryFrom<&'a VideoInfo> for VideoVBIEncoder

type Error = VideoVBIError

The type returned in the event of a conversion error.

fn try_from(info: &'a VideoInfo) -> Result<VideoVBIEncoder, VideoVBIError>

Performs the conversion.

impl Eq for VideoVBIEncoder

impl Send for VideoVBIEncoder

impl StructuralPartialEq for VideoVBIEncoder

impl Sync for VideoVBIEncoder