Struct StreamConfigProxy

pub struct StreamConfigProxy { /* private fields */ }

Implementations

impl StreamConfigProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.audio/StreamConfig.

pub fn take_event_stream(&self) -> StreamConfigEventStream

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

Panics

Panics if the event stream was already taken.

pub fn get_health_state( &self, ) -> QueryResponseFut<HealthState, DefaultFuchsiaResourceDialect>

Retrieves top level health state. A driver not responding promptly can be used as an indication of an unhealthy driver.

pub fn signal_processing_connect( &self, protocol: ServerEnd<SignalProcessingMarker>, ) -> Result<(), Error>

Connect to a SignalProcessing protocol. Multiple connections may be supported, if a new connection request is not supported, i.e. the maximum number of connections have already been created, for instance one, then the protocol channel (not the channel upon which SignalProcessingConnect is being called) will be closed with a ZX_ERR_ALREADY_BOUND epitaph. If signal processing is not supported at all, then the protocol channel (again, not the channel upon which SignalProcessingConnect is being called) will be closed with a ZX_ERR_NOT_SUPPORTED epitaph. This method is named SignalProcessingConnect instead of Connect because this protocol is intended to be composed, and hence the more verbose name allows differentiation and improved clarity.

pub fn get_properties( &self, ) -> QueryResponseFut<StreamProperties, DefaultFuchsiaResourceDialect>

Retrieves top level static properties.

pub fn get_supported_formats( &self, ) -> QueryResponseFut<Vec<SupportedFormats>, DefaultFuchsiaResourceDialect>

Gets formats supported by a given driver. When not all combinations supported by the driver can be described with one SupportedFormats, the driver returns more than one SupportedFormats in the returned vector. For example, if one SupportedFormats allows for 32 bits samples at 48KHz, and 16 bits samples at 96KHz, but not 32 bits samples at 96KHz, then the driver replies with 2 SupportedFormats: <<32bits>,<48KHz>> and <<16bits>,<96KHz>>. For simplicity, this example ignores parameters other than rate and bits per sample. In the case where the driver supports either 16 or 32 bits samples at either 48 or 96KHz, the driver would reply with 1 SupportedFormats: <<16bits,32bits>,<48KHz,96KHz>>.

pub fn create_ring_buffer( &self, format: &Format, ring_buffer: ServerEnd<RingBufferMarker>, ) -> Result<(), Error>

CreateRingBuffer is sent by clients to select a stream format based on information that the driver provides in GetSupportedFormats what is supported by the client, and any other requirement. The ring_buffer channel is used to control the audio buffer, if a previous ring buffer channel had been established and was still active, the driver must close that (ring buffer) channel and make every attempt to gracefully quiesce any on-going streaming operations in the process.

pub fn watch_gain_state( &self, ) -> QueryResponseFut<GainState, DefaultFuchsiaResourceDialect>

Get the gain state via a hanging get. The driver will reply to the first WatchGainState sent by the client and this reply must include a gain_db set to 0dB or lower. The driver will not respond to subsequent client WatchGainState calls until the gain state changes from what was most recently reported. If WatchGainState is called for a second time before the first call has completed, then the protocol channel must be closed with the error ZX_ERR_BAD_STATE.

pub fn set_gain(&self, target_state: &GainState) -> Result<(), Error>

Client update of the gain state.

pub fn watch_plug_state( &self, ) -> QueryResponseFut<PlugState, DefaultFuchsiaResourceDialect>

Get the plug detect state via a hanging get. The driver will reply to the first WatchPlugState sent by the client. The driver will not respond to subsequent client WatchPlugState calls until the plug state changes from what was most recently reported. If WatchPlugState is called for a second time before the first call has completed, then the protocol channel must be closed with the error ZX_ERR_BAD_STATE.

Trait Implementations

impl Clone for StreamConfigProxy

fn clone(&self) -> StreamConfigProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamConfigProxy

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

Formats the value using the given formatter.

impl Proxy for StreamConfigProxy

type Protocol = StreamConfigMarker

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.

impl StreamConfigProxyInterface for StreamConfigProxy

type GetHealthStateResponseFut = QueryResponseFut<HealthState>

type GetPropertiesResponseFut = QueryResponseFut<StreamProperties>

type GetSupportedFormatsResponseFut = QueryResponseFut<Vec<SupportedFormats>>

type WatchGainStateResponseFut = QueryResponseFut<GainState>

type WatchPlugStateResponseFut = QueryResponseFut<PlugState>

fn get_health_state(&self) -> Self::GetHealthStateResponseFut

fn signal_processing_connect( &self, protocol: ServerEnd<SignalProcessingMarker>, ) -> Result<(), Error>

fn get_properties(&self) -> Self::GetPropertiesResponseFut

fn get_supported_formats(&self) -> Self::GetSupportedFormatsResponseFut

fn create_ring_buffer( &self, format: &Format, ring_buffer: ServerEnd<RingBufferMarker>, ) -> Result<(), Error>

fn watch_gain_state(&self) -> Self::WatchGainStateResponseFut

fn set_gain(&self, target_state: &GainState) -> Result<(), Error>

fn watch_plug_state(&self) -> Self::WatchPlugStateResponseFut