Skip to main content

MediaFormat

Struct MediaFormat 

Source
pub struct MediaFormat {
    media_kind: MediaKind,
    codec: MediaCodec,
    payload_type: PayloadType,
    clock_rate: u32,
    channels: Option<u16>,
    settings: Vec<CodecSetting>,
    rtcp_feedback: Vec<RtcpFeedback>,
}
Expand description

Negotiated codec format for a concrete media stream.

Unlike a capability, a format has a fixed payload_type that matches the actual value expected in the RTP packets on the wire.

Fields§

§media_kind: MediaKind§codec: MediaCodec§payload_type: PayloadType§clock_rate: u32§channels: Option<u16>§settings: Vec<CodecSetting>§rtcp_feedback: Vec<RtcpFeedback>

Implementations§

Source§

impl MediaFormat

Source

pub fn new( media_kind: MediaKind, codec: impl Into<MediaCodec>, payload_type: PayloadType, clock_rate: u32, ) -> Self

Source

pub fn with_channels(self, channels: u16) -> Self

Source

pub fn with_setting(self, setting: CodecSetting) -> Self

Source

pub fn with_parameter( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Source

pub fn with_rtcp_feedback(self, feedback: RtcpFeedback) -> Self

Source

pub fn media_kind(&self) -> MediaKind

Source

pub fn codec(&self) -> &MediaCodec

Source

pub fn codec_name(&self) -> &str

Source

pub fn payload_type_id(&self) -> PayloadType

Source

pub fn payload_type(&self) -> u8

Source

pub fn clock_rate(&self) -> u32

Source

pub fn channels(&self) -> Option<u16>

Source

pub fn settings(&self) -> impl Iterator<Item = &CodecSetting>

Source

pub fn parameters(&self) -> impl Iterator<Item = (String, String)> + '_

Source

pub fn rtcp_feedback(&self) -> impl Iterator<Item = &RtcpFeedback>

Source

pub fn rtx_associated_payload_type_id(&self) -> Option<PayloadType>

Source

pub fn rtx_associated_payload_type(&self) -> Option<u8>

Trait Implementations§

Source§

impl Clone for MediaFormat

Source§

fn clone(&self) -> MediaFormat

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MediaFormat

Source§

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

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

impl PartialEq for MediaFormat

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for MediaFormat

Source§

impl StructuralPartialEq for MediaFormat

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.