Sound::Pause

Defined in: C4Sound.h

Pauses a sound.

Prototype

void Pause(void);

Description

The Pause function pauses a sound at its current position. The sound can be resumed by calling the Sound::Resume function. If the sound is not playing, then the Pause function has no effect.

If the Pause function is called multiple times for the same sound, then each call must be balanced by a call to the Sound::Resume function before the sound will continue playing (i.e., the sound keeps track of an internal pause count).

If the Pause function is called for a sound that is scheduled to play because the Sound::Delay function was previously called, then the time between the first Pause call and the balancing Sound::Resume call is not counted against the delay time. That is, the delay is paused as if the sound was playing silence until it was scheduled to begin playing.