Function

AudioSessionAddPropertyListener

Adds a property listener callback function to your application’s audio session object.

Declaration

OSStatus AudioSessionAddPropertyListener(AudioSessionPropertyID inID, AudioSessionPropertyListener inProc, void *inClientData);

Parameters

inID

The identifier for the audio session property whose value changes you want to listen for.

inProc

The name of your property listener callback function.

inClientData

Data that you would like to be passed to your property listener callback.

Return Value

A result code. See Result Codes.

Discussion

When an audio session property value changes, and you have added a listener callback for that property, the audio session object invokes the callback.

You can add exactly one listener callback for a given inID-inClientData pair. In other words, you can add more than one property listener callback function for a given audio session property, provided you pass a unique inClientData parameter value each time you add a property listener.

Audio session properties are listed and described in Audio Session Property Identifiers.

See Also

Using Audio Session Properties

AudioSessionGetProperty

Gets the value of a specified audio session property.

Deprecated
AudioSessionSetProperty

Sets the value of a specified audio session property.

Deprecated
AudioSessionGetPropertySize

Gets the size of the value for a specified audio session property.

Deprecated
AudioSessionRemovePropertyListenerWithUserData

Removes a property listener callback function from your application’s audio session object.

Deprecated
AudioSessionRemovePropertyListener

Removes an audio session property listener callback function.

Deprecated