AudioSessionGetProperty(_:_:_:)

Declaration

func AudioSessionGetProperty(_ inID: AudioSessionPropertyID, _ ioDataSize: UnsafeMutablePointer<UInt32>!, _ outData: UnsafeMutableRawPointer!) -> OSStatus

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

Related Documentation

• AudioSessionGetPropertySize(_:_:)
• AudioSessionSetProperty(_:_:_:)

Functions

• AudioFileReadPackets(_:_:_:_:_:_:_:)
• AudioComponentGetIcon(_:_:)
• AudioComponentGetLastActiveTime(_:)
• AudioHardwareServiceAddPropertyListener(_:_:_:_:)
• AudioHardwareServiceGetPropertyData(_:_:_:_:_:_:)
• AudioHardwareServiceGetPropertyDataSize(_:_:_:_:_:)
• AudioHardwareServiceHasProperty(_:_:)
• AudioHardwareServiceIsPropertySettable(_:_:_:)
• AudioHardwareServiceRemovePropertyListener(_:_:_:_:)
• AudioHardwareServiceSetPropertyData(_:_:_:_:_:_:)
• AudioOutputUnitGetHostIcon(_:_:)
• AudioOutputUnitPublish(_:_:_:_:)
• AudioSessionAddPropertyListener(_:_:_:)
• AudioSessionGetPropertySize(_:_:)
• AudioSessionInitialize(_:_:_:_:)