docs.unity3d.com
    Show / Hide Table of Contents

    Class RecorderInput

    This class represents the different types of input that can receive frame data from a RecordingSession object.

    Inheritance
    Object
    RecorderInput
    BaseRenderTextureInput
    AnimationInput
    Namespace: UnityEditor.Recorder
    Syntax
    public class RecorderInput : IDisposable

    Properties

    settings

    The settings of the Recorder input data. These can be of type AnimationInputSettings, ImageInputSettings, or AudioInputSettings.

    Declaration
    public RecorderInputSettings settings { get; set; }
    Property Value
    Type Description
    RecorderInputSettings

    Methods

    BeginRecording(RecordingSession)

    Declaration
    protected virtual void BeginRecording(RecordingSession session)
    Parameters
    Type Name Description
    RecordingSession session

    Dispose()

    Cleans up the Recorder input's resources.

    Declaration
    public void Dispose()

    Dispose(Boolean)

    Cleans up the Recorder input's resources.

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    Boolean disposing

    This flag is True when the method is being called by a user's Dispose() method, otherwise it means that it has been called by a finalizer and you should only dispose of unmanaged resources.

    EndRecording(RecordingSession)

    Declaration
    protected virtual void EndRecording(RecordingSession session)
    Parameters
    Type Name Description
    RecordingSession session

    Finalize()

    The finalizer of the class.

    Declaration
    protected void Finalize()

    FrameDone(RecordingSession)

    Declaration
    protected virtual void FrameDone(RecordingSession session)
    Parameters
    Type Name Description
    RecordingSession session

    NewFrameReady(RecordingSession)

    Declaration
    protected virtual void NewFrameReady(RecordingSession session)
    Parameters
    Type Name Description
    RecordingSession session

    NewFrameStarting(RecordingSession)

    Declaration
    protected virtual void NewFrameStarting(RecordingSession session)
    Parameters
    Type Name Description
    RecordingSession session

    SessionCreated(RecordingSession)

    Declaration
    protected virtual void SessionCreated(RecordingSession session)
    Parameters
    Type Name Description
    RecordingSession session

    See Also

    RecorderInputSettings
    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