Struct AudioDeviceEnumeratorProxy

pub struct AudioDeviceEnumeratorProxy { /* private fields */ }

Implementations

impl AudioDeviceEnumeratorProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.media/AudioDeviceEnumerator.

pub fn take_event_stream(&self) -> AudioDeviceEnumeratorEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn get_devices( &self, ) -> QueryResponseFut<Vec<AudioDeviceInfo>, DefaultFuchsiaResourceDialect>

Obtain the list of currently active audio devices.

pub fn get_device_gain( &self, device_token: u64, ) -> QueryResponseFut<(u64, AudioGainInfo), DefaultFuchsiaResourceDialect>

Gain/Mute/AGC control

Note that each of these operations requires a device_token in order to target the proper input/output.

The Get command returns the device_token of the device whose gain is being reported, or ZX_KOID_INVALID in the case that the requested device_token was invalid or the device had been removed from the system before the Get command could be processed.

Set commands which are given an invalid device token are ignored and have no effect on the system. In addition, users do not need to control all of the gain settings for an audio device with each call. Only the settings with a corresponding flag set in the set_flags parameter will be affected. For example, passing SetAudioGainFlag_MuteValid will cause a SetDeviceGain call to care only about the mute setting in the gain_info structure, while passing (SetAudioGainFlag_GainValid | SetAudioGainFlag_MuteValid) will cause both the mute and the gain status to be changed simultaneously.

pub fn set_device_gain( &self, device_token: u64, gain_info: &AudioGainInfo, valid_flags: AudioGainValidFlags, ) -> Result<(), Error>

pub fn add_device_by_channel( &self, device_name: &str, is_input: bool, channel: ClientEnd<StreamConfigMarker>, ) -> Result<(), Error>

Deprecation

StreamConfig is not supported anymore, instead use an Audio Composite , see Audio Drivers Architecture

Trait Implementations

impl AudioDeviceEnumeratorProxyInterface for AudioDeviceEnumeratorProxy

type GetDevicesResponseFut = QueryResponseFut<Vec<AudioDeviceInfo>>

type GetDeviceGainResponseFut = QueryResponseFut<(u64, AudioGainInfo)>

fn get_devices(&self) -> Self::GetDevicesResponseFut

fn get_device_gain(&self, device_token: u64) -> Self::GetDeviceGainResponseFut

fn set_device_gain( &self, device_token: u64, gain_info: &AudioGainInfo, valid_flags: AudioGainValidFlags, ) -> Result<(), Error>

fn add_device_by_channel( &self, device_name: &str, is_input: bool, channel: ClientEnd<StreamConfigMarker>, ) -> Result<(), Error>

impl Clone for AudioDeviceEnumeratorProxy

fn clone(&self) -> AudioDeviceEnumeratorProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioDeviceEnumeratorProxy

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

Formats the value using the given formatter.

impl Proxy for AudioDeviceEnumeratorProxy

type Protocol = AudioDeviceEnumeratorMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.