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

Public Member Functions

 MegacoolFrameCaptureConfig (MegacoolOverflowStrategy overflowStrategy=default(MegacoolOverflowStrategy), string recordingId=default(string), bool forceAdd=false, int maxFrames=0, double peakLocation=-42, int lastFrameDelay=-42, int playbackFrameRate=0, int frameRate=0)
 Configuration options for capturing a frame for a GIF More...
 
void SetDefaults ()
 

Properties

MegacoolOverflowStrategy OverflowStrategy [get, set]
 
string RecordingId [get, set]
 
bool ForceAdd [get, set]
 
int MaxFrames [get, set]
 
double PeakLocation [get, set]
 
int FrameRate [get, set]
 
int PlaybackFrameRate [get, set]
 
int LastFrameDelay [get, set]
 

Constructor & Destructor Documentation

◆ MegacoolFrameCaptureConfig()

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

Configuration options for capturing a frame for a GIF

Parameters
overflowStrategyThe MegacoolOverflowStrategy to use while recording.
recordingIdThe recording identifier to assign to the recording.
forceAddWhether to always add this captured frame to the final GIF
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.

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