SoundMgr::StartRecording

Defined in: C4Sound.h

Starts recording audio output to a wave file.

Prototype

EngineResult StartRecording(const char *name);

Parameters

name The base name (including directory path) of the wave file that will be generated, without any extension.

Description

The StartRecording function starts recording the final audio output of the engine to the single wave file specified by the name parameter. The .wav extension is added by the Sound Manager and should not be included in the name.

If the call to the StartRecording function is successful, then the return value is kEngineOkay. Otherwise, a nonzero result code is returned. If the StartRecording function is called while recording is already in progress, then the function has no effect, and the return value is kEngineOkay.

The Sound Manager continues recording audio until the SoundMgr::StopRecording function is called.