Skip to main content

Crate fdomain_fuchsia_audio_device

Crate fdomain_fuchsia_audio_device 

Source

Modules§

control_creator_ordinals
control_ordinals
observer_ordinals
packet_stream_ordinals
provider_ordinals
registry_ordinals
ring_buffer_ordinals

Macros§

ControlCodecStartErrorUnknown
Pattern that matches an unknown ControlCodecStartError member.
ControlCodecStopErrorUnknown
Pattern that matches an unknown ControlCodecStopError member.
ControlCreatePacketStreamErrorUnknown
Pattern that matches an unknown ControlCreatePacketStreamError member.
ControlCreateRingBufferErrorUnknown
Pattern that matches an unknown ControlCreateRingBufferError member.
ControlCreatorErrorUnknown
Pattern that matches an unknown ControlCreatorError member.
ControlResetErrorUnknown
Pattern that matches an unknown ControlResetError member.
ControlSetDaiFormatErrorUnknown
Pattern that matches an unknown ControlSetDaiFormatError member.
DeviceTypeUnknown
Pattern that matches an unknown DeviceType member.
DriverClientUnknown
Pattern that matches an unknown DriverClient member.
ObserverGetReferenceClockErrorUnknown
Pattern that matches an unknown ObserverGetReferenceClockError member.
ObserverWatchPlugStateErrorUnknown
Pattern that matches an unknown ObserverWatchPlugStateError member.
PacketStreamFormatUnknown
Pattern that matches an unknown PacketStreamFormat member.
PacketStreamSetBufferErrorUnknown
Pattern that matches an unknown PacketStreamSetBufferError member.
PacketStreamSetupVmoInfoUnknown
Pattern that matches an unknown PacketStreamSetupVmoInfo member.
PacketStreamStartErrorUnknown
Pattern that matches an unknown PacketStreamStartError member.
PacketStreamStopErrorUnknown
Pattern that matches an unknown PacketStreamStopError member.
PacketStreamSupportedFormatsUnknown
Pattern that matches an unknown PacketStreamSupportedFormats member.
PlugDetectCapabilitiesUnknown
Pattern that matches an unknown PlugDetectCapabilities member.
PlugStateUnknown
Pattern that matches an unknown PlugState member.
ProviderAddDeviceErrorUnknown
Pattern that matches an unknown ProviderAddDeviceError member.
RegistryCreateObserverErrorUnknown
Pattern that matches an unknown RegistryCreateObserverError member.
RegistryWatchDeviceRemovedErrorUnknown
Pattern that matches an unknown RegistryWatchDeviceRemovedError member.
RegistryWatchDevicesAddedErrorUnknown
Pattern that matches an unknown RegistryWatchDevicesAddedError member.
RingBufferSetActiveChannelsErrorUnknown
Pattern that matches an unknown RingBufferSetActiveChannelsError member.
RingBufferStartErrorUnknown
Pattern that matches an unknown RingBufferStartError member.
RingBufferStopErrorUnknown
Pattern that matches an unknown RingBufferStopError member.
RingBufferWatchDelayInfoErrorUnknown
Pattern that matches an unknown RingBufferWatchDelayInfoError member.

Structs§

