Crate fidl_fuchsia_audio_device

Source

Macros§

ControlCodecStartErrorUnknown
Pattern that matches an unknown ControlCodecStartError member.
ControlCodecStopErrorUnknown
Pattern that matches an unknown ControlCodecStopError 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.
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
ControlCreateRingBufferRequest
ControlCreateRingBufferResponder
ControlCreateRingBufferResponse
ControlCreatorControlHandle
ControlCreatorCreateRequest
ControlCreatorCreateResponder
ControlCreatorCreateResponse
ControlCreatorEventStream
ControlCreatorMarker
ControlCreatorProxy
ControlCreatorRequestStream
A Stream of incoming requests for fuchsia.audio.device/ControlCreator.
ControlCreatorSynchronousProxy
ControlEventStream
ControlGetElementsResponder
ControlGetTopologiesResponder
ControlMarker
ControlProxy
ControlRequestStream
A Stream of incoming requests for fuchsia.audio.device/Control.
ControlResetResponder
ControlResetResponse
ControlSetDaiFormatRequest
ControlSetDaiFormatResponder
ControlSetDaiFormatResponse
ControlSetElementStateResponder
ControlSetTopologyResponder
ControlSynchronousProxy
ControlWatchElementStateResponder
ControlWatchTopologyResponder
DelayInfo
ElementDaiFormatSet
This table represents the possible Dai formats that this endpoint can support.
ElementRingBufferFormatSet
This table represents the possible RingBuffer formats that this endpoint 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.
ObserverSynchronousProxy
ObserverWatchElementStateResponder
ObserverWatchPlugStateResponder
ObserverWatchPlugStateResponse
ObserverWatchTopologyResponder
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.
ProviderSynchronousProxy
RegistryControlHandle
RegistryCreateObserverRequest
RegistryCreateObserverResponder
RegistryCreateObserverResponse
RegistryEventStream
RegistryMarker
RegistryProxy
RegistryRequestStream
A Stream of incoming requests for fuchsia.audio.device/Registry.
RegistrySynchronousProxy
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
RingBufferSynchronousProxy
RingBufferWatchDelayInfoResponder
RingBufferWatchDelayInfoResponse

Enums§

ControlCodecStartError
Errors returned by Control/CodecStart.
ControlCodecStopError
Errors returned by Control/CodecStop.
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.
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_COUNT_CHANNELS
Maximum number of channels that a device can report as supported.
MAX_COUNT_CHANNEL_SETS
Maximum number of ChannelSets that a device can report in a single PcmFormatSet.
MAX_COUNT_DAI_FORMATS
MAX_COUNT_DEVICES
Maximum number of audio devices in the system at any time.
MAX_COUNT_FORMATS
Maximum number of PcmFormatSets that a device can report as supported.
MAX_COUNT_PROCESSING_ELEMENTS
Maximum number of processing elements supported by a single device.
MAX_COUNT_RATES
Maximum number of frame rates that a device can report in a PcmFormatSet.
MAX_COUNT_SAMPLE_TYPES
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
ProviderProxyInterface
RegistryProxyInterface
RingBufferProxyInterface

Type Aliases§

ClockDomain
Common aliases, consts and types used by more than one of the fuchsia.audio.device protocols.
ControlCodecStartResult
ControlCodecStopResult
ControlCreateRingBufferResult
ControlCreatorCreateResult
ControlResetResult
ControlSetDaiFormatResult
ElementId
ObserverGetReferenceClockResult
ObserverWatchPlugStateResult
ProviderAddDeviceResult
RegistryCreateObserverResult
RegistryWatchDeviceRemovedResult
RegistryWatchDevicesAddedResult
RingBufferSetActiveChannelsResult
RingBufferStartResult
RingBufferStopResult
RingBufferWatchDelayInfoResult
TokenId
TopologyId