Struct Frame 

pub struct Frame<'a, D: FrameDescriptorSpec = FrameDescriptor> {
    pub source: Option<String>,
    pub pts: Option<i64>,
    pub dts: Option<i64>,
    pub duration: Option<i64>,
    pub time_base: Option<Rational64>,
    pub metadata: Option<Variant>,
    /* private fields */
}

Fields

source: Option<String>

pts: Option<i64>

dts: Option<i64>

duration: Option<i64>

time_base: Option<Rational64>

metadata: Option<Variant>

Implementations

impl Frame<'_>

pub fn convert_audio_to(&self, dst: &mut Frame<'_>) -> Result<()>

impl Frame<'_, AudioFrameDescriptor>

pub fn convert_to(&self, dst: &mut AudioFrame<'_>) -> Result<()>

impl Frame<'_>

pub fn audio_creator() -> AudioFrameCreator

pub fn audio_descriptor(&self) -> Option<&AudioFrameDescriptor>

pub fn is_audio(&self) -> bool

pub fn truncate(&mut self, samples: u32) -> Result<()>

impl Frame<'_, AudioFrameDescriptor>

pub fn new( format: SampleFormat, channels: u8, samples: u32, sample_rate: u32, ) -> Result<Self>

pub fn new_with_descriptor(desc: AudioFrameDescriptor) -> Result<Self>

pub fn from_buffer<'a, T>( format: SampleFormat, channels: u8, samples: u32, sample_rate: u32, buffer: T, ) -> Result<AudioFrame<'a>>

where T: Into<Cow<'a, [u8]>>,

pub fn from_buffer_with_descriptor<'a, T>( desc: AudioFrameDescriptor, buffer: T, ) -> Result<AudioFrame<'a>>

where T: Into<Cow<'a, [u8]>>,

pub fn new_empty( format: SampleFormat, channels: u8, samples: u32, sample_rate: u32, ) -> Result<Self>

pub fn new_empty_with_descriptor(desc: AudioFrameDescriptor) -> Result<Self>

pub fn truncate(&mut self, samples: u32) -> Result<()>

impl Frame<'_>

pub fn convert_video_to(&self, dst: &mut Frame<'_>) -> Result<()>

impl Frame<'_, VideoFrameDescriptor>

pub fn convert_to(&self, dst: &mut VideoFrame<'_>) -> Result<()>

impl Frame<'_>

pub fn video_creator() -> VideoFrameCreator

pub fn video_descriptor(&self) -> Option<&VideoFrameDescriptor>

pub fn is_video(&self) -> bool

pub fn attach_video_shared_buffer( &mut self, format: PixelFormat, width: u32, height: u32, buffer: Arc<Buffer>, buffer_planes: &[(usize, u32)], ) -> Result<()>

pub fn attach_video_shared_buffer_with_descriptor( &mut self, desc: VideoFrameDescriptor, buffer: Arc<Buffer>, buffer_planes: &[(usize, u32)], ) -> Result<()>

impl Frame<'_, VideoFrameDescriptor>

pub fn new(format: PixelFormat, width: u32, height: u32) -> Result<Self>

pub fn new_with_descriptor(desc: VideoFrameDescriptor) -> Result<Self>

pub fn from_buffer<'a, T>( format: PixelFormat, width: u32, height: u32, buffer: T, ) -> Result<VideoFrame<'a>>

where T: Into<Cow<'a, [u8]>>,

pub fn from_buffer_with_descriptor<'a, T>( desc: VideoFrameDescriptor, buffer: T, ) -> Result<VideoFrame<'a>>

where T: Into<Cow<'a, [u8]>>,

pub fn from_aligned_buffer<'a, T>( format: PixelFormat, width: u32, height: u32, stride: u32, buffer: T, ) -> Result<VideoFrame<'a>>

where T: Into<Cow<'a, [u8]>>,

pub fn from_aligned_buffer_with_descriptor<'a, T>( desc: VideoFrameDescriptor, stride: NonZeroU32, buffer: T, ) -> Result<VideoFrame<'a>>

where T: Into<Cow<'a, [u8]>>,

pub fn from_packed_buffer<'a, T>( format: PixelFormat, width: u32, height: u32, stride: u32, buffer: T, ) -> Result<VideoFrame<'a>>

where T: Into<Cow<'a, [u8]>>,

pub fn from_packed_buffer_with_descriptor<'a, T>( desc: VideoFrameDescriptor, stride: NonZeroU32, buffer: T, ) -> Result<VideoFrame<'a>>

where T: Into<Cow<'a, [u8]>>,

pub fn from_buffers<'a>( format: PixelFormat, width: u32, height: u32, buffers: &[(&'a [u8], u32)], ) -> Result<VideoFrame<'a>>

pub fn from_buffers_with_descriptor<'a>( desc: VideoFrameDescriptor, buffers: &[(&'a [u8], u32)], ) -> Result<VideoFrame<'a>>

pub fn from_shared_buffer( format: PixelFormat, width: u32, height: u32, buffer: Arc<Buffer>, planes: &[(usize, u32)], ) -> Result<VideoFrame<'static>>

pub fn from_shared_buffer_with_descriptor( desc: VideoFrameDescriptor, buffer: Arc<Buffer>, planes: &[(usize, u32)], ) -> Result<VideoFrame<'static>>

pub fn new_empty( format: PixelFormat, width: u32, height: u32, ) -> Result<VideoFrame<'static>>

pub fn new_empty_with_descriptor( desc: VideoFrameDescriptor, ) -> Result<VideoFrame<'static>>

pub fn attach_shared_buffer( &mut self, format: PixelFormat, width: u32, height: u32, buffer: Arc<Buffer>, buffer_planes: &[(usize, u32)], ) -> Result<()>

pub fn attach_shared_buffer_with_descriptor( &mut self, desc: VideoFrameDescriptor, buffer: Arc<Buffer>, buffer_planes: &[(usize, u32)], ) -> Result<()>

impl Frame<'_>

pub fn scale_to( &self, dst: &mut Frame<'_>, scale_filter: ScaleFilter, ) -> Result<()>

impl Frame<'_, VideoFrameDescriptor>

pub fn scale_to( &self, dst: &mut VideoFrame<'_>, scale_filter: ScaleFilter, ) -> Result<()>

impl<D: FrameDescriptorSpec> Frame<'_, D>

pub fn data(&self) -> Option<&Variant>

pub fn data_mut(&mut self) -> Option<&mut Variant>

impl Frame<'_>

pub fn data_creator() -> DataFrameCreator

pub fn data_descriptor(&self) -> Option<&DataFrameDescriptor>

pub fn is_data(&self) -> bool

impl Frame<'_, DataFrameDescriptor>

pub fn new(format: DataFormat) -> DataFrame<'static>

pub fn new_with_descriptor(desc: DataFrameDescriptor) -> DataFrame<'static>

impl Frame<'_, FrameDescriptor>

pub fn new_with_generic_descriptor<D>(desc: D) -> Result<Frame<'static>>

where D: Into<FrameDescriptor> + Clone,

pub fn media_type(&self) -> MediaType

pub fn convert_to(&self, dst: &mut Frame<'_>) -> Result<()>

impl<D: FrameDescriptorSpec> Frame<'_, D>

pub fn descriptor(&self) -> &D

pub fn into_owned(self) -> Frame<'static, D>

pub fn map(&self) -> Result<MappedGuard<'_>>

pub fn map_mut(&mut self) -> Result<MappedGuard<'_>>

Trait Implementations

impl<'a, D: Clone + FrameDescriptorSpec> Clone for Frame<'a, D>

fn clone(&self) -> Frame<'a, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl FrameSpec<FrameDescriptor> for Frame<'_, FrameDescriptor>

fn new_with_descriptor(desc: FrameDescriptor) -> Result<Frame<'static>>

fn media_type(&self) -> MediaType

impl<'a> From<Frame<'a, AudioFrameDescriptor>> for Frame<'a>

fn from(frame: AudioFrame<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Frame<'a, DataFrameDescriptor>> for Frame<'a>

fn from(frame: DataFrame<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Frame<'a, VideoFrameDescriptor>> for Frame<'a>

fn from(frame: VideoFrame<'a>) -> Self

Converts to this type from the input type.

impl<D: FrameDescriptorSpec> SharedFrameInner for Frame<'_, D>

type Descriptor = D

impl<'a> TryFrom<Frame<'a>> for AudioFrame<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(frame: Frame<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<Frame<'a>> for DataFrame<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(frame: Frame<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<Frame<'a>> for VideoFrame<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(frame: Frame<'a>) -> Result<Self>

Performs the conversion.