About Unity Recorder

Unity Recorder

Use the Unity Recorder package to capture and save data during Play mode. For example, you can capture gameplay or a cinematic and save it as a video file.

Note

You can only use the Recorder in the Unity Editor. It does not work in standalone Unity Players or builds.

Recording

You can set up and launch recordings in two ways:

Available recorder types

Default recorders

The Unity Recorder includes the following recorder types by default:

  • Animation Clip Recorder: generates an animation clip in Unity Animation format (.anim extension).

  • Movie Recorder: generates a video in MP4, WebM or MOV format.

  • Image Sequence Recorder: generates a sequence of image files in JPEG, PNG, or EXR (OpenEXR) format.

  • GIF Animation Recorder: generates an animated GIF file.

  • Audio Recorder: generates an audio clip in WAV format.

Additional recorders

You can also benefit from additional Recorder types if you install specific packages along with the Unity Recorder:

  • The Alembic for Unity package includes an Alembic Clip Recorder, which allows you to record and export GameObjects to an Alembic file.

  • The FBX Exporter package includes an FBX Recorder, which allows you to record and export animations directly to FBX files.

  • The Unity AOV Recorder allows you to capture specific render pass data (related with material, geometry, depth, motion, lighting...) in projects that use Unity's HDRP (High Definition Render Pipeline).

Legacy recorders

As of version 1.0, Unity Recorder uses recorders types that take better advantage of Unity Editor features and are more stable than previous versions. If you're upgrading from a pre-1.0 version of Unity Recorder, or supporting legacy content, you can toggle the legacy recorder types on from Unity's main menu: Window > General > Recorder > Options > Show Legacy Recorders.

Package technical details

Preview package

This package is in preview, so it is not ready for production use. The features and documentation in this package might change before it is verified for release.

Installation

To install this package, follow the instructions in the Package Manager documentation.

Requirements

This version of the Unity Recorder is compatible with the following versions of the Unity Editor:

  • 2018.4 and later (recommended)

Known issues and limitations

See the list of current known issues and limitations that you might experience with the Unity Recorder – and their workarounds.