Megacool Unity
TheUnityinterfacetotheMegacoolSDK
Public Member Functions | Properties | List of all members
MegacoolRecordingConfig Struct Reference

Pass to Megacool.StartRecording to configure how recordings are made. More...

Public Member Functions

 MegacoolRecordingConfig (MegacoolOverflowStrategy overflowStrategy=default(MegacoolOverflowStrategy), string recordingId=default(string), int maxFrames=0, double peakLocation=-42, int lastFrameDelay=-42, int playbackFrameRate=0, int frameRate=0)
 Configuration options for recording a GIF More...
 

Properties

MegacoolOverflowStrategy OverflowStrategy [get, set]
 How to compress longer recordings. More...
 
string RecordingId [get, set]
 An identifier for the recording. More...
 
int MaxFrames [get, set]
 Set the max number of frames in a recording. Must be larger than 2. More...
 
double PeakLocation [get, set]
 Set where the point of highest intensity should occur in a highlight recording. More...
 
int FrameRate [get, set]
 Set the capture frame rate. More...
 
int PlaybackFrameRate [get, set]
 Set the playback frame rate. More...
 
int LastFrameDelay [get, set]
 Set a custom delay on the last frame, in ms. Defaults to 1000. More...
 

Detailed Description

Pass to Megacool.StartRecording to configure how recordings are made.

Constructor & Destructor Documentation

◆ MegacoolRecordingConfig()

MegacoolRecordingConfig.MegacoolRecordingConfig ( MegacoolOverflowStrategy  overflowStrategy = default(MegacoolOverflowStrategy),
string  recordingId = default(string),
int  maxFrames = 0,
double  peakLocation = -42,
int  lastFrameDelay = -42,
int  playbackFrameRate = 0,
int  frameRate = 0 
)
inline

Configuration options for recording a GIF

Parameters
overflowStrategyThe MegacoolOverflowStrategy to use while recording.
recordingIdThe recording identifier to assign to the recording.
maxFramesThe maximum number of frames to store in the recording.
peakLocationThe percentage within the recording that represents the point of most interest.
lastFrameDelayThe delay (in milliseconds) to wait on the last frame before replaying. Setting this to 0 means the last frame will have the same duration as the other frames.
playbackFrameRateThe framerate at which to replay the recording.
frameRateThe framerate at which to record the GIF.

Property Documentation

◆ FrameRate

int MegacoolRecordingConfig.FrameRate
getset

Set the capture frame rate.

The frame rate.

◆ LastFrameDelay

int MegacoolRecordingConfig.LastFrameDelay
getset

Set a custom delay on the last frame, in ms. Defaults to 1000.

The last frame delay.

◆ MaxFrames

int MegacoolRecordingConfig.MaxFrames
getset

Set the max number of frames in a recording. Must be larger than 2.

The max frames.

◆ OverflowStrategy

MegacoolOverflowStrategy MegacoolRecordingConfig.OverflowStrategy
getset

How to compress longer recordings.

The overflow strategy.

◆ PeakLocation

double MegacoolRecordingConfig.PeakLocation
getset

Set where the point of highest intensity should occur in a highlight recording.

Must be between 0 and 1, the default is 0.7.

The peak location.

◆ PlaybackFrameRate

int MegacoolRecordingConfig.PlaybackFrameRate
getset

Set the playback frame rate.

Set this different from FrameRate to speed up or slow down the recording.

The playback frame rate.

◆ RecordingId

string MegacoolRecordingConfig.RecordingId
getset

An identifier for the recording.

The recording identifier.

Set this to enable having multiple recordings in progress at the same time. Pass the same identifier to MegacoolGifPreview.StartPrevierw and MegacoolShareConfig later to preview and share the different recordings.


The documentation for this struct was generated from the following file: