Function

AudioFileGetUserDataSize

Gets the size of a user data item in an audio file.

Declaration

OSStatus AudioFileGetUserDataSize(AudioFileID inAudioFile, UInt32 inUserDataID, UInt32 inIndex, UInt32 *outUserDataSize);

Parameters

inAudioFile

The audio file whose user data item size you want.

inUserDataID

The four-character code of the designated user data item.

inIndex

An index specifying which user data item with the four-character code specified in the inUserDataID parameter you want to query.

outUserDataSize

On output, a pointer the size of the user data item.

Return Value

A result code. See Result Codes.

Discussion

In the context of this function, user data refers to chunks in AIFF, CAF, and WAVE files, to resources in Sound Designer II files, and possibly to other types of information in other files.

See Also

Working with User Data

AudioFileCountUserData

Gets the number of user data items with a specified ID in a file.

AudioFileRemoveUserData

Removes a user data item from an audio file.

AudioFileSetUserData

Sets a user data item in an audio file.

AudioFileGetUserData

Gets a chunk from an audio file.