Overview

Use the links in the table of contents to the left to access the documentation.

Macro Definitions

kIOAudioControlChannelIDKey

The key in the IORegistry for the IOAudioControl channel ID attribute

kIOAudioControlChannelNameAll

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for all channels.

kIOAudioControlChannelNameCenter

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the center channel.

kIOAudioControlChannelNameFrontLeftCenter

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the FrontLeftCenter channel.

kIOAudioControlChannelNameFrontRightCenter

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the FrontRightCenter channel.

kIOAudioControlChannelNameKey

The key in the IORegistry for the IOAudioControl name attribute.

kIOAudioControlChannelNameLeft

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the left channel.

kIOAudioControlChannelNameLeftRear

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the left rear channel.

kIOAudioControlChannelNameRearCenter

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the RearCenter channel.

kIOAudioControlChannelNameRight

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the right channel.

kIOAudioControlChannelNameRightRear

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the right rear channel.

kIOAudioControlChannelNameSub

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the sub/LFE channel.

kIOAudioControlChannelNameSurroundLeft

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the SurroundLeft channel.

kIOAudioControlChannelNameSurroundRight

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the SurroundRight channel.

kIOAudioControlTypeKey

The key in the IORegistry for the IOAudioCntrol type attribute.

kIOAudioControlValueIsReadOnlyKey

The key in the IORegistry for the IOAudioControl value-is-read-only attribute.

kIOAudioControlValueKey

The key in the IORegistry for the IOAudioControl value attribute.

kIOAudioDeviceIconName

The key in the IORegistry for the IOAudioDevice icon name attribute.

kIOAudioDeviceIconNameKey

The key in the IORegistry for the IOAudioDevice icon name attribute.

kIOAudioDeviceManufacturerNameKey

The key in the IORegistry for the IOAudioDevice manufacturer name attribute.

kIOAudioDeviceNameKey

The key in the IORegistry for the IOAudioDevice name attribute.

kIOAudioEngineFullChannelCategoryNamesKey

The key in the IORegistry for the IOAudioEngine's dictionary of category names for each channel keyed by the device channel

kIOAudioEngineFullChannelNamesKey

The key in the IORegistry for the IOAudioEngine's dictionary of fully constructed names for each channel keyed by the device channel

kIOAudioEngineFullChannelNamesKey

The key in the IORegistry for the IOAudioEngine's dictionary of category names for each channel keyed by the device channel

kIOAudioEngineFullChannelNamesKey

The key in the IORegistry for the IOAudioEngine's dictionary of number names for each channel keyed by the device channel

kIOAudioEngineFullChannelNumberNamesKey

The key in the IORegistry for the IOAudioEngine's dictionary of number names for each channel keyed by the device channel

kIOAudioEngineOutputSampleLatencyKey

The key in the IORegistry for the IOAudioEngine output sample latency key

kIOAudioEngineStateKey

The key in the IORegistry for the IOAudioEngine state atrribute

kIOAudioLevelControlMaxDBKey

The key in the IORgistry for the IOAudioControl maximum db value attribute.

kIOAudioLevelControlMaxValueKey

The key in the IORegistry for the IOAudioControl maximum value attribute.

kIOAudioLevelControlMinDBKey

The key in the IORgistry for the IOAudioControl minimum db value attribute.

kIOAudioLevelControlMinValueKey

The key in the IORegistry for the IOAudioControl minimum value attribute.

kIOAudioPortNameKey

The key in the IORegistry for the IOAudioPort name attribute.

kIOAudioPortSubTypeKey

The key in the IORegistry for the IOAudioPort subtype attribute.

kIOAudioPortTypeKey

The key in the IORegistry for the IOAudioPort type attribute.

kIOAudioSampleRateKey

The key in the IORegistry for the IOAudioEngine sample rate attribute

kIOAudioStreamDirectionKey

The key in the IORegistry for the IOAudioStream direction attribute.

kIOAudioStreamSampleLatencyKey

The key in the IORegistry for the IOAudioStream output sample latency key

