SND_StopSeq

C Specification

#include <nitro/snd.h>
void SND_StopSeq( int playerNo );

Arguments

playerNo The Player number. Takes a value between 0 and 15.

Return Values

None.

Description

Stops sequence.

The sequence being played by the Player specified by playerNo gets stopped. Although the sequence stops immediately, if a note is sounding it will fade out and stop in accordance with the release value set in the data.

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

Revision History

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