SND_SetTrackMute

C Specification

#include <nitro/snd.h>
void SND_SetTrackMute( int playerNo, u32 trackBitMask, BOOL flag );

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.
flag Flag indicating whether to mute track or release mute. TRUE = Mute; FALSE = Release.

Return Values

None.

Description

Mutes or releases muting on 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.

Caution

When mute is applied, a note that is playing gets forcibly stopped. When the mute is released, that note does not start playing again.

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

Revision History

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