Struct AudioConsumerStatus

pub struct AudioConsumerStatus {
    pub error: Option<AudioConsumerError>,
    pub presentation_timeline: Option<TimelineFunction>,
    pub min_lead_time: Option<u64>,
    pub max_lead_time: Option<u64>,
    /* private fields */
}

Represents the status of the consumer. In the initial status, error and presentation_timeline are absent. The lead time fields are always present.

Fields

error: Option<AudioConsumerError>

If present, indicates an error condition currently in effect. Absent if no error.

presentation_timeline: Option<TimelineFunction>

If present, indicates the current relationship between the presentation timeline and local monotonic clock, both in nanosecond units. If not present, indicates there is no relationship. Absent initially.

‘Presentation timeline’ refers to the pts (presentation timestamp) values on the packets. This timeline function can be used to determine the local monotonic clock time that a packet will be presented based on that packet’s pts value.

min_lead_time: Option<u64>

Indicates the minimum lead time in nanoseconds supported by this AudioConsumer. Or in other words, how small of a gap between the media_time provided to AudioConsumer.Start and the pts on the first packet can be. Values outside this range will be clipped.

max_lead_time: Option<u64>

Indicates the maximum lead time in nanoseconds supported by this AudioConsumer. Or in other words, how large of a gap between the media_time provided to AudioConsumer.Start and the pts on the first packet can be. Values outside this range will be clipped.

Trait Implementations

impl Clone for AudioConsumerStatus

fn clone(&self) -> AudioConsumerStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioConsumerStatus

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<AudioConsumerStatus, D> for AudioConsumerStatus

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for AudioConsumerStatus

fn default() -> AudioConsumerStatus

Returns the “default value” for a type.

impl<D: ResourceDialect> Encode<AudioConsumerStatus, D> for &AudioConsumerStatus

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq for AudioConsumerStatus

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

type Owned = AudioConsumerStatus

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for AudioConsumerStatus

type Borrowed<'a> = &'a AudioConsumerStatus

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for AudioConsumerStatus

impl StructuralPartialEq for AudioConsumerStatus