Function

AudioSessionGetProperty

Gets the value of a specified audio session property.

Declaration

OSStatus AudioSessionGetProperty(AudioSessionPropertyID inID, UInt32 *ioDataSize, void *outData);

Parameters

inID

The identifier for the audio session property that you want to get the value of.

ioDataSize

On input, the memory size for the outData parameter. On output, the actual size of the property value.

outData

On output, the value of the specified audio session property.

Return Value

A result code. See Result Codes.

Discussion

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

Special Considerations

Some Core Audio property values are C types and others are Core Foundation objects.

If you call this function to retrieve a value that is a Core Foundation object, then this function—despite the use of “Get” in its name—duplicates the object. You are responsible for releasing the object, as described in The Create Rule in Memory Management Programming Guide for Core Foundation.

See Also

Using Audio Session Properties

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
AudioSessionAddPropertyListener

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

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