Reads packets of audio data from an audio file.
- iOS 2.2+
- macOS 10.6+
- Mac Catalyst 13.0+
- tvOS 9.0+
The audio file whose audio packets you want to read.
trueto cache the data. Otherwise, set to
On input, the size of the
outparameter, in bytes. On output, the number of bytes actually read.
You will see a difference in the input and output values if the byte size for the number of packets you request in the
ioparameter is smaller than the buffer size you pass in the
outparameter. In this case, the output value for this parameter is smaller than its input value.
On output, an array of packet descriptions for the packets that were read. The array that you pass in this parameter must be large enough to accommodate descriptions for the number of packets requested in the
This parameter applies only to variable bit-rate data. If the file being read contains constant bit-rate (CBR) data, such as linear PCM, this parameter does not get filled. Pass
NULLif the file’s data format is CBR.
The packet index of the first packet you want to read.
On input, the number of packets to read. On output, the number of packets actually read.
Memory that you allocate to hold the read packets. Determine an appropriate size by multiplying the number of packets requested (in the
ioparameter) by the typical packet size for the audio data in the file. For uncompressed audio formats, a packet is equal to a frame.
A result code. See Result Codes.
Using this function is memory efficient when reading variable bit-rate (VBR) audio data, whose packet sizes can vary for a given duration of sound.
If the buffer you provide in the
out parameter is too small to hold the packets you request in
io, the output values of
io are reduced to reflect the packets that were placed into the buffer. You also see a difference in the input and output values for
io when this function has reached the end of the file you are reading. In this case, the output value for this parameter is smaller than its input value.
This function is more efficient than
Audio when reading compressed file formats that do not have packet tables, such as MP3 or ADTS. This function is a good choice for reading either CBR (constant bit-rate) or VBR data if you do not need to read a fixed duration of audio. If you do need to read a fixed duration of audio, whether CBR or VBR, use
Audio File Services reads one 32-bit chunk of a file at a time.