Struct ArRecordingConfig

A recording configuration struct that contains the configuration for session recording. See StartRecording(ArRecordingConfig).

Implements
Inherited Members
Namespace: UnityEngine.XR.ARCore
Assembly: solution.dll
Syntax
public struct ArRecordingConfig : IEquatable<ArRecordingConfig>, IDisposable
Remarks

A ArRecordingConfig represents a native object that must be disposed (by calling Dispose()) to prevent memory leaks. Consider using a using statement for convenience: 

void RecordExample(ARCoreSessionSubsystem subsystem, string mp4Path)
{
    var session = subsystem.session;
    using (var config = new ArRecordingConfig(session))
    {
        config.SetMp4DatasetFilePath(session, mp4Path);
        config.SetRecordingRotation(session, 90);
        config.SetAutoStopOnPause(session, false);
        var status = subsystem.StartRecording(config);
        Debug.Log($"StartRecording to {config.GetMp4DatasetFilePath(session)} => {status}");
    }
}

This is a C# wrapper for ARCore's native ArRecordingConfig

Constructors

Name Description
ArRecordingConfig(ArSession)

Creates a dataset recording config object. This object must be disposed with Dispose().

Methods

Name Description
AsIntPtr()

Gets the underlying native pointer for this ArRecordingConfig.
Dispose()

Releases memory used by this recording config object.
Equals(object)

Tests for equality.
Equals(ArRecordingConfig)

Tests for equality.
FromIntPtr(IntPtr)

Create a ArRecordingConfig from an existing native pointer. The native pointer must point to an existing ArRecordingConfig.
GetAutoStopOnPause(ArSession)

Gets the setting that indicates whether this recording should stop automatically when the ARCore session is paused.
GetHashCode()

Generates a hash code suitable for use with a HashSet or Dictionary
GetMp4DatasetFilePath(ArSession)

Gets the file path to save an MP4 dataset file for this recording.
GetRecordingRotation(ArSession)

Gets the clockwise rotation in degrees that should be applied to the recorded image.
SetAutoStopOnPause(ArSession, bool)

Sets whether this recording should stop automatically when the ARCore session is paused.
SetMp4DatasetFilePath(ArSession, string)

Sets the file path to save an MP4 dataset file for the recording.
SetRecordingRotation(ArSession, int)

Specifies the clockwise rotation in degrees that should be applied to the recorded image.

Operators

Name Description
operator ==(ArRecordingConfig?, ArRecordingConfig?)

Tests for equality.
operator ==(ArRecordingConfig, ArRecordingConfig)

Tests for equality. Same as Equals(ArRecordingConfig).
explicit operator IntPtr(ArRecordingConfig)

Casts an ArRecordingConfig to its underlying native pointer.
operator !=(ArRecordingConfig?, ArRecordingConfig?)

Tests for inequality.
operator !=(ArRecordingConfig, ArRecordingConfig)

Tests for inequality. Same as the negation of Equals(ArRecordingConfig).