Struct MediaTime

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

Media timeline offset represented by a count (numerator) / frequency (denominator) in seconds.

The numerator is typically the packet time of an Rtp header. The denominator is the clock frequency of the media source (typically 90kHz for video and 48kHz for audio). The denominator is guaranteed to be a positive integer while the numerator could be positive, negative, or zero.

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 MediaTime

pub const ZERO: MediaTime

The additive identity: 0/1.

pub const fn new(numer: i64, denom: Frequency) -> Self

Construct a MediaTime from a guaranteed non-zero Frequency.

pub const fn numer(&self) -> i64

The numerator of the offset time.

pub const fn denom(&self) -> u32

The denominator of the offset time.

pub const fn frequency(&self) -> Frequency

The Frequency of the offset time.

pub const fn from_micros(v: i64) -> MediaTime

Convenience constructor for numbers of microseconds (v/1_000_000).

pub const fn from_fixed_point_6_18(v: i64) -> MediaTime

Convenience constructor for numbers of 24-bit 6.18 fixed point units (v/2^18).

pub const fn from_90khz(v: i64) -> MediaTime

Convenience constructor for numbers of 90kHz units (v/90_000).

pub const fn from_millis(v: i64) -> MediaTime

Convenience constructor for numbers of milliseconds (v/1000).

pub const fn from_hundredths(v: i64) -> MediaTime

Convenience constructor for numbers of hundredths of seconds (v/100).

pub const fn from_secs(v: i64) -> MediaTime

Convenience constructor for numbers of seconds (v/1).

pub fn from_seconds(v: impl Into<f64>) -> MediaTime

Convenience constructor for floating point fractions of seconds as microsecond units.

pub fn as_seconds(&self) -> f64

A floating point fraction second representation.

pub const fn as_micros(&self) -> i64

A microsecond representation.

pub const fn is_zero(&self) -> bool

Predicate for checking that the numerator is 0.

pub const fn abs(self) -> MediaTime

The absolute value of the offset time.

pub const fn rebase(self, denom: Frequency) -> MediaTime

Convert this offset time to have a different denominator (frequency). This conversion may lose precision and, after arithmetic operations with other times of higher frequencies, may have a higher frequency.

Trait Implementations

impl Add<MediaTime> for Instant

type Output = Instant

The resulting type after applying the + operator.

fn add(self, rhs: MediaTime) -> Self::Output

Performs the + operation.

impl Add for MediaTime

type Output = MediaTime

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<MediaTime> for Instant

fn add_assign(&mut self, rhs: MediaTime)

Performs the += operation.

impl AddAssign for MediaTime

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for MediaTime

fn clone(&self) -> MediaTime

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MediaTime

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

Formats the value using the given formatter.

impl From<Duration> for MediaTime

fn from(v: Duration) -> Self

Converts to this type from the input type.

impl Ord for MediaTime

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MediaTime

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 PartialOrd for MediaTime

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<MediaTime> for Instant

type Output = Instant

The resulting type after applying the - operator.

fn sub(self, rhs: MediaTime) -> Self::Output

Performs the - operation.

impl Sub for MediaTime

type Output = MediaTime

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign<MediaTime> for Instant

fn sub_assign(&mut self, rhs: MediaTime)

Performs the -= operation.

impl SubAssign for MediaTime

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TryFrom<MediaTime> for Duration

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: MediaTime) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for MediaTime

impl Eq for MediaTime