Methods


-AudioFileGetUserDataSize
Get the size of user data in a file
-AudioFileGetUserData
Get the data of a chunk in a file.
-AudioFileSetUserData
Set the data of a chunk in a file.
-AudioFileGetPropertyInfo
Get information about the size of a property of an AudioFile and whether it can be set.
-AudioFileGetProperty
Copies the value for a property of an AudioFile into a buffer.
-AudioFileSetProperty
Sets the value for a property of an AudioFile .
-AudioFileGetGlobalInfoSize
Get information about the size of a global property.
-AudioFileGetGlobalInfo
Copies the value for a global property into a buffer.

AudioFileGetUserDataSize


Get the size of user data in a file

extern OSStatus AudioFileGetUserDataSize ( AudioFileID inAudioFile, UInt32 inUserDataID, UInt32 inIndex, UInt32 *outUserDataSize); 
Parameter Descriptions
inAudioFile
an AudioFileID.
inUserDataID
the four char code of the chunk.
inIndex
an index specifying which chunk if there are more than one.
outUserDataSize
on output, if successful, the size of the user data chunk.
Availability
Introduced in Mac OS X 10.4.

AudioFileGetUserData


Get the data of a chunk in a file.

extern OSStatus AudioFileGetUserData ( AudioFileID inAudioFile, UInt32 inUserDataID, UInt32 inIndex, UInt32 *ioUserDataSize, void *outUserData); 
Parameter Descriptions
inAudioFile
an AudioFileID.
inUserDataID
the four char code of the chunk.
inIndex
an index specifying which chunk if there are more than one.
ioUserDataSize
the size of the buffer on input, size of bytes copied to buffer on output
outUserData
a pointer to a buffer in which to copy the chunk data.
Availability
Introduced in Mac OS X 10.4.

AudioFileSetUserData


Set the data of a chunk in a file.

extern OSStatus AudioFileSetUserData ( AudioFileID inAudioFile, UInt32 inUserDataID, UInt32 inIndex, UInt32 inUserDataSize, const void *inUserData); 
Parameter Descriptions
inAudioFile
an AudioFileID.
inUserDataID
the four char code of the chunk.
inIndex
an index specifying which chunk if there are more than one.
inUserDataSize
on input the size of the data to copy, on output, size of bytes copied from the buffer
inUserData
a pointer to a buffer from which to copy the chunk data (only the contents of the chunk, not including the chunk header).
Availability
Introduced in Mac OS X 10.4.

AudioFileGetPropertyInfo


Get information about the size of a property of an AudioFile and whether it can be set.

extern OSStatus AudioFileGetPropertyInfo( AudioFileID inAudioFile, AudioFilePropertyID inPropertyID, UInt32 *outDataSize, UInt32 *isWritable); 
Parameter Descriptions
inAudioFile
an AudioFileID.
inPropertyID
an AudioFileProperty constant.
outDataSize
the size of the property data. In order to get the property value, you will need a buffer of this size.
isWritable
will be set to 1 if writable, or 0 if read only.
Discussion

(description)

Availability
Introduced in Mac OS X 10.2

AudioFileGetProperty


Copies the value for a property of an AudioFile into a buffer.

extern OSStatus AudioFileGetProperty( AudioFileID inAudioFile, AudioFilePropertyID inPropertyID, UInt32 *ioDataSize, void *outPropertyData); 
Parameter Descriptions
inAudioFile
an AudioFileID.
inPropertyID
an AudioFileProperty constant.
ioDataSize
on input the size of the outPropertyData buffer. On output the number of bytes written to the buffer.
outPropertyData
the buffer in which to write the property data.
Availability
Introduced in Mac OS X 10.2

AudioFileSetProperty


Sets the value for a property of an AudioFile .

extern OSStatus AudioFileSetProperty( AudioFileID inAudioFile, AudioFilePropertyID inPropertyID, UInt32 inDataSize, const void *inPropertyData); 
Parameter Descriptions
inAudioFile
an AudioFileID.
inPropertyID
an AudioFileProperty constant.
inDataSize
the size of the property data.
inPropertyData
the buffer containing the property data.
Availability
Introduced in Mac OS X 10.2

AudioFileGetGlobalInfoSize


Get information about the size of a global property.

extern OSStatus AudioFileGetGlobalInfoSize( AudioFilePropertyID inPropertyID, UInt32 inSpecifierSize, void *inSpecifier, UInt32 *outDataSize); 
Parameter Descriptions
inPropertyID
an AudioFileGlobalInfo property constant.
inSpecifierSize
The size of the specifier data.
inSpecifier
A specifier is a buffer of data used as an input argument to some of the global info properties.
outDataSize
the size of the property data. In order to get the property value, you will need a buffer of this size.
Availability
Introduced in Mac OS X 10.3.

AudioFileGetGlobalInfo


Copies the value for a global property into a buffer.

extern OSStatus AudioFileGetGlobalInfo( AudioFilePropertyID inPropertyID, UInt32 inSpecifierSize, void *inSpecifier, UInt32 *ioDataSize, void *outPropertyData); 
Parameter Descriptions
inPropertyID
an AudioFileGlobalInfo property constant.
inSpecifierSize
The size of the specifier data.
inSpecifier
A specifier is a buffer of data used as an input argument to some of the global info properties.
ioDataSize
on input the size of the outPropertyData buffer. On output the number of bytes written to the buffer.
outPropertyData
the buffer in which to write the property data.
Availability
Introduced in Mac OS X 10.3.

(Last Updated April 06, 2005)