SND_InvalidateWaveData

C Specification

#include <nitro/snd.h>
void SND_InvalidateWaveData( const void* start, const void* end );

Arguments

start The starting address of the data being invalidated.
end The ending address of the data being invalidated.

Return Values

None.

Description

Invalidates waveform data.

Any sound that is playing using waveform data from inside the specified region gets forcibly stopped.

Caution

This function can only stop sounds in a playing sequence. It cannot stop waveform data played using the SND_SetupChannelPcm function.

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

Revision History

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