Enumeration

Audio Queue Parameters

Identifiers for audio queue parameters.

Declaration

enum : AudioQueueParameterID {
    ...
};

Overview

These parameters apply only to playback audio queues. You can set a playback audio queue parameter in one of two ways:

  • Set the value to take effect immediately using the AudioQueueSetParameter function.

  • Schedule a value to take effect when a particular audio queue buffer plays. You supply the parameter when you enqueue the buffer. The new value is applied to the audio queue that owns the buffer when that buffer is rendered.

The AudioQueueGetParameter function always returns the current value of the parameter for an audio queue.

Topics

Constants

kAudioQueueParam_Volume

The playback volume for the audio queue, ranging from 0.0 through 1.0 on a linear scale. A value of 0.0 indicates silence; a value of 1.0 (the default) indicates full volume for the audio queue instance.

kAudioQueueParam_PlayRate

The playback rate for the audio queue, in the range 0.5 through 2.0. A value of 1.0 (the default) specifies that the audio queue should play at its normal rate.

kAudioQueueParam_Pitch

The number of cents to pitch-shift the audio queue’s playback, in the range -2400 through 2400 cents (where 1200 cents corresponds to one musical octave.)

kAudioQueueParam_VolumeRampTime

The number of seconds over which a volume change is ramped.

kAudioQueueParam_Pan

The stereo panning position of a source. For a monophonic source, panning is determined as follows: