SND_StopUnlockedChannel

C Specification

#include <nitro/snd.h>
void SND_StopUnlockedChannel( u32 chBitMask, u32 flags );

Arguments

chBitMask The channel bit mask. It specifies which channels to control.
flags Option flags. At the current time the flags are not used, so 0 is entered here.

Return Values

None.

Description

Stops the unlocked channel.

The channel bit mask chBitMask specifies which channels to control. The channels are represented in order, with the lowest bit representing channel 0. Only channels whose representative bits are standing are controlled.

This function will not do anything to channels that have been locked with the SND_LockChannel function.

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

Revision History

02/17/2005 Added a note about ARM7 command processing
08/10/2004 Initial version