docs.unity3d.com
    Show / Hide Table of Contents

    Class XRControllerRecorder

    MonoBehaviour that controls interaction recording and playback (via XRControllerRecording assets).

    Inheritance
    Object
    Object
    Component
    Behaviour
    MonoBehaviour
    XRControllerRecorder
    Inherited Members
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(String, Single)
    MonoBehaviour.InvokeRepeating(String, Single, Single)
    MonoBehaviour.CancelInvoke(String)
    MonoBehaviour.IsInvoking(String)
    MonoBehaviour.StartCoroutine(String)
    MonoBehaviour.StartCoroutine(String, Object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(String)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(Object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, Component)
    Component.TryGetComponent<T>(T)
    Component.GetComponent(String)
    Component.GetComponentInChildren(Type, Boolean)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(Boolean)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, Boolean)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(Boolean)
    Component.GetComponentsInChildren<T>(Boolean, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, Boolean)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(Boolean)
    Component.GetComponentsInParent<T>(Boolean, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(String)
    Component.SendMessageUpwards(String, Object, SendMessageOptions)
    Component.SendMessageUpwards(String, Object)
    Component.SendMessageUpwards(String)
    Component.SendMessageUpwards(String, SendMessageOptions)
    Component.SendMessage(String, Object)
    Component.SendMessage(String)
    Component.SendMessage(String, Object, SendMessageOptions)
    Component.SendMessage(String, SendMessageOptions)
    Component.BroadcastMessage(String, Object, SendMessageOptions)
    Component.BroadcastMessage(String, Object)
    Component.BroadcastMessage(String)
    Component.BroadcastMessage(String, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Component.rigidbody
    Component.rigidbody2D
    Component.camera
    Component.light
    Component.animation
    Component.constantForce
    Component.renderer
    Component.audio
    Component.networkView
    Component.collider
    Component.collider2D
    Component.hingeJoint
    Component.particleSystem
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.ToString()
    Object.name
    Object.hideFlags
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEngine.XR.Interaction.Toolkit
    Syntax
    [AddComponentMenu("XR/Debug/XR Controller Recorder", 11)]
    [DisallowMultipleComponent]
    [DefaultExecutionOrder(-30000)]
    [HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.1/api/UnityEngine.XR.Interaction.Toolkit.XRControllerRecorder.html")]
    public class XRControllerRecorder : MonoBehaviour

    Properties

    currentTime

    (Read Only) The current recording/playback time.

    Declaration
    public double currentTime { get; }
    Property Value
    Type Description
    Double

    duration

    (Read Only) The total playback time (or 0 if no recording).

    Declaration
    public double duration { get; }
    Property Value
    Type Description
    Double

    isPlaying

    Whether the XRControllerRecorder is currently playing back interaction state.

    Declaration
    public bool isPlaying { get; set; }
    Property Value
    Type Description
    Boolean

    isRecording

    Whether the XRControllerRecorder is currently recording interaction state.

    Declaration
    public bool isRecording { get; set; }
    Property Value
    Type Description
    Boolean

    playOnStart

    Controls whether this recording will start playing when the component's Awake() method is called.

    Declaration
    public bool playOnStart { get; set; }
    Property Value
    Type Description
    Boolean

    recording

    Controller Recording asset for recording and playback of controller events.

    Declaration
    public XRControllerRecording recording { get; set; }
    Property Value
    Type Description
    XRControllerRecording

    recordingStartTime

    The time when recording was last started.

    Declaration
    protected float recordingStartTime { get; set; }
    Property Value
    Type Description
    Single

    xrController

    The controller that this recording uses for recording and playback.

    Declaration
    public XRBaseController xrController { get; set; }
    Property Value
    Type Description
    XRBaseController

    Methods

    Awake()

    See MonoBehaviour.

    Declaration
    protected void Awake()

    GetControllerState(out XRControllerState)

    Gets the state of the controller.

    Declaration
    public virtual bool GetControllerState(out XRControllerState controllerState)
    Parameters
    Type Name Description
    XRControllerState controllerState

    When this method returns, contains the XRControllerState object representing the state of the controller.

    Returns
    Type Description
    Boolean

    Returns true when playing or recording. Otherwise, returns false.

    OnDestroy()

    See MonoBehaviour.

    Declaration
    protected void OnDestroy()

    ResetPlayback()

    Resets the recorder to the start of the clip.

    Declaration
    public void ResetPlayback()

    Update()

    See MonoBehaviour.

    Declaration
    protected virtual void Update()
    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