Sound::StopSound
Defined in:
Stops a sound.
C4Sound.h
Prototype
void StopSound(void);
Description
Calling the StopSound
function stops the sound immediately. If the sound is not playing, then calling StopSound
has no effect. When a sound is explicitly stopped by using the StopSound
function, its completion callback function is not invoked.
Special Considerations
If a sound object is nonpersistent (the default for non-streamed sounds), then calling StopSound
causes it to be destroyed. The StopSound
function should be called for nonpersistent sound objects only if they are known to be playing. The only way to be absolutely sure that a sound object is still playing is to set its loop count to kSoundLoopInfinite
using the Sound::SetLoopCount
function before it is played.
See Also