C4 Engine
C4 Engine API Documentation


Defined in:  C4Sound.h
Loads a sound resource into a Sound object.

SoundResult LoadSound(const char *name);

name The name of the sound resource.
The LoadSound function loads the sound resource specified by the name parameter into memory.

A sound resource loaded into memory with the LoadSound function must contain fewer than 221 frames of audio data. For a mono sound, this means that the audio data must be smaller than 4 MB in size, and for a stereo sound, the audio data must be smaller than 8 MB in size. If this limit is exceeded, then the LoadSound function returns kSoundTooLarge.

A sound is made nonpersistent when the LoadSound function is called, meaning that it will destroy itself once it has finished playing.
See Also