The key in the IORegistry for the IOAudioControl channel ID attribute

#define kIOAudioControlChannelIDKey "IOAudioControlChannelID" 

Discussion

The value for this key is an integer which may be driver defined. Default values for common channel types are provided in the following defines.

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for all channels.

#define kIOAudioControlChannelNameAll "All Channels" 

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the center channel.

#define kIOAudioControlChannelNameCenter "Center" 

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the FrontLeftCenter channel.

#define kIOAudioControlChannelNameFrontLeftCenter "FrontLeftCenter" 

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the FrontRightCenter channel.

#define kIOAudioControlChannelNameFrontRightCenter "FrontRightCenter" 

The key in the IORegistry for the IOAudioControl name attribute.

#define kIOAudioControlChannelNameKey "IOAudioControlChannelName" 

Discussion

This name should be a human-readable name for the channel(s) represented by the port. *** NOTE *** We really need to make all of the human-readable attributes that have potential to be used in a GUI localizable. There will need to be localized strings in the kext bundle matching the text.

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the left channel.

#define kIOAudioControlChannelNameLeft "Left" 

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the left rear channel.

#define kIOAudioControlChannelNameLeftRear "LeftRear" 

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the RearCenter channel.

#define kIOAudioControlChannelNameRearCenter "RearCenter" 

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the right channel.

#define kIOAudioControlChannelNameRight "Right" 

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the right rear channel.

#define kIOAudioControlChannelNameRightRear "RightRear" 

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the sub/LFE channel.

#define kIOAudioControlChannelNameSub "Sub" 

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the SurroundLeft channel.

#define kIOAudioControlChannelNameSurroundLeft "SurroundLeft" 

The value for the kIOAudioControlChannelNameKey in the IORegistry representing the channel name for the SurroundRight channel.

#define kIOAudioControlChannelNameSurroundRight "SurroundRight" 

The key in the IORegistry for the IOAudioCntrol type attribute.

#define kIOAudioControlTypeKey "IOAudioControlType" 

Discussion

The value of this text attribute may be defined by the driver, however system-defined types recognized by the upper-level software are "Level", "Mute", "Selector".

The key in the IORegistry for the IOAudioControl value-is-read-only attribute.

#define kIOAudioControlValueIsReadOnlyKey "IOAudioControlValueIsReadOnly" 

Discussion

The value returned by this key is a 32-bit integer but the value doesn't have any direct meaning. Instead, the presence of this key indicates that the value for the control is read-only

The key in the IORegistry for the IOAudioControl value attribute.

#define kIOAudioControlValueKey "IOAudioControlValue" 

Discussion

The value returned by this key is a 32-bit integer representing the current value of the IOAudioControl.

The key in the IORegistry for the IOAudioDevice icon name attribute.

#define kIOAudioDeviceIconNameKey "IOAudioDeviceIconName" 

See Also

The key in the IORegistry for the IOAudioDevice icon name attribute.

#define kIOAudioDeviceIconNameKey "IOAudioDeviceIconName" 

See Also

The key in the IORegistry for the IOAudioDevice manufacturer name attribute.

#define kIOAudioDeviceManufacturerNameKey "IOAudioDeviceManufacturerName" 

The key in the IORegistry for the IOAudioDevice name attribute.

#define kIOAudioDeviceNameKey "IOAudioDeviceName" 

The key in the IORegistry for the IOAudioEngine's dictionary of category names for each channel keyed by the device channel

#define kIOAudioEngineFullChannelCategoryNamesKey "IOAudioEngineChannelCategoryNames" 

See Also

The key in the IORegistry for the IOAudioEngine's dictionary of fully constructed names for each channel keyed by the device channel

#define kIOAudioEngineFullChannelNamesKey "IOAudioEngineChannelNames" 

The key in the IORegistry for the IOAudioEngine's dictionary of category names for each channel keyed by the device channel

#define kIOAudioEngineFullChannelCategoryNamesKey "IOAudioEngineChannelCategoryNames" 

See Also

