Copies the value of a global property into a buffer.
SDKs
- iOS 2.0+
- macOS 10.3+
- Mac Catalyst 13.0+
- tvOS 9.0+
Framework
- Audio
Toolbox
Declaration
OSStatus AudioFileGetGlobalInfo(AudioParameters
inPropertyIDThe property whose value you want to get. For possible values, see Audio File Global Info Properties.
inSpecifierSizeThe size of the specifier data.
inSpecifierA pointer to a specifier, which, in this context, is a pointer to a buffer containing some data that is different for each property. The type of the data required is described in the description of each property.
ioDataSizeOn input, a pointer to the size of the buffer specified in the outPropertyData
parameter. On output, a pointer to the number of bytes written to the buffer.outPropertyDataA pointer to the buffer in which to write the property data.
Return Value
A result code. See Result Codes.
Discussion
This function can be used to get information about the capabilities of Audio File Services data types, for example, to determine which file types can take which data formats, what file types are supported, what file type can hold a particular data type, and so forth. This function cannot be used to get information about the properties of particular files. So the properties whose information you are obtaining are global to the Audio File Services programming interface, not properties specific to any file.
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.