Animated GIF Recording with GifRecorder in ScreenshotKit

Record and encode animated GIFs at runtime using the GifRecorder singleton: configure frame rate, quality, and palette, and wire up encoding events.

Usage

using DaCruz.ScreenshotKit;
using UnityEngine;

public class GifController : MonoBehaviour
{
    public Camera cam;

    void StartGif()
    {
        var settings = new GifRecorder.RecordingSettings
        {
            SourceCamera     = cam,
            OutputPath       = Application.dataPath + "/../Captures/clip.gif",
            FrameRate        = 15,
            Resolution       = GifRecorder.Resolution.Half,
            MaxDuration      = 8f,
            Loop             = true,
            Quality          = GifEncoder.Quality.Medium,
            UseGlobalPalette = true,
        };

        GifRecorder.Instance.StartRecording(settings);

        GifRecorder.Instance.OnEncodingComplete += path =>
            Debug.Log($"GIF saved to {path}");
        GifRecorder.Instance.OnEncodingFailed += err =>
            Debug.LogError($"GIF failed: {err}");
    }

    void StopGif()
    {
        GifRecorder.Instance.StopRecording();        // starts encoding
        // or: GifRecorder.Instance.CancelRecording();
    }
}

The singleton

The recorder runs as a singleton MonoBehaviour that survives scene loads (DontDestroyOnLoad).

Properties for binding UI: State, RecordingTime, FrameCount, EncodingProgress, LastOutputPath.

Events: OnRecordingStarted, OnRecordingStopped, OnEncodingProgress, OnEncodingComplete, OnEncodingFailed.

Encoding runs on a background thread after StopRecording(). The .gif file exists once OnEncodingComplete fires; watch EncodingProgress for a progress bar.

GifRecorder refuses to start outside Play Mode. The in-memory frame buffer is capped at 512 MB; the recorder caps the duration and logs a warning if your settings would exceed it.

See also

• GIF Recording workflow for the editor-window equivalent.
• SequenceRecorder for frame-by-frame stills instead.