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;
    AudioCapture Audio;
    double Cursor;

    // methods

    void Add(ICapturedEvent ev);
    void AddSupplementaryFile(string path);
    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.

AudioCapture Audio

Gets the audio capture.

double Cursor

Gets the current cursor position.

Methods

void Add(ICapturedEvent ev)

Add an event to the recorder.

Parameters:

ev

The captured event.

void AddSupplementaryFile(string path)

Add a supplementary file to the recording.

Parameters:

path

The relative path of the file.

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:

filePath

The path to save the recording.