SND_SetMasterPan

C Specification

#include <nitro/snd.h>
void SND_SetMasterPan( int pan );

Arguments

pan The value of the master pan. Takes values in the range of 0 (left) to 64 (center) to 127 (right).

Return Values

None.

Description

Sets the master pan.

By setting the master pan, the pan setting for each channel is ignored. All sounds are set to the stereo position of pan.

To disable the master pan, call the SND_ResetMasterPan function.

Caution

If this function is called while sound is being played, noise may be generated when the master pan is switched.

This function is an ARM7 reserved function. After this function is called, processing occurs only after the command is issued with the SND_FlushCommand function.

When it is necessary to synchronize something with the completion of the process, first use SND_GetCurrentCommandTag to obtain the command tag immediately after calling this function. After the command is issued, use the command tag and call either the SND_IsFinishedCommandTag or SND_WaitForCommandProc function to confirm that the process has finished or to wait for it to complete.

See Also

SND_ResetMasterPan, SND_FlushCommand, SND_GetCurrentCommandTag, SND_IsFinishedCommandTag, SND_WaitForCommandProc

Revision History

02/17/2005 Added a note about ARM7 command processing
10/05/2004 Initial version