Configuring Movie Recorders | Unity Recorder | 2.2.0-preview.4
docs.unity3d.com
    Show / Hide Table of Contents

    Configuring Movie Recorders

    The Movie Recorder generates a video in the .mp4 or .webm file format. It does not support variable frame rates.

    This page covers properties specific to Movie Recorders. To fully configure a Movie Recorder, you must also set:

    • The Recorder's Output properties.
    • The Recording Properties for the capture.

    Movie Recorder properties

    Property: Function:
    Format The encoding format of the Recorder's output. Choose .mp4 or WEBM.
    Capture Alpha Enable this property to include the alpha channel in the recording. Disable it to only record the RGB channels. This property is only available when Format is WEBM. This property is not available when Capture is Game View.
    Capture Specifies the input for the recording.
    Game View Records frames rendered in the Game View.

    Selecting this option displays the Game View capture properties.
    Targeted Camera Records frames captured by a specific Camera, even if the Game View does not use that Camera.

    Selecting this option displays the Targeted Camera capture properties.
    360 View Records a 360-degree video.

    Selecting this option displays the 360 View capture properties.
    Render Texture Asset Records frames rendered in a Render Texture.

    Selecting this option displays the Render Texture Asset capture properties.
    Texture Sampling Supersamples the Source camera during the capture to generate anti-aliased images in the recording. Use this capture method when the Rendering Resolution has the same or higher resolution than the Output Resolution.

    Selecting this option displays the Texture Sampling capture properties.
    Capture Audio Enable this property to include audio in the recording.
    Quality Sets the quality of the output movie: Low, Medium, or High. The lower the quality, the smaller the file size.

    Game View capture properties

    These options appear when you set Capture to Game View.

    Note
    • If you have multiple Game Views in your project, the Recorder captures only the last one you selected in the Editor.
    • If you are using more than one Recorder to capture Game View, they must all use the same resolution settings.

    Property: Function:
    Output Resolution The dimensions of the recording.
    Match Window Size Matches the current Game View resolution.
    [PRESET RESOLUTIONS] Choose from several standard video resolutions such as 1080p and 4K.
    Custom Uses custom width and height values that you supply.
    Aspect Ratio These options appear when you set Output Resolution to Custom.
    W/H Control the recording's width and height.

    Targeted Camera capture properties

    These options appear when you set Capture to Targeted Camera.

    Property: Function:
    Source Specifies which camera the Recorder uses to capture the recording.

    Note: some options may not appear if you're using certain render pipelines (for example HDRP).
    ActiveCamera The Camera that is active when you launch the recording.
    Main Camera The Camera tagged with the MainCamera Tag.
    Tagged Camera A camera tagged with a specific Tag.
    Tag When you set Source to Tagged Camera, specifies which Tag to look for.
    Output Resolution The dimensions of the recording.
    Match Window Size Matches the current monitor resolution.
    [PRESET RESOLUTIONS] Choose from several standard video resolutions such as 1080p and 4K.
    Custom Uses custom width and height values that you supply.
    Aspect Ratio These options only appear when you set Output Resolution to Custom.
    W/H Control the recording's width and height.
    Include UI When you enable this option, the recording includes UI GameObjects.

    This option only appears when you set Source to ActiveCamera.
    Flip Vertical When you enable this option, the Recorder flips the output image vertically.

    This is useful to correct for systems that output video upside down.

    360 View capture properties

    These properties appear when you set Capture to 360 View.

    To capture 360 degree recordings, the Recorder rotates the Source camera 360 degrees in about its Y axis.

    Property: Function
    Source Specifies which camera the Recorder uses as the point of view for the 360 degree recording.

    Note: some options may not appear if you're using certain render pipelines (for example HDRP).
    Main Camera The Camera tagged with the MainCamera Tag.
    Tagged Camera A camera tagged with a specific Tag.
    Tag When you set Source to Tagged Camera, specifies which Tag to look for.
    360 View Output W and H specify the width and height, in pixels, of the 360-degree video.
    Cube Map The size of the cube map, in pixels, for the 360-degree video.
    Stereo When you enable this option, the Recorder outputs separate left and right stereoscopic views of the 360-degree video.
    Stereo Separation When you enable the Stereo option, this property specifies the angle between the left and right views on the Source camera's Y axis.
    Flip Vertical When you enable this option, the Recorder flips the output image vertically.

    This is useful to correct for systems that output video upside down.

    Render Texture Asset capture properties

    These options appear when you set Capture to Render Texture Asset.

    Property: Function
    Render Texture Points to the render texture you want the Recorder to capture.
    Resolution The target render texture's resolution. Unity updates this field automatically when you select a render texture.
    Flip Vertical When you enable this option, the Recorder flips the output image vertically.

    This is useful to correct for systems that output video upside down.

    Texture Sampling capture properties

    These options appear when you set Capture to Texture Sampling.

    Property: Function
    Source Specifies which camera the Recorder uses to capture the recording.

    Note: some options may not appear if you're using certain render pipelines (for example HDRP).
    ActiveCamera The Camera that is active when you launch the recording.
    Main Camera The Camera tagged with the MainCamera Tag.
    Tagged Camera A camera tagged with a specific Tag.
    Tag When you set Source to Tagged Camera, specifies which Tag to look for.
    Aspect Ratio The width:height ratio to format the output to.
    Super Sampling The size of the grid from which to sample.
    Rendering Resolution The dimensions of the input from which to sample.
    Output Resolution The dimensions of the video recording.
    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