Function

AudioCodecGetPropertyInfo

Retrieves information about a codec property.

Declaration

OSStatus AudioCodecGetPropertyInfo(AudioCodec inCodec, AudioCodecPropertyID inPropertyID, UInt32 *outSize, Boolean *outWritable);

Parameters

inCodec

An audio codec object. Because an audio codec object is a Component Manger component instance, you can use the Component Manager (for example, the functions FindNextComponent and OpenAComponent) to obtain an audio codec object.

inPropertyID

Property ID of the property about which you want to obtain information. Codec property IDs are listed in Global Codec Properties and Instance Codec Properties.

outSize

On return, size in bytes of the current value of the property.

outWritable

Returns true if you can change the value of the property, otherwise false.

Return Value

Returns NoErr if successful, otherwise, a result code. See Result Codes for a list of possible values.

Discussion

Call this function to:

  • get the size of a property value before calling AudioCodecGetProperty to retrieve the value

  • find out if a property value can be modified before calling AudioCodecSetProperty to set the value

See Also