Struct RtcAudioPlayoutStats 

pub struct RtcAudioPlayoutStats {
    pub kind: Option<String>,
    pub synthesized_samples_duration: Option<Double>,
    pub synthesized_samples_events: Option<u32>,
    pub total_samples_duration: Option<Double>,
    pub total_playout_delay: Option<Double>,
    pub total_samples_count: Option<u64>,
}

Statistics of one playout path.

If the same playout statistics object is referenced by multiple RtcInboundRtpStreamStats this is an indication that audio mixing is happening in which case sample counters in this statistics object refer to the samples after mixing.

Full doc on W3C.

Fields

kind: Option<String>

For audio playout, this has the value audio.

This reflects the kind attribute of the MediaStreamTrack being played out.

synthesized_samples_duration: Option<Double>

Total duration, in seconds, of synthesized audio samples that have been played out.

If the playout path is unable to produce audio samples on time for device playout, samples are synthesized to be playout out instead. synthesized_samples_duration is measured in seconds and is incremented each time an audio sample is synthesized by this playout path.

This metric can be used together with total_samples_duration to calculate the percentage of played out media being synthesized.

Synthesization typically only happens if the pipeline is underperforming. Samples synthesized by the RtcInboundRtpStreamStats are not counted for here, but in InboundRtpMediaType::Audio::concealed_samples.

synthesized_samples_events: Option<u32>

Number of synthesized samples events.

This counter increases every time a sample is synthesized after a non-synthesized sample. That is, multiple consecutive synthesized samples will increase the synthesized_samples_duration multiple times but is a single synthesization samples event.

total_samples_duration: Option<Double>

Total duration, in seconds, of all audio samples that have been played out.

Includes both synthesized and non-synthesized samples.

total_playout_delay: Option<Double>

Total estimated delay of the playout path for all audio samples.

When audio samples are pulled by the playout device, this counter is incremented with the estimated delay of the playout path for that audio sample. The playout delay includes the delay from being emitted to the actual time of playout on the device.

This metric can be used together with total_samples_count to calculate the average playout delay per sample.

total_samples_count: Option<u64>

Total number of samples emitted for playout.

When audio samples are pulled by the playout device, this counter is incremented with the number of samples emitted for playout.

Trait Implementations

impl Clone for RtcAudioPlayoutStats

fn clone(&self) -> RtcAudioPlayoutStats

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RtcAudioPlayoutStats

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RtcAudioPlayoutStats

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for RtcAudioPlayoutStats

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RtcAudioPlayoutStats

fn eq(&self, other: &RtcAudioPlayoutStats) -> 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 RtcAudioPlayoutStats

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RtcAudioPlayoutStats