Sound::SetLoopCount

Defined in: C4Sound.h

Sets the number of times that a sound will loop.

Prototype

void SetLoopCount(int32 count);

Parameters

count The loop count. The constant kSoundLoopInfinite causes the sound to loop forever.

Description

The SetLoopCount function sets the number of times that the sound will loop when it is played to the value specified by the count parameter. The constant kSoundLoopInfinite may be used to cause a sound to loop indefinitely.

When a sound loops, its loop callback function is invoked if one has been installed using the Sound::SetLoopCallback function.

Streamed sounds may have multiple resources concatenated and played in succession. When the end of the last resource in the list is reached, the sound may loop to any of the resources in the list. The index of the resource which will begin playing when the sound loops is set using the Sound::SetLoopIndex function.