SND_SetTrackVolume

Syntax

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

Arguments

playerNo The player number. Takes a value between 0 and 15.
trackBitMask This is the track bit mask. It designates which track to use.
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 tracks of the sequence being played by the Player specified by playerNo.

The track bit mask, trackBitMask, designates which track to use. Each bit expresses a track in descending order track 0 as the lowest bit. Operations are performed only on tracks with active bits.

This volume value affects individual tracks. To change the volume of the entire sequence, use the SND_SetPlayerVolume function.

Note

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

If program execution must be synchronized with process completion, first use the SND_GetCurrentCommandTag function to obtain the command tag immediately after calling this function. Then, after the command is issued, use the command tag and call either the SND_IsFinishedCommandTag or SND_WaitForCommandProc function to confirm that processing has finished or to wait for it to complete.

See Also

SND_SetPlayerVolume, SND_FlushCommand, SND_GetCurrentCommandTag, SND_IsFinishedCommandTag, SND_WaitForCommandProc

Revision History

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

CONFIDENTIAL