SND_SetTrackPanRange

Syntax

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

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.
panRange The pan range. Takes a value between 0 and 127.

Return Values

None.

Description

Changes the track pan range for the sequence playing on the player specified by the player number 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.

panRange specifies the range of change for the pan set in the sound data. The values between 0 and 127 represent a range of 0% to 100%. The default value is 127. Setting a smaller value narrows the range of change for the pan set in the sound data.

Note

The pan range setting only affects the pan set in the sound data. The pan set by the SND_SetTrackPan function is not affected.

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

Revision History

2005/03/02 Initial version.

CONFIDENTIAL