Skip to main content

VideoFrame

Struct VideoFrame 

Source
pub struct VideoFrame<'a> {
    pub bgra: &'a [u8],
    pub width: u32,
    pub height: u32,
    pub metadata: Option<FrameMetadata>,
}
Expand description

A decoded video frame, borrowed for the duration of the callback. The buffer is BGRA (width*height*4, B-G-R-A); copy it if you need to keep it.

Fields§

§bgra: &'a [u8]§width: u32§height: u32§metadata: Option<FrameMetadata>

Metadata attached by the sender via [Track::push_video_frame_with_metadata], decoded from the packet trailer.

None when no trailer was present — which includes every frame from a peer that did not negotiate the capability, and every frame on a connection built with RtcConfiguration::frame_metadata off.

Implementations§

Source§

impl VideoFrame<'_>

Source

pub const fn new(bgra: &[u8], width: u32, height: u32) -> VideoFrame<'_>

A push-side frame: BGRA pixels, no metadata (outgoing trailers go through [VideoTrack::push_frame_with_metadata(_at)] with user_data). The same struct on_frame delivers — relay use cases repack nothing. metadata is populated only on receive.

Auto Trait Implementations§

§

impl<'a> Freeze for VideoFrame<'a>

§

impl<'a> RefUnwindSafe for VideoFrame<'a>

§

impl<'a> Send for VideoFrame<'a>

§

impl<'a> Sync for VideoFrame<'a>

§

impl<'a> Unpin for VideoFrame<'a>

§

impl<'a> UnsafeUnpin for VideoFrame<'a>

§

impl<'a> UnwindSafe for VideoFrame<'a>

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.