Enum CompositeRequest 

pub enum CompositeRequest {
    GetHealthState {
        responder: CompositeGetHealthStateResponder,
    },
    SignalProcessingConnect {
        protocol: ServerEnd<SignalProcessingMarker>,
        control_handle: CompositeControlHandle,
    },
    Reset {
        responder: CompositeResetResponder,
    },
    GetProperties {
        responder: CompositeGetPropertiesResponder,
    },
    GetRingBufferFormats {
        processing_element_id: u64,
        responder: CompositeGetRingBufferFormatsResponder,
    },
    CreateRingBuffer {
        processing_element_id: u64,
        format: Format2,
        ring_buffer: ServerEnd<RingBufferMarker>,
        responder: CompositeCreateRingBufferResponder,
    },
    GetDaiFormats {
        processing_element_id: u64,
        responder: CompositeGetDaiFormatsResponder,
    },
    SetDaiFormat {
        processing_element_id: u64,
        format: DaiFormat,
        responder: CompositeSetDaiFormatResponder,
    },
    GetPacketStreamFormats {
        processing_element_id: u64,
        responder: CompositeGetPacketStreamFormatsResponder,
    },
    CreatePacketStream {
        processing_element_id: u64,
        format: Format2,
        packet_stream_control: ServerEnd<PacketStreamControlMarker>,
        responder: CompositeCreatePacketStreamResponder,
    },
    #[non_exhaustive]
    _UnknownMethod {
        ordinal: u64,
        control_handle: CompositeControlHandle,
        method_type: MethodType,
    },
}

Variants

GetHealthState

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

Fields

responder: CompositeGetHealthStateResponder

SignalProcessingConnect

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.

Fields

protocol: ServerEnd<SignalProcessingMarker>

control_handle: CompositeControlHandle

Reset

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.

Fields

responder: CompositeResetResponder

GetProperties

Retrieves top level static properties.

Fields

responder: CompositeGetPropertiesResponder

GetRingBufferFormats

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 SupportedFormats2 allows for cases where exclusive combinations of the parameters in SupportedFormats2 may be supported. The vector returned to the caller must contain at least one entry.

Fields

processing_element_id: u64

responder: CompositeGetRingBufferFormatsResponder

CreateRingBuffer

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. Returns NOT_SUPPORTED if the driver does not support ring buffers, or if the specified format is not supported.

Fields

processing_element_id: u64

format: Format2

ring_buffer: ServerEnd<RingBufferMarker>

responder: CompositeCreateRingBufferResponder

GetDaiFormats

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 DaiSupportedFormats may be supported. The vector returned to the caller must contain at least one entry.

Fields

processing_element_id: u64

responder: CompositeGetDaiFormatsResponder

SetDaiFormat

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.

Fields

processing_element_id: u64

format: DaiFormat

responder: CompositeSetDaiFormatResponder

GetPacketStreamFormats

Retrieves the packet-stream formats supported by a PACKET_STREAM processing element in the topologies supported by this driver, as returned by GetElements and GetTopologies from fuchsia.hardware.audio.signalprocessing.

Returns SHOULD_WAIT if the packet-stream formats are not available at this time. The client may retry this request 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 PACKET_STREAM. Returns NOT_SUPPORTED if the driver does not support packet streams. Returning a vector with multiple SupportedFormats2 enables cases where exclusive combinations of the parameters in SupportedFormats2 may be supported. The vector returned to the caller must contain at least one entry.

Fields

processing_element_id: u64

responder: CompositeGetPacketStreamFormatsResponder

CreatePacketStream

CreatePacketStream is sent by clients to select a packet-stream format for the PACKET_STREAM processing element specified by processing_element_id. The format is based on information that the driver provides in GetPacketStreamFormats, what is supported by the client, and any other requirement. The returned packet_stream channel is used to access and control the packet stream protocol served 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 PACKET_STREAM. Returns SHOULD_WAIT if the server cannot create a packet stream for this element/format at this time, but it should be able to at some future time. This request can be retried. Returns NOT_SUPPORTED if the driver does not support packet streams, or if the specified format is not supported.

Fields

processing_element_id: u64

format: Format2

packet_stream_control: ServerEnd<PacketStreamControlMarker>

responder: CompositeCreatePacketStreamResponder

#[non_exhaustive]

_UnknownMethod

An interaction was received which does not match any known method.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ordinal: u64

Ordinal of the method that was called.

control_handle: CompositeControlHandle

method_type: MethodType

Implementations

impl CompositeRequest

pub fn into_get_health_state(self) -> Option<CompositeGetHealthStateResponder>

pub fn into_signal_processing_connect( self, ) -> Option<(ServerEnd<SignalProcessingMarker>, CompositeControlHandle)>

pub fn into_reset(self) -> Option<CompositeResetResponder>

pub fn into_get_properties(self) -> Option<CompositeGetPropertiesResponder>

pub fn into_get_ring_buffer_formats( self, ) -> Option<(u64, CompositeGetRingBufferFormatsResponder)>

pub fn into_create_ring_buffer( self, ) -> Option<(u64, Format2, ServerEnd<RingBufferMarker>, CompositeCreateRingBufferResponder)>

pub fn into_get_dai_formats( self, ) -> Option<(u64, CompositeGetDaiFormatsResponder)>

pub fn into_set_dai_format( self, ) -> Option<(u64, DaiFormat, CompositeSetDaiFormatResponder)>

pub fn into_get_packet_stream_formats( self, ) -> Option<(u64, CompositeGetPacketStreamFormatsResponder)>

pub fn into_create_packet_stream( self, ) -> Option<(u64, Format2, ServerEnd<PacketStreamControlMarker>, CompositeCreatePacketStreamResponder)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for CompositeRequest

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

Formats the value using the given formatter.