Struct StreamProperties

pub struct StreamProperties {
    pub unique_id: Option<[u8; 16]>,
    pub is_input: Option<bool>,
    pub can_mute: Option<bool>,
    pub can_agc: Option<bool>,
    pub min_gain_db: Option<f32>,
    pub max_gain_db: Option<f32>,
    pub gain_step_db: Option<f32>,
    pub plug_detect_capabilities: Option<PlugDetectCapabilities>,
    pub manufacturer: Option<String>,
    pub product: Option<String>,
    pub clock_domain: Option<u32>,
    /* private fields */
}

Fields

unique_id: Option<[u8; 16]>

A unique identifier. If not included, there is no unique id for the StreamConfig. unique_id arrays starting with 0x42, 0x54, … (or BT in ASCII) are reserved for drivers implementing Bluetooth technologies. unique_id arrays starting with 0x55, 0x53, 0x42, … (or USB in ASCII) are reserved for drivers implementing USB technologies. Note that even though the above values map to readable ASCII characters, array values can span the entire uint8 range (0-255).

Optional.

is_input: Option<bool>

Driver type is input (true) or output (false)

Required.

can_mute: Option<bool>

Gain mute capability. If not included, the StreamConfig can’t mute.

Optional.

can_agc: Option<bool>

Automatic Gain Control (AGC) capability. If not included, the StreamConfig can’t AGC.

Optional.

min_gain_db: Option<f32>

Minimum gain in decibels.

Required.

max_gain_db: Option<f32>

Maximum gain in decibels.

Required.

gain_step_db: Option<f32>

Gain step in decibels, this value must not be negative, but may be zero to convey an effectively continuous range of values. Must not exceed max_gain_db - min_gain_db.

Required.

plug_detect_capabilities: Option<PlugDetectCapabilities>

Plug Detect Capabilities.

Required.

manufacturer: Option<String>

UI string for the manufacturer name. If not included, the manufacturer is unspecified. If included, this string must be non-empty.

Optional.

product: Option<String>

UI string for the product name. If not included, the product name is unspecified. If included, this string must be non-empty.

Optional.

clock_domain: Option<u32>

An identifier for the clock domain in which this hardware operates. If two hardware devices have the same clock domain, their clock rates are identical and perfectly synchronized. Although these two clocks have the same rate, the clock positions may be offset from each other by an arbitrary (but fixed) amount. The clock_domain typically comes from a system wide entity, such as a platform bus or global clock tree.

There are two special values:

• CLOCK_DOMAIN_MONOTONIC means the hardware is operating at the same rate as the system montonic clock.

• CLOCK_DOMAIN_EXTERNAL means the hardware is operating at an unknown rate and is not synchronized with any known clock, not even with other clocks in domain CLOCK_DOMAIN_EXTERNAL.

If the domain is not CLOCK_DOMAIN_MONOTONIC, client must use position notification updates to recover the hardware’s clock.

Required.

Trait Implementations

impl Clone for StreamProperties

fn clone(&self) -> StreamProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamProperties

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

Formats the value using the given formatter.

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

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 StreamProperties

fn default() -> StreamProperties

Returns the “default value” for a type.

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

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 StreamProperties

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

type Owned = StreamProperties

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 StreamProperties

type Borrowed<'a> = &'a StreamProperties

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 StreamProperties

impl StructuralPartialEq for StreamProperties