Functions



AudioHardwareClaimAudioDeviceID


Reserve a new AudioDeviceID.
extern OSStatus AudioHardwareClaimAudioDeviceID (
    AudioHardwarePlugInRef inOwner,
    AudioDeviceID* outAudioDeviceID
)                       AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
Parameter Descriptions
inOwner
The plug-in instance requesting the new AudioDeviceID.
outAudioDeviceID
On exit, the new AudioDeviceID.
function result
An OSStatus indicating success or failure.

AudioHardwareClaimAudioStreamID


Reserve a new AudioStreamID.
extern OSStatus AudioHardwareClaimAudioStreamID (
    AudioHardwarePlugInRef inOwner,
    AudioDeviceID inOwningDeviceID,
    AudioStreamID* outAudioStreamID
)                       AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
Parameter Descriptions
inOwner
The plug-in instance requesting the new AudioStreamID.
inOwningDeviceID
The AudioDeviceID of the AudioDevice that is to own the AudioStream.
outAudioStreamID
On exit, the new AudioStreamID.
function result
An OSStatus indicating success or failure.

AudioHardwareDevicePropertyChanged


Tell the HAL that the property of an AudioDevice owned by the plug-in has changed.
extern OSStatus AudioHardwareDevicePropertyChanged (
    AudioHardwarePlugInRef inOwner,
    AudioDeviceID inDeviceID,
    UInt32 inChannel,
    Boolean isInput,
    AudioDevicePropertyID inPropertyID
)                           AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
Discussion

The HAL will take care of calling any registered listeners.

Parameter Descriptions
inOwner
The plug-in instance that owns the AudioDevice whose property has changed.
inDeviceID
The AudioDeviceID of the AudioDevice whose property has changed.
inChannel
The channel of the AudioDevice whose property has changed.
isInput
The section of the AudioDevice whose proeprty has changed.
inPropertyID
The AudioObjectPropertySelector of the property that changed.
function result
An OSStatus indicating success or failure.

AudioHardwareDevicesCreated


Tell the HAL that new AudioDevices have come into being.
extern OSStatus AudioHardwareDevicesCreated (
    AudioHardwarePlugInRef inOwner,
    UInt32 inNumberDevices,
    const AudioDeviceID* inAudioDeviceIDs
)                           AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
Discussion

The plug-in must have previously reserved the AudioDeviceIDs using AudioHardwareClaimAudioDeviceID().

Parameter Descriptions
inOwner
The plug-in instance that owns the new AudioDevices.
inNumberDevices
The number of items in the inAudioDeviceIDs array.
inAudioDeviceIDs
An array of AudioDeviceIDs that refer to the new AudioDevices.
function result
An OSStatus indicating success or failure.

AudioHardwareDevicesDied


Tell the HAL that some AudioDevices have gone away.
extern OSStatus AudioHardwareDevicesDied (
    AudioHardwarePlugInRef inOwner,
    UInt32 inNumberDevices,
    const AudioDeviceID* inAudioDeviceIDs
)                               AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
Parameter Descriptions
inOwner
The plug-in instance that owns the dead AudioDevices.
inNumberDevices
The number of items in the inAudioDeviceIDs array.
inAudioDeviceIDs
An array of AudioDeviceIDs that refer to the dead AudioDevices.
function result
An OSStatus indicating success or failure.

AudioHardwareStreamPropertyChanged


Tell the HAL that the property of an AudioStream owned by the plug-in has changed.
extern OSStatus AudioHardwareStreamPropertyChanged (
    AudioHardwarePlugInRef inOwner,
    AudioDeviceID inOwningDeviceID,
    AudioStreamID inStreamID,
    UInt32 inChannel,
    AudioDevicePropertyID inPropertyID
)                           AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
Discussion

The HAL will take care of calling any registered listeners.

Parameter Descriptions
inOwner
The plug-in instance that owns the AudioStream whose property has changed.
inOwningDeviceID
The AudioDeviceID of the AudioDevice that owns the AudioStream.
inStreamID
The AudioStreamID of the AudioStream whose property has changed.
inChannel
The channel of the AudioStream whose property has changed.
inPropertyID
The AudioObjectPropertySelector of the property that changed.
function result
An OSStatus indicating success or failure.

AudioHardwareStreamsCreated