ChannelAttributes
The attributes (e.g. frequency range) of a single channel.
ChannelSet
One possible channel configuration for the device.
ControlCodecStartResponder
ControlCodecStartResponse
ControlCodecStopResponder
ControlCodecStopResponse
ControlControlHandle
ControlCreatePacketStreamRequest
ControlCreatePacketStreamResponder
ControlCreatePacketStreamResponse
ControlCreateRingBufferRequest
ControlCreateRingBufferResponder
ControlCreateRingBufferResponse
ControlCreatorControlHandle
ControlCreatorCreateRequest
ControlCreatorCreateResponder
ControlCreatorCreateResponse
ControlCreatorEventStream
ControlCreatorMarker
ControlCreatorProxy
ControlCreatorRequestStream
A Stream of incoming requests for fuchsia.audio.device/ControlCreator.
ControlEventStream
ControlGetElementsResponder
ControlGetTopologiesResponder
ControlMarker
ControlProxy
ControlRequestStream
A Stream of incoming requests for fuchsia.audio.device/Control.
ControlResetResponder
ControlResetResponse
ControlSetDaiFormatRequest
ControlSetDaiFormatResponder
ControlSetDaiFormatResponse
ControlSetElementStateResponder
ControlSetTopologyResponder
ControlWatchElementStateResponder
ControlWatchTopologyResponder
DelayInfo
ElementDaiFormatSet
This table represents the possible Dai formats that this transport can support.
ElementPacketStreamFormatSet
This table represents the possible Packet Stream formats that this element can support.
ElementRingBufferFormatSet
This table represents the possible RingBuffer formats that this transport can support.
Info
When a device is detected (or added via Provider/AddDevice), it is queried for its properties and capabilities. Once this enumeration process completes, it is announced to clients that are watching for device arrivals via Registry/WatchDevicesAdded.
ObserverControlHandle
ObserverEventStream
ObserverGetElementsResponder
ObserverGetReferenceClockResponder
ObserverGetReferenceClockResponse
ObserverGetTopologiesResponder
ObserverMarker
ObserverProxy
ObserverRequestStream
A Stream of incoming requests for fuchsia.audio.device/Observer.
ObserverWatchElementStateResponder
ObserverWatchPlugStateResponder
ObserverWatchPlugStateResponse
ObserverWatchTopologyResponder
PacketStreamBuffers
PacketStreamControlHandle
PacketStreamEventStream
PacketStreamMarker
PacketStreamOptions
Parameters specified by a caller when creating a packet stream.
PacketStreamProperties
Information about the associated audio stream.
PacketStreamProxy
PacketStreamRequestStream
A Stream of incoming requests for fuchsia.audio.device/PacketStream.
PacketStreamSetBuffersRequest
PacketStreamSetBuffersResponder
PacketStreamSetBuffersResponse
PacketStreamStartRequest
PacketStreamStartResponder
PacketStreamStartResponse
PacketStreamStopRequest
PacketStreamStopResponder
PacketStreamStopResponse
PcmFormatSet
This table contains vectors representing three dimensions of device configuration (channelization, sample format, frame rate). The device should support all combinations of the items in these vectors.
ProviderAddDeviceRequest
ProviderAddDeviceResponder
ProviderAddDeviceResponse
ProviderControlHandle
ProviderEventStream
ProviderMarker
ProviderProxy
ProviderRequestStream
A Stream of incoming requests for fuchsia.audio.device/Provider.
RegistryControlHandle
RegistryCreateObserverRequest
RegistryCreateObserverResponder
RegistryCreateObserverResponse
RegistryEventStream
RegistryMarker
RegistryProxy
RegistryRequestStream
A Stream of incoming requests for fuchsia.audio.device/Registry.
RegistryWatchDeviceRemovedResponder
RegistryWatchDeviceRemovedResponse
RegistryWatchDevicesAddedResponder
RegistryWatchDevicesAddedResponse
RingBufferControlHandle
RingBufferEventStream
RingBufferMarker
RingBufferOptions
Parameters specified by a caller when creating a ring buffer.
RingBufferProperties
Information about the ring buffer or associated audio stream.
RingBufferProxy
RingBufferRequestStream
A Stream of incoming requests for fuchsia.audio.device/RingBuffer.
RingBufferSetActiveChannelsRequest
RingBufferSetActiveChannelsResponder
RingBufferSetActiveChannelsResponse
RingBufferStartRequest
RingBufferStartResponder
RingBufferStartResponse
RingBufferStopRequest
RingBufferStopResponder
RingBufferStopResponse
RingBufferWatchDelayInfoResponder
RingBufferWatchDelayInfoResponse

Enums§

