Mac Developer Library

Developer

IOAudioDefines.h Reference

Options
Deployment Target:

On This Page

IOAudioDefines.h Reference

Constants

See the Overview section above for header-level documentation.

  • Declaration

    #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 value for this key is an integer which may be driver defined. Default values for common channel types are provided in the following defines.

    • 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

      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.

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

    • kIOAudioControlValueIsReadOnlyKey

      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

    • kIOAudioControlValueKey

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

    • 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 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 value for this key may be one of: "Running", "Stopped" or "Paused". Currently the "Paused" state is unimplemented.

    • kIOAudioLevelControlMaxDBKey

      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.

    • kIOAudioLevelControlMaxValueKey

      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.

    • kIOAudioLevelControlMinDBKey

      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.

    • kIOAudioLevelControlMinValueKey

      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.

    • kIOAudioPortNameKey

      The key in the IORegistry for the IOAudioPort name attribute.

    • kIOAudioPortSubTypeKey

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

    • kIOAudioPortTypeKey

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

    • kIOAudioSampleRateKey

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

    • kIOAudioStreamDirectionKey

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

    • kIOAudioStreamSampleLatencyKey

      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.