Skip to main content

VideoFrameBuilder

Struct VideoFrameBuilder 

Source
pub struct VideoFrameBuilder { /* private fields */ }
Expand description

Builder for configuring a VideoFrame with ergonomic method chaining

Implementations§

Source§

impl VideoFrameBuilder

Source

pub fn new() -> Self

Create a new builder with no fields set

Source

pub fn resolution(self, width: i32, height: i32) -> Self

Set the video resolution. Width must be positive and even; height must be positive (and even for 4:2:0 formats).

Source

pub fn pixel_format(self, pixel_format: PixelFormat) -> Self

Set the pixel format

Source

pub fn frame_rate(self, numerator: i32, denominator: i32) -> Self

Set the frame rate as a fraction (e.g., 30000/1001 for 29.97fps)

Source

pub fn aspect_ratio(self, ratio: f32) -> Self

Set the picture aspect ratio

Source

pub fn scan_type(self, scan_type: ScanType) -> Self

Set the scan type (progressive, interlaced, etc.)

Source

pub fn timecode(self, tc: i64) -> Self

Set the timecode in 100 ns units (or the SDK synthesis sentinel).

Source

pub fn metadata<S: Into<String>>(self, meta: S) -> Self

Set metadata

Source

pub fn timestamp(self, ts: i64) -> Self

Set the timestamp field in 100 ns units. This field is filled by the SDK on receive.

Source

pub fn data(self, data: Vec<u8>) -> Self

Supply owned pixels without an intermediate zero-filled allocation.

build requires exactly the validated layout size and retains this allocation unchanged. Use data_mut on the resulting frame for reuse.

Source

pub fn build(self) -> Result<VideoFrame>

Build the video frame.

Defaults to 1920x1080 BGRA, 60/1 fps, 16:9 picture aspect ratio, progressive scan, synthesized timecode, and zero-filled pixels.

Trait Implementations§

Source§

impl Clone for VideoFrameBuilder

Source§

fn clone(&self) -> VideoFrameBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for VideoFrameBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for VideoFrameBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.