IOAudioDefines.h Reference

Declared in
IOAudioDefines.h

Overview

Constants

See the Overview section above for header-level documentation.

Miscellaneous Defines

   
#define kIOAudioControlChannelIDKey "IOAudioControlChannelID"
#define kIOAudioControlChannelNameAll "All Channels"
#define kIOAudioControlChannelNameCenter "Center"
#define kIOAudioControlChannelNameFrontLeftCenter "FrontLeftCenter"
#define kIOAudioControlChannelNameFrontRightCenter "FrontRightCenter"
#define kIOAudioControlChannelNameKey "IOAudioControlChannelName"
#define kIOAudioControlChannelNameLeft "Left"
#define kIOAudioControlChannelNameLeftRear "LeftRear"
#define kIOAudioControlChannelNameRearCenter "RearCenter"
#define kIOAudioControlChannelNameRight "Right"
#define kIOAudioControlChannelNameRightRear "RightRear"
#define kIOAudioControlChannelNameSub "Sub"
#define kIOAudioControlChannelNameSurroundLeft "SurroundLeft"
#define kIOAudioControlChannelNameSurroundRight "SurroundRight"
#define kIOAudioControlTypeKey "IOAudioControlType"
#define kIOAudioControlValueIsReadOnlyKey "IOAudioControlValueIsReadOnly"
#define kIOAudioControlValueKey "IOAudioControlValue"
#define kIOAudioDeviceIconNameKey "IOAudioDeviceIconName"
#define kIOAudioDeviceIconNameKey "IOAudioDeviceIconName"
#define kIOAudioDeviceManufacturerNameKey "IOAudioDeviceManufacturerName"
#define kIOAudioDeviceNameKey "IOAudioDeviceName"
#define kIOAudioEngineFullChannelCategoryNamesKey "IOAudioEngineChannelCategoryNames"
#define kIOAudioEngineFullChannelNamesKey "IOAudioEngineChannelNames"
#define kIOAudioEngineFullChannelNumberNamesKey "IOAudioEngineChannelNumberNames"
#define kIOAudioEngineFullChannelNumberNamesKey "IOAudioEngineChannelNumberNames"
#define kIOAudioEngineOutputSampleLatencyKey "IOAudioEngineOutputSampleLatency"
#define kIOAudioEngineStateKey "IOAudioEngineState"
#define kIOAudioLevelControlMaxDBKey "IOAudioLevelControlMaxDB"
#define kIOAudioLevelControlMaxValueKey "IOAudioLevelControlMaxValue"
#define kIOAudioLevelControlMinDBKey "IOAudioLevelControlMinDB"
#define kIOAudioLevelControlMinValueKey "IOAudioLevelControlMinValue"
#define kIOAudioPortNameKey "IOAudioPortName"
#define kIOAudioPortSubTypeKey "IOAudioPortSubType"
#define kIOAudioPortTypeKey "IOAudioPortType"
#define kIOAudioSampleRateKey "IOAudioSampleRate"
#define kIOAudioStreamDirectionKey "IOAudioStreamDirection"
#define kIOAudioStreamSampleLatencyKey "IOAudioStreamSampleLatency"
Constants
kIOAudioControlChannelIDKey

The key in the IORegistry for the IOAudioControl channel ID attribute

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.

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioControlChannelNameAll

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

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioControlChannelNameCenter

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

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioControlChannelNameFrontLeftCenter

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

Available in OS X v10.6 and later.

Declared in IOAudioDefines.h.

kIOAudioControlChannelNameFrontRightCenter

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

Available in OS X v10.6 and later.

Declared in IOAudioDefines.h.

kIOAudioControlChannelNameKey

The key in the IORegistry for the IOAudioControl name attribute.

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.

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioControlChannelNameLeft

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

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioControlChannelNameLeftRear

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

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioControlChannelNameRearCenter

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

Available in OS X v10.6 and later.

Declared in IOAudioDefines.h.

kIOAudioControlChannelNameRight

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

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioControlChannelNameRightRear

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

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioControlChannelNameSub

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

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioControlChannelNameSurroundLeft

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

Available in OS X v10.6 and later.

Declared in IOAudioDefines.h.

kIOAudioControlChannelNameSurroundRight

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

Available in OS X v10.6 and later.

Declared in IOAudioDefines.h.

kIOAudioControlTypeKey

The key in the IORegistry for the IOAudioCntrol type attribute.

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".

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioControlValueIsReadOnlyKey

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

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

Available in OS X v10.2 and later.

Declared in IOAudioDefines.h.

kIOAudioControlValueKey

The key in the IORegistry for the IOAudioControl value attribute.

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

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioDeviceIconName

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

kIOAudioDeviceIconNameKey

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

Available in OS X v10.5 and later.

Declared in IOAudioDefines.h.

kIOAudioDeviceManufacturerNameKey

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

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioDeviceNameKey

The key in the IORegistry for the IOAudioDevice name attribute.

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioEngineFullChannelCategoryNamesKey

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

Available in OS X v10.2 and later.

Declared in IOAudioDefines.h.

kIOAudioEngineFullChannelNamesKey

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

Available in OS X v10.2 and later.

Declared in IOAudioDefines.h.

kIOAudioEngineFullChannelNamesKey

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

Available in OS X v10.2 and later.

Declared in IOAudioDefines.h.

kIOAudioEngineFullChannelNumberNamesKey

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

Available in OS X v10.2 and later.

Declared in IOAudioDefines.h.

kIOAudioEngineOutputSampleLatencyKey

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

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioEngineStateKey

The key in the IORegistry for the IOAudioEngine state atrribute

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

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioLevelControlMaxDBKey

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

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.

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioLevelControlMaxValueKey

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

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.

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioLevelControlMinDBKey

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

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.

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioLevelControlMinValueKey

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

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.

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioPortNameKey

The key in the IORegistry for the IOAudioPort name attribute.

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioPortSubTypeKey

The key in the IORegistry for the IOAudioPort subtype attribute.

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

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioPortTypeKey

The key in the IORegistry for the IOAudioPort type attribute.

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".

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioSampleRateKey

The key in the IORegistry for the IOAudioEngine sample rate attribute

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

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioStreamDirectionKey

The key in the IORegistry for the IOAudioStream direction attribute.

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

Available in OS X v10.1 and later.

Declared in IOAudioDefines.h.

kIOAudioStreamSampleLatencyKey

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

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.

Available in OS X v10.3 and later.

Declared in IOAudioDefines.h.