docs.unity3d.com
    Show / Hide Table of Contents

    Interface ITakeRecorder

    Represents a take recorder.

    Namespace: Unity.LiveCapture
    Syntax
    public interface ITakeRecorder

    Properties

    FrameRate

    The frame rate to use for recording.

    Declaration
    FrameRate FrameRate { get; set; }
    Property Value
    Type Description
    FrameRate

    Methods

    GetActiveSlate()

    The selected slate to use for recording.

    Declaration
    ISlate GetActiveSlate()
    Returns
    Type Description
    ISlate

    The selected slate.

    GetPreviewTime()

    Returns the current playback time of the selected take.

    Declaration
    double GetPreviewTime()
    Returns
    Type Description
    Double

    The current time in seconds.

    IsLive()

    Indicates whether the take recorder is ready for recording.

    Declaration
    bool IsLive()
    Returns
    Type Description
    Boolean

    true if ready for recording; otherwise, false.

    IsPreviewPlaying()

    Checks whether the take recorder is playing the selected take or not.

    Declaration
    bool IsPreviewPlaying()
    Returns
    Type Description
    Boolean

    true if playing; otherwise, false.

    IsRecording()

    Checks whether the take recorder is recording or not.

    Declaration
    bool IsRecording()
    Returns
    Type Description
    Boolean

    true if playing; otherwise, false.

    PausePreview()

    Pauses the playback of the selected take.

    Declaration
    void PausePreview()

    PlayPreview()

    Starts playing the selected take.

    Declaration
    void PlayPreview()

    SetLive(Boolean)

    Use this method to set the take recorder ready for recording.

    Declaration
    void SetLive(bool value)
    Parameters
    Type Name Description
    Boolean value

    true to set ready; otherwise, false.

    SetPreviewTime(Double)

    Changes the current playback time of the selected take.

    Declaration
    void SetPreviewTime(double time)
    Parameters
    Type Name Description
    Double time

    The current time in seconds.

    StartRecording()

    Starts the recording of a new take for the selected slate.

    Declaration
    void StartRecording()

    StopRecording()

    Stops the recording.

    Declaration
    void StopRecording()
    Back to top
    Terms of use
    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