Struct CodecFormatInfo

pub struct CodecFormatInfo {
    pub external_delay: Option<i64>,
    pub turn_on_delay: Option<i64>,
    pub turn_off_delay: Option<i64>,
    /* private fields */
}

Codec format information.

Fields

external_delay: Option<i64>

The driver’s best estimate of the external delay (in nanoseconds) present in the pipeline for the chosen format. When precisely synchronizing presentation across multiple entities (e.g. devices), the external delay should be taken into account. If not included external_delay is unknown.

Optional.

turn_on_delay: Option<i64>

The driver’s best estimate of the amount of time (in nanoseconds) it takes the hardware to actually start playback/capture after a Start command is issued. It may take some time for the hardware to get into fully operational mode, for example due a power state change. This delay must be taken into account if not getting the initial audio samples played or captured is not acceptable. If not included turn_on_delay is unknown.

Optional.

turn_off_delay: Option<i64>

The driver’s best estimate of the amount of time (in nanoseconds) it takes the hardware to actually stop playback/capture after a Stop command is issued. It may take some time for the hardware to get into fully stopped mode, for example due a power state change. This delay must be taken into account if playback/capture of samples after a ‘Stop’ command is not acceptable. If not included, the turn off delay is unknown.

Optional.

Trait Implementations

impl Clone for CodecFormatInfo

fn clone(&self) -> CodecFormatInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodecFormatInfo

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

Formats the value using the given formatter.

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

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 CodecFormatInfo

fn default() -> CodecFormatInfo

Returns the “default value” for a type.

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

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 CodecFormatInfo

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

type Owned = CodecFormatInfo

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 CodecFormatInfo

type Borrowed<'a> = &'a CodecFormatInfo

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 CodecFormatInfo

impl StructuralPartialEq for CodecFormatInfo