Struct Frequency 

pub struct Frequency(/* private fields */);

Media timeline frequency as represented by a non-zero unsigned integer.

The frequency can be found in the negotiated payload parameters for a media writer.

// Obtain mid from Event::MediaAdded
let mid: Mid = todo!();

// Create a media writer for the mid.
let writer = rtc.writer(mid).unwrap();

// Get the payload type (pt) for the wanted codec.
let params = writer.payload_params().nth(0).unwrap();

// Obtain the frequency for the selected codec.
let freq = params.spec().clock_rate;

let mtime = MediaTime::new(2000, freq);

Implementations

impl Frequency

pub const MICROS: Self

Microseconds in a second.

pub const FIXED_POINT_6_18: Frequency

1 / 2 ^ 18 seconds in a second.

pub const NINETY_KHZ: Frequency

Cycles in a second of a 90 kHz signal.

pub const FORTY_EIGHT_KHZ: Frequency

Cycles in a second of a 48 kHz signal.

pub const EIGHT_KHZ: Frequency

Cycles in a second of a 8000 Hz signal.

pub const MILLIS: Frequency

Milliseconds in a second.

pub const HUNDREDTHS: Frequency

Hundredths in a second.

pub const SECONDS: Frequency

Seconds in a second.

pub const fn from_nonzero(v: NonZeroU32) -> Self

Any non-zero u32 is a valid media timeline frequency.

pub fn new(v: u32) -> Option<Self>

Every u32 is a valid media timeline frequency except zero.

pub const fn get(&self) -> u32

The frequency as a u32.

pub const fn nonzero(&self) -> NonZeroU32

The frequency as a std::num::NonZeroU32 i.e. including a positivity proof.

Trait Implementations

impl Clone for Frequency

fn clone(&self) -> Frequency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frequency

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Frequency

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Frequency

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

Formats the value using the given formatter.

impl From<Frequency> for NonZeroU32

fn from(value: Frequency) -> Self

Converts to this type from the input type.

impl From<NonZero<u32>> for Frequency

fn from(value: NonZeroU32) -> Self

Converts to this type from the input type.

impl FromStr for Frequency

type Err = <NonZero<u32> as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Frequency

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Frequency

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Frequency

impl Eq for Frequency