Sound::Stop

Defined in: C4Sound.h

Stops a sound.

Prototype

void Stop(void);

Description

Calling the Stop function stops the sound immediately. If the sound is not playing, then calling Stop has no effect. When a sound is explicitly stopped by using the Stop function, its completion procedure is not invoked.

Special Considerations

If a sound object is nonpersistent (the default for non-streamed sounds), then calling Stop causes it to be destroyed. The Stop 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.