SND_InvalidateWaveData

Syntax

#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.

Note

This function can only stop audio produced by sequence playback. It cannot stop waveform data played using the SND_SetupChannelPcm function.

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_SetupChannelPcm, 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