class MAGES::Recorder::Recorder¶

Overview¶

The component responsible for capturing input and determining synchronization points. More…

class Recorder: public MonoBehaviour
{
public:
    // properties

    long CurrentFrame;
    bool Running;
    double FinalTime;
    int QueuedEvents;
    int InFlightEvents;
    string CurrentFilePath;
    AudioCapture Audio;
    double StartRtss;
    double Cursor;

    // methods

    void Add(ICapturedEvent ev);
    void AddSupplementaryFile(string path);
    void PushChapter(string name);
    IReadOnlyList<StartPacket2.ChapterData> GetChapters();
    RecorderModule.Recording Stop();
    void OnPreRender();
    void Initialize(string filePath);
};

Detailed Documentation¶

The component responsible for capturing input and determining synchronization points.

Properties¶

long CurrentFrame

Gets the current frame.

bool Running

Gets a value indicating whether the recorder is running.

double FinalTime

Gets the final time of the recording.

int QueuedEvents

Gets the number of events queued.

int InFlightEvents

Gets the number of events in flight.

string CurrentFilePath

Gets the main recording filepath.

AudioCapture Audio

Gets the audio capture.

double StartRtss

Gets the recording start RTSS.

double Cursor

Gets the current cursor position.

Methods¶

void Add(ICapturedEvent ev)

Add an event to the recorder.

Parameters:

void AddSupplementaryFile(string path)

Add a supplementary file to the recording.

Parameters:

void PushChapter(string name)

Adds a chapter to the recording.

Parameters:

IReadOnlyList<StartPacket2.ChapterData> GetChapters()

Gets the recorded chapters.

Returns:

The chapters snapshot.

RecorderModule.Recording Stop()

Stops the recording.

Returns:

The recording files.

void OnPreRender()

Polls the captors for events on pre render.

void Initialize(string filePath)

Initialize the recorder.

Parameters: