Sound::StreamSound

Defined in: C4Sound.h

Establishes a streaming source for a Sound object.

Prototype

SoundResult StreamSound(SoundStreamer *streamer);

Parameters

streamer The streamer object to associate with the sound.

Description

The StreamSound function assigns the SoundStreamer object specified by the streamer parameter to a sound object. The sound streamer should be allocated on the heap before calling this function, but once StreamSound has been called, the sound object owns the sound streamer and will delete it automatically at the appropriate time.

A sound is made persistent when the StreamSound function is called, meaning that it must be explicitly destroyed when it is no longer in use.