Tell the HAL that new AudioStreams have come into being.
extern OSStatus AudioHardwareStreamsCreated (
    AudioHardwarePlugInRef inOwner,
    AudioDeviceID inOwningDeviceID,
    UInt32 inNumberStreams,
    const AudioStreamID* inAudioStreamIDs
)                           AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
Discussion

The plug-in must have previously reserved the AudioStreamIDs using AudioHardwareClaimAudioStreamID().

Parameter Descriptions
inOwner
The plug-in instance that owns the new AudioStreams.
inOwningDeviceID
The AudioDeviceID of the AudioDevice that owns the AudioStreams.
inNumberStreams
The number of items in the inAudioStreamIDs array.
inAudioStreamIDs
An array of AudioStreamIDs that refer to the new AudioStreams.
function result
An OSStatus indicating success or failure.

AudioHardwareStreamsDied


Tell the HAL that some AudioStreams have gone away.
extern OSStatus AudioHardwareStreamsDied (
    AudioHardwarePlugInRef inOwner,
    AudioDeviceID inOwningDeviceID,
    UInt32 inNumberStreams,
    const AudioStreamID* inAudioStreamIDs
)                               AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
Parameter Descriptions
inOwner
The plug-in instance that owns the dead AudioStreams.
inOwningDeviceID
The AudioDeviceID of the AudioDevice that owns the AudioStreams.
inNumberDevices
The number of items in the inAudioStreamIDs array.
inAudioStreamIDs
An array of AudioStreamIDs that refer to the dead AudioStreams.
function result
An OSStatus indicating success or failure.

AudioObjectCreate


Instantiates a new AudioObject.
extern OSStatus AudioObjectCreate (
    AudioHardwarePlugInRef inOwningPlugIn,
    AudioObjectID inOwningObjectID,
    AudioClassID inClassID,
    AudioObjectID* outAudioObjectID
)                                       AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
Discussion

Newly instantiated AudioObjects are not made available to the HAL's clients until the object is published using AudioObjectsPublishedAndDied().

Parameter Descriptions
inOwningPlugIn
The plug-in instance instantiating the new AudioObject.
inOwningObjectID
The AudioObjectID of the AudioObject that owns the new AudioObject.
inClassID
The ID of the class of the new AudioObject.
outAudioObjectID
On exit, the AudioObjectID of the new AudioObject.
function result
An OSStatus indicating success or failure.

AudioObjectPropertiesChanged


Tell the HAL that properties have changed on the given AudioObject.
extern OSStatus AudioObjectPropertiesChanged (
    AudioHardwarePlugInRef inOwningPlugIn,
    AudioObjectID inObjectID,
    UInt32 inNumberAddresses,
    const AudioObjectPropertyAddress inAddresses[]
)                  AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
Discussion

The HAL will take care of calling any registered listeners.

Parameter Descriptions
inOwningPlugIn
The plug-in instance that owns the AudioObject whose properties have changed.
inObjectID
The AudioObjectID of the AudioObject whose properties have changed.
inNumberAddresses
The number of items in the inAddresses array.
inAddresses
An array of AudioObjectPropertyAddress structs indicating which properties of the device have changed.
function result
An OSStatus indicating success or failure.

AudioObjectsPublishedAndDied


Tell the HAL to publish some AudioObjects and tear down others.
extern OSStatus AudioObjectsPublishedAndDied (
    AudioHardwarePlugInRef inOwningPlugIn,
    AudioObjectID inOwningObjectID,
    UInt32 inNumberPublishedAudioObjects,
    const AudioObjectID inPublishedAudioObjects[],
    UInt32 inNumberDeadAudioObjects,
    const AudioObjectID inDeadAudioObjects[]
)                       AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
Discussion

Note that all the objects must be owned by inOwningObjectID.

Parameter Descriptions
inOwningPlugIn
The plug-in instance that owns the AudioObjects.
inOwningObjectID
The AudioObjectID of the AudioObject that owns the objects being published or destroyed.
inNumberPublishedAudioObjects
The number of items in the inPublishedAudioObjects array.
inPublishedAudioObjects
An array of AudioObjectIDs for the AudioObjects that are to be made available to the HAL's clients.
inNumberDeadAudioObjects
The number of items in the inDeadAudioObjects array.
inDeadAudioObjects
An array of AudioObjectIDs for the AudioObjects that are no longer available.
function result
An OSStatus indicating success or failure.

(Last Updated 12/13/2004)