Contents

AudioQueueAllocateBufferWithPacketDescriptions(_:_:_:_:)

Asks an audio queue object to allocate an audio queue buffer with space for packet descriptions.

Declaration

func AudioQueueAllocateBufferWithPacketDescriptions(_ inAQ: AudioQueueRef, _ inBufferByteSize: UInt32, _ inNumberPacketDescriptions: UInt32, _ outBuffer: UnsafeMutablePointer<AudioQueueBufferRef?>) -> OSStatus

Parameters

  • inAQ:

    The audio queue you want to allocate a buffer.

  • inBufferByteSize:

    The desired data capacity of the new buffer, in bytes. Appropriate capacity depends on the processing you will perform on the data as well as on the audio data format.

  • inNumberPacketDescriptions:

    The desired size of the packet description array in the new audio queue buffer.

  • outBuffer:

    On output, points to the newly allocated audio queue buffer.

Return Value

A result code. See Result Codes.

Discussion

Use this function when allocating an audio queue buffer for use with a VBR compressed data format.

Once allocated, the pointer to the audio queue buffer and the buffer’s capacity cannot be changed. The buffer’s size field, mAudioDataByteSize, which indicates the amount of valid data, is initially set to 0.

See Also

Handling Audio Queue Buffers