MegacoolRecordingConfig Class Reference

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

Public Member Functions
	MegacoolRecordingConfig ()
	Configuration options for recording a GIF. More...
override string	ToString ()

Protected Attributes
MegacoolOverflowStrategy?	overflowStrategy

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. If set to 1 the recording will be shared as a still image instead of as a GIF. Must be 1 or larger. More...
double??	PeakLocation [get, set]
	Set the location of the highest scoring moment (the peak) in a highlight recording. Must be between 0 and 1, the default is 0.7. Set the score throughout the game with Megacool.RegisterScoreChange(). The recording must be using the highlight overflow strategy for this to have any effect. 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...
string	LastFrameOverlay [get, set]
	Overlay an image over the last frame of the GIF. More...

Detailed Description

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

Constructor & Destructor Documentation

MegacoolRecordingConfig()

MegacoolRecordingConfig.MegacoolRecordingConfig ( )

inline

Configuration options for recording a GIF.

Property Documentation

FrameRate

int?? MegacoolRecordingConfig.FrameRate

getset

Set the capture frame rate.

LastFrameDelay

int?? MegacoolRecordingConfig.LastFrameDelay

getset

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

LastFrameOverlay

string MegacoolRecordingConfig.LastFrameOverlay

getset

Overlay an image over the last frame of the GIF.

Default is none. The path should be relative to the StreamingAssets directory.

MaxFrames

int?? MegacoolRecordingConfig.MaxFrames

getset

Set the max number of frames in a recording. If set to 1 the recording will be shared as a still image instead of as a GIF. Must be 1 or larger.

The default is 50 frames. What happens when a recording grows above the MaxFrames limit is determined by the overflow strategy.

If you set this to 1 you probably also want to use MegacoolShareConfig.ModalTitle to change the default modal title so that it doesn't say a GIF is about to be shared.

OverflowStrategy

MegacoolOverflowStrategy?? MegacoolRecordingConfig.OverflowStrategy

getset

How to compress longer recordings.

PeakLocation

double?? MegacoolRecordingConfig.PeakLocation

getset

Set the location of the highest scoring moment (the peak) in a highlight recording. Must be between 0 and 1, the default is 0.7. Set the score throughout the game with Megacool.RegisterScoreChange(). The recording must be using the highlight overflow strategy for this to have any effect.

For example, in a recording with 10 frames, a peak location of 0.2 means that the highest scoring frame will occur near the beginning at frame 2, and a peak location of 0.8 means that the peak will occur near the end at frame 8.

PlaybackFrameRate

int?? MegacoolRecordingConfig.PlaybackFrameRate

getset

Set the playback frame rate.

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

RecordingId

string?? MegacoolRecordingConfig.RecordingId

getset

An identifier for the recording.

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

---

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

• MegacoolRecordingConfig.cs