SoundStreamer::StartStreamComponent

Defined in: C4Sound.h

Called when a stream is looped.

Prototype

virtual SoundResult StartStreamComponent(int32 index);

Parameters

index The index of the component at which to continue the stream.

Description

The Sound Manager calls the StartStreamComponent function when the sound to which the streamer is assigned loops. The index parameter specifies the zero-based index of the component at which the stream should continue playing and is equal to the value set by the Sound::SetLoopIndex function. If the index is greater than or equal to the number of components, then the stream should restart at the first component. By default, the StartStreamComponent function simply calls the SoundStreamer::StartStream function.

The return value should be kSoundOkay if the function is successful.