Modules§
- codec_
connector_ ordinals - codec_
ordinals - composite_
connector_ ordinals - composite_
ordinals - dai_
connector_ ordinals - dai_
ordinals - health_
ordinals - ring_
buffer_ ordinals - stream_
config_ connector_ ordinals - stream_
config_ ordinals
Macros§
- Device
Type Unknown - Pattern that matches an unknown
DeviceTypemember. - Driver
Error Unknown - Pattern that matches an unknown
DriverErrormember.
Structs§
- Channel
Attributes - The specification of a single channel, within the overall channel configuration.
- Channel
Set - The specification of a channel configuration.
- Codec
Format Info - Codec format information.
- Codec
GetDai Formats Response - Codec
GetProperties Response - Codec
Properties - Codec
SetDai Format Request - Codec
SetDai Format Response - Codec
Start Response - Codec
Stop Response - Codec
Watch Plug State Response - Composite
GetDai Formats Request - Composite
GetDai Formats Response - Composite
GetProperties Response - Composite
GetRing Buffer Formats Request - Composite
GetRing Buffer Formats Response - Composite
Properties - Composite
SetDai Format Request - DaiFormat
- DAI format. Frames are made up of
number_of_channelssamples which havebits_per_samplebits of data withinbits_per_slotarranged inframe_format. For more detailed information see Digital Audio Interface. - DaiFrame
Format Custom - Custom Frame format.
- DaiGet
DaiFormats Response - DaiGet
Properties Response - DaiGet
Ring Buffer Formats Response - DaiProperties
- DaiSupported
Formats - Formats supported by the DAI. Frames are made up of
number_of_channelssamples which havebits_per_samplebits of data withinbits_per_slotbits arranged inframe_formats. All values listed in each vector are supported. When not all combinations supported by the driver can be described with oneDaiSupportedFormats,GetDaiSupportedFormatsreturns more than oneDaiSupportedFormatsin the returned vector. For more detailed information see Digital Audio Interface. - Delay
Info - Delay information as returned by the driver.
- Format
- Gain
State - Gain state requested by the client or returned by the driver.
- Health
GetHealth State Response - Health
State - PcmFormat
- Format supporting non-compressed PCM audio. Frames are made up of
number_of_channelssamples which havevalid_bits_per_samplebits of most-significant (left-justified) data withinbytes_per_sample. bytes. For more detailed information see Audio Driver Streaming Interface. - PcmSupported
Formats - Format supporting non-compressed PCM audio. Each frame consists of one or more
(number_of_channels) samples, stored contiguously. Within the
bytes_per_sampleallocated for each sample,valid_bits_per_samplebits of data are stored in the most-significant (left-justified) portion. All values listed in each vector are supported. When not all combinations supported by the driver can be described with oneSupportedFormatsorPcmSupportedFormats,GetSupportedFormatsreturns more than oneSupportedFormatsin the returned vector. For more detailed information see Audio Driver Streaming Interface. - Plug
State - Plug state as returned by the driver.
If the driver reports a
plug_detect_capabilitiesequal to HARDWIRED, then the driver should respond toWatchPlugStateonly the first time it is called, withpluggedset to true andplug_state_timeset to time ‘0’. - Ring
Buffer GetProperties Response - Ring
Buffer GetVmo Request - Ring
Buffer Position Info - Ring
Buffer Properties - Properties of the ring buffer. These values don’t change once the ring buffer is created.
- Ring
Buffer SetActive Channels Request - Ring
Buffer SetActive Channels Response - Ring
Buffer Start Response - Ring
Buffer Watch Clock Recovery Position Info Response - Ring
Buffer Watch Delay Info Response - Stream
Config GetProperties Response - Stream
Config GetSupported Formats Response - Stream
Config SetGain Request - Stream
Config Watch Gain State Response - Stream
Config Watch Plug State Response - Stream
Properties - Supported
Formats - All the possible formats supported by this device.
Enums§
- DaiFrame
Format - Either a standard or custom frame format.
- DaiFrame
Format Standard - Standard Frame format.
- DaiSample
Format - Device
Type - Driver
Error - GetVmo
Error - Plug
Detect Capabilities - Sample
Format
Constants§
- CLOCK_
DOMAIN_ EXTERNAL - CLOCK_
DOMAIN_ MONOTONIC - MAX_
COUNT_ CHANNELS_ IN_ RING_ BUFFER - MAX_
COUNT_ CHANNEL_ SETS - MAX_
COUNT_ DAI_ FORMATS - MAX_
COUNT_ DAI_ SUPPORTED_ BITS_ PER_ SAMPLE - MAX_
COUNT_ DAI_ SUPPORTED_ BITS_ PER_ SLOT - MAX_
COUNT_ DAI_ SUPPORTED_ FRAME_ FORMATS - MAX_
COUNT_ DAI_ SUPPORTED_ NUMBER_ OF_ CHANNELS - MAX_
COUNT_ DAI_ SUPPORTED_ RATES - MAX_
COUNT_ DAI_ SUPPORTED_ SAMPLE_ FORMATS - MAX_
COUNT_ FORMATS - MAX_
COUNT_ SUPPORTED_ BYTES_ PER_ SAMPLE - MAX_
COUNT_ SUPPORTED_ NUMBER_ OF_ CHANNELS - MAX_
COUNT_ SUPPORTED_ RATES - MAX_
COUNT_ SUPPORTED_ SAMPLE_ FORMATS - MAX_
COUNT_ SUPPORTED_ VALID_ BITS_ PER_ SAMPLE - MAX_
DAI_ UI_ STRING_ SIZE - MAX_
UI_ STRING_ SIZE - UNIQUE_
ID_ SIZE