SND_PauseSeq

C Specification

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

Arguments

playerNo The Player number. Takes a value between 0 and 15.
flag This flag specifies whether to pause or re-start. TRUE = pause. FALSE = play.

Return Values

None.

Description

Pauses or restarts the sequence being played on the Player specified by the Player number playerNo.

Caution

When the sequence gets paused, any note that is sounding is forced to stop. When the sequence begins playing again, that note does not replay.

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