Table of Contents

Class Recorder

Namespace
Moments
Assembly
GrindFest.dll
[AddComponentMenu("Miscellaneous/Moments Recorder")]
[DisallowMultipleComponent]
public class Recorder : Singleton<Recorder>
Inheritance
object
Recorder
Inherited Members

Fields

AutoAspect
BufferSize
Camera
FramePerSecond
Height
OnFileSaveProgress

Called by each worker thread every time a frame is processed during the save process. The first parameter holds the worker ID and the second one a value in range [0;1] for the actual progress. This callback is probably not thread-safe, use at your own risks.

OnFileSaved

Called once a gif file has been saved. The first parameter will hold the worker ID and the second one the absolute file path.

OnPreProcessingDone

Called when the pre-processing step has finished.

Quality
Repeat
Width
WorkerPriority

Sets the worker threads priority. This will only affect newly created threads (on save).

Properties

EstimatedMemoryUse

Returns the estimated VRam used (in MB) for recording.

SaveFolder

The folder to save the gif to. No trailing slash.

State

Current state of the recorder.

Methods

ComputeHeight()
FlushMemory()

Clears all saved frames from memory and starts fresh.

Pause()

Pauses recording.

Record()

Starts or resumes recording. You can't resume while it's pre-processing data to be saved.

Save()

Saves the stored frames to a gif file. The filename will automatically be generated. Recording will be paused and won't resume automatically. You can use the

OnPreProcessingDone
callback to be notified when the pre-processing

step has finished.

Save(string)

Saves the stored frames to a gif file. If the filename is null or empty, an unique one will be generated. You don't need to add the .gif extension to the name. Recording will be paused and won't resume automatically. You can use the 

OnPreProcessingDone
callback to be notified when the pre-processing step has finished.
Setup(bool, int, int, int, float, int, int)

Initializes the component. Use this if you need to change the recorder settings in a script. This will flush the previously saved frames as settings can't be changed while recording.