Class XRControllerRecorder

that drives interaction recording and playback (via XRControllerRecording assets).

Inheritance

Object

XRControllerRecorder

Namespace: UnityEngine.XR.Interaction.Toolkit

Syntax

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 is started.

Declaration

public bool playOnStart { get; set; }

Property Value

Type	Description
Boolean

recordingStartTime

The time we last toggled recording.

Declaration

protected float recordingStartTime { get; set; }

Property Value

Type	Description
Single

xrController

Whether the controller that this recording uses for recording and playback.

Declaration

public XRBaseController xrController { get; set; }

Property Value

Type	Description
XRBaseController

Methods

Awake()

See .

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 .

Declaration

protected void OnDestroy()

ResetPlayback()

Resets the recorder to the start of the clip.

Declaration

public void ResetPlayback()

Update()

See .

Declaration

protected virtual void Update()