Struct fidl_fuchsia_audio_device::Info

pub struct Info {

    pub token_id: Option<u64>,
    pub device_type: Option<DeviceType>,
    pub device_name: Option<String>,
    pub manufacturer: Option<String>,
    pub product: Option<String>,
    pub unique_instance_id: Option<[u8; 16]>,
    pub is_input: Option<bool>,
    pub ring_buffer_format_sets: Option<Vec<ElementRingBufferFormatSet>>,
    pub dai_format_sets: Option<Vec<ElementDaiFormatSet>>,
    pub gain_caps: Option<GainCapabilities>,
    pub plug_detect_caps: Option<PlugDetectCapabilities>,
    pub clock_domain: Option<u32>,
    pub signal_processing_elements: Option<Vec<Element>>,
    pub signal_processing_topologies: Option<Vec<Topology>>,
    /* private fields */
}

When a device is detected (or added via Provider/AddDevice), it is queried for its properties and capabilities. Once this enumeration process completes, it is announced to clients that are watching for device arrivals via Registry/WatchDevicesAdded.

An Info table is returned for each audio device that has been added.

Fields

token_id: Option<u64>

A device identifier that is guaranteed unique for this boot session, but may change across reboots.

Required for all device types.

device_type: Option<DeviceType>

The protocol used by the driver, and (if StreamConfig) its directionality.

Required for all device types.

device_name: Option<String>

The device’s high-level name, as received from devfs or the Provider/AddDevice caller.

Required for all device types.

manufacturer: Option<String>

The name of the device’s manufacturer.

Optional for all device types.

product: Option<String>

The device’s high-level product name.

Optional for all device types.

unique_instance_id: Option<[u8; 16]>

A 16-character ID provided by the driver that (if present) can be used to differentiate instances of the same device. This value should not change across system reboots.

Optional for all device types.

is_input: Option<bool>

Whether the device is a source (is_input TRUE) or destination (is_input FALSE) of audio.

Required for StreamConfig; optional for Codec; absent for Composite.

ring_buffer_format_sets: Option<Vec<ElementRingBufferFormatSet>>

The union of all formats the device can support, across all combinations of device configuration settings. If the device exposes one or more RingBuffer ENDPOINT elements, this field must be present and its vector must contain exactly one entry for each relevant ENDPOINT element. If the device exposes NO RingBuffer ENDPOINT elements, this field must be omitted (entirely absent, rather than populated with an empty vector).

Required for StreamConfig; optional for Composite; absent for Codec.

dai_format_sets: Option<Vec<ElementDaiFormatSet>>

The union of all DAI formats the device can support, across all combinations of device configuration settings. If the device exposes one or more Dai ENDPOINT elements, this field must be present and its vector must contain exactly one entry for each relevant ENDPOINT element. If the device exposes NO Dai ENDPOINT elements, this field must be omitted (entirely absent, rather than populated with an empty vector).

Required for Codec; optional for Composite; absent for StreamConfig.

gain_caps: Option<GainCapabilities>

The device’s gain/mute capabilities.

Required for StreamConfig; absent for Codec and Composite.

plug_detect_caps: Option<PlugDetectCapabilities>

The device’s hot-plug capabilities.

Required for Codec and StreamConfig; absent for Composite.

clock_domain: Option<u32>

An identifier for the clock domain in which the device’s clock hardware operates. Devices in the same clock domain remain perfectly synchronized. They may drift relative to some other clock domain, but all clocks in that domain will do so perfectly together. Although their clocks have the same rate, their positions may be offset by an arbitrary, fixed amount.

There are two special values for clock domain:

• CLOCK_DOMAIN_MONOTONIC means the hardware is driven by the system montonic clock and will always be synchronized with that timeline.

• CLOCK_DOMAIN_EXTERNAL means the hardware is not synchronized with any other known clocks (even any other clocks in CLOCK_DOMAIN_EXTERNAL).

Required for Composite and StreamConfig; absent for Codec.

signal_processing_elements: Option<Vec<Element>>

The vector of supported signal-processing elements. If present, must contain at least one element.

Required for Composite; optional for Codec and StreamConfig.

signal_processing_topologies: Option<Vec<Topology>>

The vector of supported signal-processing topologies. If present, must contain at least one element.

Required for Composite; optional for Codec and StreamConfig.

Trait Implementations

impl Clone for Info

fn clone(&self) -> Info

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Info

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

Formats the value using the given formatter.

impl Decode<Info> for Info

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<'_>, offset: usize, depth: Depth ) -> Result<()>

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

impl Default for Info

fn default() -> Info

Returns the “default value” for a type.

impl Encode<Info> for &Info

unsafe fn encode( self, encoder: &mut Encoder<'_>, 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 Info

fn eq(&self, other: &Info) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TypeMarker for Info

type Owned = Info

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 Info

type Borrowed<'a> = &'a Info

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<'a>(value: &'a <Self as TypeMarker>::Owned) -> Self::Borrowed<'a>

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

impl Persistable for Info

impl StructuralPartialEq for Info