ControlCodecStartError
Errors returned by Control/CodecStart.
ControlCodecStopError
Errors returned by Control/CodecStop.
ControlCreatePacketStreamError
Errors returned by Control/CreatePacketStream.
ControlCreateRingBufferError
Errors returned by Control/CreateRingBuffer.
ControlCreatorError
Errors returned by ControlCreator/Create.
ControlCreatorEvent
ControlCreatorRequest
A ControlCreator interface creates Control instances. Each Control binds to a single device. A device can only be bound to one Control at any time.
ControlEvent
ControlRequest
A Control instance is used to change the settings or state of an audio device. It also creates the ring buffer used to pass audio data between client and device. Each Control is associated with an initialized audio device; conversely each device is associated with either zero or one Control at any time.
ControlResetError
Errors returned by Control/Reset.
ControlSetDaiFormatError
Errors returned by Control/SetDaiFormat.
DeviceType
The protocol used by the driver.
DriverClient
The protocol channel used to configure and observe a device.
ObserverEvent
ObserverGetReferenceClockError
Errors returned by Observer/GetReferenceClock.
ObserverRequest
Observer instances are used to learn the capabilities and state of an audio device, and to stay informed as its state changes over time. Each Observer is associated with an initialized audio device. An audio device may be observed by multiple Observer instances.
ObserverWatchPlugStateError
Errors returned by Observer/WatchPlugState.
PacketStreamEvent
PacketStreamFormat
The data format of the packet stream.
PacketStreamRequest
A PacketStream instance controls data flow for the associated audio stream.
PacketStreamSetBufferError
Errors returned by PacketStream/SetBuffer.
PacketStreamSetupVmoInfo
Configuration for VMO allocation or registration.
PacketStreamStartError
Errors returned by PacketStream/Start.
PacketStreamStopError
Errors returned by PacketStream/Stop.
PacketStreamSupportedFormats
This union represents a specific set of formats supported by a packet stream. A packet stream may support uncompressed PCM, encoded audio, or both. A vector of this union is used to describe the possible formats that a packet stream can support.
PlugDetectCapabilities
The device’s hot-plug capabilities.
PlugState
The current plugged-in state for the device.
ProviderAddDeviceError
Errors returned by the Provider protocol.
ProviderEvent
ProviderRequest
Use the Provider interface to manually add devices that do not use the devfs mechanism. (Devices that use devfs are automatically added, upon detection.)
RegistryCreateObserverError
Errors returned by Registry/CreateObserver.
RegistryEvent
RegistryRequest
Registry instances notify clients as devices arrive and depart, and they create observers (see Observer) that notify of more detailed state changes.
RegistryWatchDeviceRemovedError
Errors returned by Registry/WatchDeviceRemoved.
RegistryWatchDevicesAddedError
Errors returned by Registry/WatchDevicesAdded.
RingBufferEvent
RingBufferRequest
A RingBuffer instance controls data flow for the associated audio stream.
RingBufferSetActiveChannelsError
Errors returned by RingBuffer/SetActiveChannels.
RingBufferStartError
Errors returned by RingBuffer/Start.
RingBufferStopError
Errors returned by RingBuffer/Stop.
RingBufferWatchDelayInfoError
Errors returned by RingBuffer/WatchDelayInfo.

Constants§

DEFAULT_DAI_INTERCONNECT_ELEMENT_ID
For devices with Codec drivers, there is only one DAI_INTERCONNECT entity. When a method requires us to address the interconnect by ID, we use element_id 1. Codec drivers that implement signalprocessing should not assign this ID to other elements.
MAX_CHANNEL_COUNT
Maximum number of channels that a device can report as supported.
MAX_CHANNEL_SET_COUNT
Maximum number of ChannelSets that a device can report in a single PcmFormatSet.
MAX_DAI_FORMAT_COUNT
MAX_DEVICE_COUNT
Maximum number of audio devices in the system at any time.
MAX_FORMAT_COUNT
Maximum number of PcmFormatSets that a device can report as supported.
MAX_PROCESSING_ELEMENT_COUNT
Maximum number of processing elements supported by a single device.
MAX_RATE_COUNT
Maximum number of frame rates that a device can report in a PcmFormatSet.
MAX_SAMPLE_TYPE_COUNT
Maximum number of distinct sample formats that a single PcmFormatSet can contain.
MAX_STRING_SIZE
Maximum length of the strings for device, manufacturer and product names.
UNIQUE_INSTANCE_ID_SIZE
The length of the device’s unique ID, in bytes.

Traits§

ControlCreatorProxyInterface
ControlProxyInterface
ObserverProxyInterface
PacketStreamProxyInterface
ProviderProxyInterface
RegistryProxyInterface
RingBufferProxyInterface

Type Aliases§

ClockDomain
ControlCodecStartResult
ControlCodecStopResult
ControlCreatePacketStreamResult
ControlCreateRingBufferResult
ControlCreatorCreateResult
ControlResetResult
ControlSetDaiFormatResult
ElementId
ObserverGetReferenceClockResult
ObserverWatchPlugStateResult
PacketStreamSetBuffersResult
PacketStreamStartResult
PacketStreamStopResult
ProviderAddDeviceResult
RegistryCreateObserverResult
RegistryWatchDeviceRemovedResult
RegistryWatchDevicesAddedResult
RingBufferSetActiveChannelsResult
RingBufferStartResult
RingBufferStopResult
RingBufferWatchDelayInfoResult
TokenId
TopologyId