Struct AudioQueueBuffer

#[repr(C)]
pub struct AudioQueueBuffer {
    pub mAudioDataBytesCapacity: u32,
    pub mAudioData: NonNull<c_void>,
    pub mAudioDataByteSize: u32,
    pub mUserData: *mut c_void,
    pub mPacketDescriptionCapacity: u32,
    pub mPacketDescriptions: *const AudioStreamPacketDescription,
    pub mPacketDescriptionCount: u32,
}

Available on crate features AudioQueue and objc2-core-audio-types only.

Defines a buffer of audio data to be managed by an audio queue.

Each audio queue has an associated set of audio queue buffers. You can request that a queue allocate buffers using the AudioQueueAllocateBuffer function and dispose of them using the AudioQueueFreeBuffer function.

You may also use AudioQueueAllocateBufferWithPacketDescriptions to allocate buffers with space for AudioPacketDescriptions, as used in VBR formats. The mPacketDescriptionCapacity, mmPacketDescriptions, and mPacketDescriptionCount fields may only be used with buffers allocated with this function.

The size of the buffer, in bytes. This size is set when the buffer is allocated and cannot be changed.

A pointer to the audio data in the buffer. Although you can write data to this buffer, you cannot make it point to another address.

The number of bytes of valid audio data in the buffer. You set this value when providing data for playback; the audio queue sets this value when recording data from a recording queue.

A value you may specify to identify the buffer when it is passed back in recording or playback callback functions.

The maximum number of packet descriptions that can be stored in mPacketDescriptions.

An array of AudioStreamPacketDescriptions associated with the buffer.

The number of valid packet descriptions in the buffer. You set this value when providing buffers for playback; the audio queue sets this value when returning buffers from a recording queue.

See also Apple’s documentation

Fields

mAudioDataBytesCapacity: u32

mAudioData: NonNull<c_void>

mAudioDataByteSize: u32

mUserData: *mut c_void

mPacketDescriptionCapacity: u32

mPacketDescriptions: *const AudioStreamPacketDescription

mPacketDescriptionCount: u32

Trait Implementations

impl Clone for AudioQueueBuffer

fn clone(&self) -> AudioQueueBuffer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AudioQueueBuffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Encode for AudioQueueBuffer

const ENCODING: Encoding

The Objective-C type-encoding for this type.

impl PartialEq for AudioQueueBuffer

fn eq(&self, other: &AudioQueueBuffer) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for AudioQueueBuffer

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Copy for AudioQueueBuffer

impl StructuralPartialEq for AudioQueueBuffer