SND_SetPlayerVolume

C Specification

#include <nitro/snd.h>
void SND_SetPlayerVolume( int playerNo, int volume );

Arguments

playerNo The Player number. Takes a value between 0 and 15.
volume The volume. Set in units of 0.1dB, takes a value between -723 and 0.

Return Values

None.

Description

Changes the volume of the sequence being played by the Player specified by playerNo.

This volume value affects the overall sequence. To change the volume of individual tracks, use the SND_SetTrackVolume function.

Caution

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_SetTrackVolume, SND_FlushCommand, SND_GetCurrentCommandTag, SND_IsFinishedCommandTag, SND_WaitForCommandProc

Revision History

02/17/2005 Added a note about ARM7 command processing
07/01/2004 Initial version