Enumeration

Anonymous

No overview available.

Declaration

enum : AudioQueuePropertyID {
    ...
};

Topics

Constants

kAudioQueueDeviceProperty_NumberChannels

Value is a read-only UInt32 value representing the number of channels in the audio hardware device associated with an audio queue.

kAudioQueueDeviceProperty_SampleRate

Value is a read-only Float64 value representing the sampling rate of the audio hardware device associated with an audio queue.

kAudioQueueProperty_ChannelLayout

Value is a read/write AudioChannelLayout structure that describes an audio queue channel layout. The number of channels in the layout must match the number of channels in the audio format. This property is typically not used in the case of one or two channel audio. For more than two channels (such as in the case of 5.1 surround sound), you may need to specify a channel layout to indicate channel order, such as left, then center, then right.

kAudioQueueProperty_ConverterError

Value is a read-only UInt32 value that indicates the most recent error (if any) encountered by the audio queue’s internal encoding/decoding process.

kAudioQueueProperty_CurrentDevice

Value is a read-write CFStringRef object representing the unique identifier (UID) of the audio hardware device associated with an audio queue.

kAudioQueueProperty_CurrentLevelMeter

Value is a read-only array of AudioQueueLevelMeterState structures, one array element per audio channel. The member values in the structure are in the range 0 (for silence) to 1 (indicating maximum level).

kAudioQueueProperty_CurrentLevelMeterDB

Value is a read-only array of AudioQueueLevelMeterState structures, one array element per audio channel. The member values in the structure are in decibels.

kAudioQueueProperty_DecodeBufferSizeFrames

Value is a read/write UInt32 value that is the size of the buffer into which a playback (output) audio queue decodes buffers. A larger buffer provides more reliability and better long-term performance at the expense of memory and decreased responsiveness in some situations.

kAudioQueueProperty_EnableLevelMetering

Value is a read/write UInt32 value that indicates whether audio level metering is enabled for an audio queue. 0 = metering off, 1 = metering on.

kAudioQueueProperty_IsRunning

Value is a read-only UInt32 value indicating whether or not the audio queue is running. A nonzero value means running; 0 means stopped. A notification is sent when the associated audio queue starts or stops, which may occur sometime after the AudioQueueStart or AudioQueueStop function is called.

kAudioQueueProperty_MagicCookie

Value is a read/write void pointer to a block of memory, which you set up, containing an audio format magic cookie. If the audio format you are playing or recording to requires a magic cookie, you must set a value for this property before enqueuing any buffers.

kAudioQueueProperty_MaximumOutputPacketSize

Value is a read-onlyUInt32 value that is the size, in bytes, of the largest single packet of data in the output format. Primarily useful when encoding VBR compressed data.

kAudioQueueProperty_StreamDescription

Value is a read-only AudioStreamBasicDescription structure, indicating an audio queue’s data format. Primarily useful for obtaining a complete ASBD when recording, in cases where you initially specify a sample rate of 0.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software