SND_StopTimer

Syntax

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

Arguments

chBitMask The channel bit mask. It specifies which channels to control.
capBitMask The capture bit mask. It specifies which captures to control.
alarmBitMask The alarm bit mask. It specifies which Sound alarms to control.
flags Option flags.

Return Values

None.

Description

Stops timers.

By specifying numerous channels, captures and alarms all at once, you can stop them all with the same timing. The order is: channel -> capture -> alarm.

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.

The capture bit mask capBitMask specifies which captures to control. SND_CAPTURE_0 would be ( 1 << SND_CAPTURE_0 ), while SND_CAPTURE_1 would be ( 1 << SND_CAPTURE_1 ). Enter with a logical OR to specify both.

The Sound alarm bit mask alarmBitMask specifies which Sound alarms to control. The alarms are represented in order, with the lowest bit representing alarm 0. Only alarms whose representative bits are standing are controlled.

flags can take the value 0 or SND_COMMAND_CHANNEL_HOLD. When flags is set to SND_COMMAND_CHANNEL_HOLD, the final sample values continue to be output even after the channels stop. When flags is set to 0, the output level drops to 0 when the channels stop.

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

Revision History

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

CONFIDENTIAL