Struct CompositeProxy

pub struct CompositeProxy { /* private fields */ }

Implementations

impl CompositeProxy

pub fn new(channel: AsyncChannel) -> Self

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

pub fn take_event_stream(&self) -> CompositeEventStream

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 reset( &self, ) -> QueryResponseFut<CompositeResetResult, DefaultFuchsiaResourceDialect>

Resets the hardware including all DAI interconnects and signal processing. As a result, all channels obtained by CreateRingBuffer will be closed.

Reset returns when the hardware is fully reset. At this point, a client would need to reconfigure any DAI interconnects, select a signal processing topology and reconfigure any processing elements, and reconstruct any ring buffers.

If the driver can’t successfully reset the hardware, it will return an error and then close the protocol channel, in this case the client may obtain a new protocol channel and retry.

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

Retrieves top level static properties.

pub fn get_ring_buffer_formats( &self, processing_element_id: u64, ) -> QueryResponseFut<CompositeGetRingBufferFormatsResult, DefaultFuchsiaResourceDialect>

Retrieves the ring buffer formats supported by a RING_BUFFER processing element in the topology supported by this driver as returned by GetElements from fuchsia.hardware.audio.signalprocessing. Returns SHOULD_WAIT if the ring buffer formats are not available at the time, the client may retry at a later time. Returns INVALID_ARGS if the processing_element_id does not match an id returned by GetElements. Returns WRONG_TYPE if the ElementType of the element represented by the id is not RING_BUFFER. Retrieving multiple SupportedFormats allows for cases where exclusive combinations of the parameters in SupportedFormats may be supported.

pub fn create_ring_buffer( &self, processing_element_id: u64, format: &Format, ring_buffer: ServerEnd<RingBufferMarker>, ) -> QueryResponseFut<CompositeCreateRingBufferResult, DefaultFuchsiaResourceDialect>

CreateRingBuffer is sent by clients to select a ring buffer format for the RING_BUFFER processing element specified by processing_element_id. The format is based on information that the driver provides in GetRingBufferFormats, what is supported by the client, and any other requirement. The returned ring_buffer channel is used to access and control the audio buffer provided by the driver. Returns INVALID_ARGS if the processing_element_id does not match an id returned by GetElements. Returns WRONG_TYPE if the ElementType of the element represented by the id is not RING_BUFFER.

pub fn get_dai_formats( &self, processing_element_id: u64, ) -> QueryResponseFut<CompositeGetDaiFormatsResult, DefaultFuchsiaResourceDialect>

Retrieves the DAI formats supported by a DAI_INTERCONNECT processing element in the topology supported by this driver as returned by GetElements from fuchsia.hardware.audio.signalprocessing. Returns SHOULD_WAIT if the DAI formats are not available at the time, the client may retry at a later time. Returns INVALID_ARGS if the processing_element_id does not match an id returned by GetElements. Returns WRONG_TYPE if the ElementType of the element represented by the id is not DAI_INTERCONNECT. Retrieving multiple DaiSupportedFormats allows for cases where exclusive combinations of the parameters in SupportedFormats may be supported.

pub fn set_dai_format( &self, processing_element_id: u64, format: &DaiFormat, ) -> QueryResponseFut<CompositeSetDaiFormatResult, DefaultFuchsiaResourceDialect>

SetDaiFormat is sent by clients to select a DAI format for the DAI_INTERCONNECT processing element specified by processing_element_id. The format is based on information that the driver provides in GetDaiFormats, what is supported by the client, and any other requirement. Returns INVALID_ARGS if the processing_element_id does not match an id returned by GetElements. Returns WRONG_TYPE if the ElementType of the element represented by the id is not DAI_INTERCONNECT.

Trait Implementations

impl Clone for CompositeProxy

fn clone(&self) -> CompositeProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompositeProxyInterface for CompositeProxy

type GetHealthStateResponseFut = QueryResponseFut<HealthState>

type ResetResponseFut = QueryResponseFut<Result<(), DriverError>>

type GetPropertiesResponseFut = QueryResponseFut<CompositeProperties>

type GetRingBufferFormatsResponseFut = QueryResponseFut<Result<Vec<SupportedFormats>, DriverError>>

type CreateRingBufferResponseFut = QueryResponseFut<Result<(), DriverError>>

type GetDaiFormatsResponseFut = QueryResponseFut<Result<Vec<DaiSupportedFormats>, DriverError>>

type SetDaiFormatResponseFut = QueryResponseFut<Result<(), DriverError>>

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

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

fn reset(&self) -> Self::ResetResponseFut

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

fn get_ring_buffer_formats( &self, processing_element_id: u64, ) -> Self::GetRingBufferFormatsResponseFut

fn create_ring_buffer( &self, processing_element_id: u64, format: &Format, ring_buffer: ServerEnd<RingBufferMarker>, ) -> Self::CreateRingBufferResponseFut

fn get_dai_formats( &self, processing_element_id: u64, ) -> Self::GetDaiFormatsResponseFut

fn set_dai_format( &self, processing_element_id: u64, format: &DaiFormat, ) -> Self::SetDaiFormatResponseFut

impl Debug for CompositeProxy

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

Formats the value using the given formatter.

impl Proxy for CompositeProxy

type Protocol = CompositeMarker

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.