Struct XRHandRecordingStatusChangedEventArgs

Provides details about recording status changes.

Implements
Inherited Members
Namespace: UnityEngine.XR.Hands.Capture.Recording
Assembly: Unity.XR.Hands.dll
Syntax
public readonly struct XRHandRecordingStatusChangedEventArgs : IEquatable<XRHandRecordingStatusChangedEventArgs>

Properties

blob

The XRHandRecordingBlob currently recording tracking data.

Declaration
public XRHandRecordingBlob blob { get; }
Property Value
Type Description
XRHandRecordingBlob

elapsedTime

The elapsed time of the recording since it started in seconds.

Declaration
public float elapsedTime { get; }
Property Value
Type Description
float

recordingName

The name of the recording.

Declaration
public string recordingName { get; }
Property Value
Type Description
string

status

The new status of the recording session.

Declaration
public XRHandRecordingStatus status { get; }
Property Value
Type Description
XRHandRecordingStatus

subsystem

The XRHandSubsystem instance associated with the recording session.

Declaration
public XRHandSubsystem subsystem { get; }
Property Value
Type Description
XRHandSubsystem

Methods

Equals(object)

Tests for equality.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj

The object to compare against.
Returns
Type Description
bool

Returns true if obj is of type XRHandRecordingStatusChangedEventArgs and Equals(XRHandRecordingStatusChangedEventArgs) also returns true; otherwise returns false.
Overrides

Equals(XRHandRecordingStatusChangedEventArgs)

Tests for equality.

Declaration
public bool Equals(XRHandRecordingStatusChangedEventArgs other)
Parameters
Type Name Description
XRHandRecordingStatusChangedEventArgs other

The XRHandRecordingStatusChangedEventArgs to compare against.
Returns
Type Description
bool

Returns true if every field in other is equal to this XRHandRecordingStatusChangedEventArgs. Returns false otherwise.

GetHashCode()

Computes a hash code from all fields of XRHandRecordingStatusChangedEventArgs.

Declaration
public override int GetHashCode()
Returns
Type Description
int

Returns a hash code of this object.
Overrides

TryGetErrorMessage(out string)

Attempts to get the error message if the recording was stopped due to an error.

Declaration
public bool TryGetErrorMessage(out string errorMessage)
Parameters
Type Name Description
string errorMessage

Assigned the error message, if successful; otherwise, null.
Returns
Type Description
bool

true if an error message was present; otherwise, false.
Remarks

This method can only succeed if the recording was stopped with the StoppedWithError status.

Operators

operator ==(XRHandRecordingStatusChangedEventArgs, XRHandRecordingStatusChangedEventArgs)

Tests for equality. Same as Equals(XRHandRecordingStatusChangedEventArgs).

Declaration
public static bool operator ==(XRHandRecordingStatusChangedEventArgs lhs, XRHandRecordingStatusChangedEventArgs rhs)
Parameters
Type Name Description
XRHandRecordingStatusChangedEventArgs lhs

The left-hand side of the comparison.
XRHandRecordingStatusChangedEventArgs rhs

The right-hand side of the comparison.
Returns
Type Description
bool

Returns true if lhs is equal to rhs, otherwise returns false.

operator !=(XRHandRecordingStatusChangedEventArgs, XRHandRecordingStatusChangedEventArgs)

Tests for inequality. Same as !Equals(XRHandRecordingStatusChangedEventArgs).

Declaration
public static bool operator !=(XRHandRecordingStatusChangedEventArgs lhs, XRHandRecordingStatusChangedEventArgs rhs)
Parameters
Type Name Description
XRHandRecordingStatusChangedEventArgs lhs

The left-hand side of the comparison.
XRHandRecordingStatusChangedEventArgs rhs

The right-hand side of the comparison.
Returns
Type Description
bool

Returns true if lhs is not equal to rhs, otherwise returns false.

Implements