Struct fidl_fuchsia_virtualaudio::Configuration

pub struct Configuration {
    pub device_name: Option<String>,
    pub manufacturer_name: Option<String>,
    pub product_name: Option<String>,
    pub unique_id: Option<[u8; 16]>,
    pub fifo_depth_bytes: Option<u32>,
    pub external_delay: Option<i64>,
    pub supported_formats: Option<Vec<FormatRange>>,
    pub clock_properties: Option<ClockProperties>,
    pub ring_buffer_constraints: Option<RingBufferConstraints>,
    pub gain_properties: Option<GainProperties>,
    pub plug_properties: Option<PlugProperties>,
    pub initial_notifications_per_ring: Option<u32>,
    /* private fields */
}

Configures a virtual audio device.

Fields

device_name: Option<String>

Device’s name. If not specified, a default name is used.

manufacturer_name: Option<String>

Device manufacturor’s name. If not specified, a default manufacturer name is used.

product_name: Option<String>

Device product’s. If not specified, a default product name is used.

unique_id: Option<[u8; 16]>

Device’s unique identifier, a 16 byte string. If not specified, a default ID is used.

fifo_depth_bytes: Option<u32>

FIFO depth in bytes. If not specified, defaults to an arbitrary amount.

external_delay: Option<i64>

External delay. If not specified, defaults to an arbitrary duration.

supported_formats: Option<Vec<FormatRange>>

Supported format ranges for this virtual audio device. If empty, supports only a 48kHz stereo int16 format by default.

clock_properties: Option<ClockProperties>

Configuration for the device’s clock. If not specified, use the domain of the monotonic clock.

ring_buffer_constraints: Option<RingBufferConstraints>

Constraints on the ring buffer. If not specified, there are no constraints.

gain_properties: Option<GainProperties>

Configuration of the device gain. If not specified, the device has unity gain and cannot mute, enable AGC, or change gain.

plug_properties: Option<PlugProperties>

Configuration of the device’s plug state. If not specified, the device starts plugged in, with plug notifications enabled, and is not hardwired.

initial_notifications_per_ring: Option<u32>

Initial notification frequency. This can be changed later with SetNotificationFrequency.

Implementations

impl Configuration

pub const EMPTY: Self = _

An empty table with every field set to None.

Trait Implementations

impl Clone for Configuration

fn clone(&self) -> Configuration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Configuration

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

Formats the value using the given formatter.

impl Decode<Configuration> for Configuration

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 Encode<Configuration> for &Configuration

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 Encode<Configuration> for Configuration

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<Configuration> for Configuration

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

type Owned = Configuration

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 Configuration

type Borrowed<'a> = &'a <Configuration as TypeMarker>::Owned

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 StructuralPartialEq for Configuration

impl TopLevel for Configuration