The key in the IORegistry for the IOAudioEngine's dictionary of number names for each channel keyed by the device channel

#define kIOAudioEngineFullChannelNumberNamesKey "IOAudioEngineChannelNumberNames" 

See Also

The key in the IORegistry for the IOAudioEngine's dictionary of number names for each channel keyed by the device channel

#define kIOAudioEngineFullChannelNumberNamesKey "IOAudioEngineChannelNumberNames" 

See Also

The key in the IORegistry for the IOAudioEngine output sample latency key

#define kIOAudioEngineOutputSampleLatencyKey "IOAudioEngineOutputSampleLatency" 

The key in the IORegistry for the IOAudioEngine state atrribute

#define kIOAudioEngineStateKey "IOAudioEngineState" 

Discussion

The value for this key may be one of: "Running", "Stopped" or "Paused". Currently the "Paused" state is unimplemented.

The key in the IORgistry for the IOAudioControl maximum db value attribute.

#define kIOAudioLevelControlMaxDBKey "IOAudioLevelControlMaxDB" 

Discussion

The value returned by this key is a fixed point value in 16.16 format represented as a 32-bit integer. It represents the maximum value in db for the IOAudioControl. This value matches the maximum value attribute. This is currently valid for Level controls or other driver-defined controls that have a minimum and maximum db value.

The key in the IORegistry for the IOAudioControl maximum value attribute.

#define kIOAudioLevelControlMaxValueKey "IOAudioLevelControlMaxValue" 

Discussion

The value returned by this key is a 32-bit integer representing the maximum value for the IOAudioControl. This is currently only valid for Level controls or other driver-defined controls that have a minimum and maximum value.

The key in the IORgistry for the IOAudioControl minimum db value attribute.

#define kIOAudioLevelControlMinDBKey "IOAudioLevelControlMinDB" 

Discussion

The value returned by this key is a fixed point value in 16.16 format represented as a 32-bit integer. It represents the minimum value in db for the IOAudioControl. This value matches the minimum value attribute. This is currently valid for Level controls or other driver-defined controls that have a minimum and maximum db value.

The key in the IORegistry for the IOAudioControl minimum value attribute.

#define kIOAudioLevelControlMinValueKey "IOAudioLevelControlMinValue" 

Discussion

The value returned by this key is a 32-bit integer representing the minimum value for the IOAudioControl. This is currently only valid for Level controls or other driver-defined controls that have a minimum and maximum value.

The key in the IORegistry for the IOAudioPort name attribute.

#define kIOAudioPortNameKey "IOAudioPortName" 

The key in the IORegistry for the IOAudioPort subtype attribute.

#define kIOAudioPortSubTypeKey "IOAudioPortSubType" 

Discussion

The IOAudioPort subtype is a driver-defined text attribute designed to complement the type attribute.

The key in the IORegistry for the IOAudioPort type attribute.

#define kIOAudioPortTypeKey "IOAudioPortType" 

Discussion

This is a driver-defined text attribute that may contain any type. Common types are defined as: "Speaker", "Headphones", "Microphone", "CD", "Line", "Digital", "Mixer", "PassThru".

The key in the IORegistry for the IOAudioEngine sample rate attribute

#define kIOAudioSampleRateKey "IOAudioSampleRate" 

Discussion

This value is represented as an integer in samples per second.

The key in the IORegistry for the IOAudioStream direction attribute.

#define kIOAudioStreamDirectionKey "IOAudioStreamDirection" 

Discussion

The value for this key may be either "Output" or "Input".

The key in the IORegistry for the IOAudioStream output sample latency key

#define kIOAudioStreamSampleLatencyKey "IOAudioStreamSampleLatency" 

Discussion

Tells the HAL how much latency is on a particular stream. If two streams on the same engine have different latencies (e.g. one is analog, one is digital), then set this property on both streams to inform the HAL of the latency differences. Alternately, you can set the engine latency, and just include the latency additional to that for the particular stream. The HAL will add the engine and stream latency numbers together to get the total latency.

Last Updated: 2010-07-29