docs.unity3d.com
    Show / Hide Table of Contents

    Class TakeRecorder

    A take recorder that manages a set of capture devices.

    Inheritance
    Object
    TakeRecorder
    Namespace: Unity.LiveCapture
    Syntax
    public class TakeRecorder : MonoBehaviour, ITakeRecorderInternal, ITakeRecorder

    Properties

    FrameRate

    The frame rate to use for recording.

    Declaration
    public FrameRate FrameRate { get; set; }
    Property Value
    Type Description
    FrameRate
    Implements
    ITakeRecorder.FrameRate

    Methods

    GetActiveSlate()

    The selected slate to use for recording.

    Declaration
    public ISlate GetActiveSlate()
    Returns
    Type Description
    ISlate

    The selected slate.

    Implements
    ITakeRecorder.GetActiveSlate()

    GetPreviewTime()

    Returns the current playback time of the selected take.

    Declaration
    public double GetPreviewTime()
    Returns
    Type Description
    Double

    The current time in seconds.

    Implements
    ITakeRecorder.GetPreviewTime()

    IsLive()

    Indicates whether the take recorder is ready for recording.

    Declaration
    public bool IsLive()
    Returns
    Type Description
    Boolean

    true if ready for recording; otherwise, false.

    Implements
    ITakeRecorder.IsLive()

    IsPreviewPlaying()

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

    Declaration
    public bool IsPreviewPlaying()
    Returns
    Type Description
    Boolean

    true if playing; otherwise, false.

    Implements
    ITakeRecorder.IsPreviewPlaying()

    IsRecording()

    Checks whether the take recorder is recording or not.

    Declaration
    public bool IsRecording()
    Returns
    Type Description
    Boolean

    true if playing; otherwise, false.

    Implements
    ITakeRecorder.IsRecording()

    PausePreview()

    Pauses the playback of the selected take.

    Declaration
    public void PausePreview()
    Implements
    ITakeRecorder.PausePreview()

    PlayPreview()

    Starts playing the selected take.

    Declaration
    public void PlayPreview()
    Implements
    ITakeRecorder.PlayPreview()

    SetLive(Boolean)

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

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

    true to set ready; otherwise, false.

    Implements
    ITakeRecorder.SetLive(Boolean)

    SetPreviewTime(Double)

    Changes the current playback time of the selected take.

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

    The current time in seconds.

    Implements
    ITakeRecorder.SetPreviewTime(Double)

    StartRecording()

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

    Declaration
    public void StartRecording()
    Implements
    ITakeRecorder.StartRecording()

    StopRecording()

    Stops the recording.

    Declaration
    public void StopRecording()
    Implements
    ITakeRecorder.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