Struct DelayInfo

pub struct DelayInfo {
    pub internal_delay: Option<i64>,
    pub external_delay: Option<i64>,
    /* private fields */
}

Delay information as returned by the driver.

Fields

internal_delay: Option<i64>

The driver’s best estimate (for the chosen format) of the delay internal to the hardware it abstracts.

“Internal” refers to the hardware between the hardware interconnect (DAI) and the ring buffer (e.g. an SoC audio subsystem), whereas “external” refers to hardware on the far side of any hardware interconnect (DAI) (e.g. hardware codecs).

For a given frame during playback, this is any delay after the driver/HW copies it out of the ring-buffer, before it exits any hardware interconnect. For a given frame during recording, this is any delay after it enters the hardware interconnect, before the driver/HW copies it into the ring-buffer.

internal_delay must be taken into account by the client when determining the requirements for minimum lead time (during playback) and minimum capture delay (during capture).

This delay must not include the inherent delay added by the temporary buffering needed to copy data in and out of the ring buffer, which is contained in RingBufferProperties field driver_transfer_bytes.

Required.

external_delay: Option<i64>

The driver’s best estimate (for the chosen format) of the delay external to the hardware it abstracts.

“External” refers to hardware on the far side of any hardware interconnect (DAI) (e.g. hardware codecs), whereas “internal” refers to hardware between the hardware interconnect (DAI) and the ring buffer (e.g. an SoC audio subsystem).

external_delay must be taken into account by the client when determining the requirements for minimum lead time (during playback) and minimum capture delay (during capture).

If not included, external_delay is unknown. If unknown, a client may treat it however it chooses (consider it zero or some large number, autodetect it, etc).

Like internal_delay, this delay must not include the inherent delay added by the temporary buffering needed to copy data in and out of the ring buffer, which is contained in RingBufferProperties field driver_transfer_bytes.

Optional.

Trait Implementations

impl Clone for DelayInfo

fn clone(&self) -> DelayInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DelayInfo

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

Formats the value using the given formatter.

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

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 DelayInfo

fn default() -> DelayInfo

Returns the “default value” for a type.

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

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 DelayInfo

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

type Owned = DelayInfo

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 DelayInfo

type Borrowed<'a> = &'a DelayInfo

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 DelayInfo

impl StructuralPartialEq for DelayInfo