docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    About Recorder

    Recorder

    Use the 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 use the Recorder in the Unity Editor only. It does not work in standalone Unity Players or builds.

    Recording

    You can set up and launch recordings in two ways:

    • From the Recorder window.

    • Through a Recorder Clip within a Timeline track.

    You can also use the Recorder API for multiple use cases, such as launching recordings from the command line.

    Available recorder types

    Default recorders

    The 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 H.264 MP4, VP8 WebM, or ProRes QuickTime format.

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

    • 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 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.

    Samples

    Various samples are available with the Recorder package to help you experiment with some specific features and use cases.

    One of them allows you to integrate FFmpeg as a custom command line encoder in the Movie Recorder.

    Package technical details

    Installation

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

    Requirements

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

    • 2023.1 and later (recommended)

    Known issues and limitations

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

    In This Article
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023