MovieMgr::StartRecording

Defined in: C4Movies.h

Starts recording video output to movie sequence files.

Prototype

EngineResult StartRecording(int32 rate, const char *name);

Parameters

`rate`	The rate at which frames are captured, in frames per second. For best results, this number should evenly divide 36000.
`name`	The base name (including directory path) of the sequence files that will be generated, without any extension.

Description

The StartRecording function starts recording the rendered video output of the engine at the frame rate specified by the rate parameter. The video frames are stored in one or more movie sequence files that are named by taking the path specified by the name parameter, appending a number representing the index of the sequence file, and then appending the extension .seq. Each sequence file is filled with as many frames as will fit within a 1.5 GB limit, and then a new sequence file is started.

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 Movie Manager continues recording video until the MovieMgr::StopRecording function is called.