SND_StartSeq

Syntax

#include <nitro/snd.h>
void SND_StartSeq(
        int playerNo,
        const void* base,
        u32 offset,
        const SNDBankData* bank );

Arguments

playerNo The player number. Takes a value between 0 and 15.
base The base address of the sequence data.
offset The start position offset for the sequence data.
bank This is the bank data pointer.

Return Values

None.

Description

Plays sequence.

Plays the sequence with the player of the player number playerNo. Any sequence that is already being played on that player will be forcibly stopped.

Sequence data is processed from the offset position (offset) from the base address (base).

For bank, bank, specify the bank which the sequence uses for sound generation. The SND_AssignWaveArc function must be used to combine the waveform archive with the bank in advance.

Use SND_PrepareSeq instead of this function if you need to change the volume or other parameters at the same time that you start sequence playback. If you call the SND_StartPreparedSeq function after changing parameters, parameter changes made up to that point are guaranteed to be applied at the same time as the sequence begins playing.

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

Revision History

2005/04/14 Added a description for SND_PrepareSeq
2005/02/17 Added a note about ARM7 command execution.
2004/07/20 Added an explanation regarding the combination of the bank and waveform archive.
2004/07/01 Initial version.

CONFIDENTIAL