docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct ArSession

    Represents the context for an ARCore session.

    Implements
    IEquatable<ArSession>
    Inherited Members
    ValueType.ToString()
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetType()
    Namespace: UnityEngine.XR.ARCore
    Assembly: solution.dll
    Syntax
    public struct ArSession : IEquatable<ArSession>
    Remarks

    This is an opaque object that represents a native ArSession.

    Properties

    Name Description
    IsNull

    (Read Only) Indicates whether this ArSession is null. This property is deprecated. Use the equality operator (==) to compare with null instead.

    Null

    Represents a null ArSession, i.e., one whose underlying native pointer is null. This property is obsolete. Use default instead.

    playbackStatus

    (Read Only) The playback status.

    recordingStatus

    (Read Only) The current recording status.

    Methods

    Name Description
    AsIntPtr()

    Gets the underlying native pointer for this ArSession.

    Equals(object)

    Tests for equality.

    Equals(ArSession)

    Tests for equality.

    FromIntPtr(IntPtr)

    Creates an ArSession from an existing native pointer. The native pointer must point to an existing ArSession.

    GetHashCode()

    Generates a hash code suitable for use with a HashSet or Dictionary

    SetPlaybackDataset(string)

    Sets an MP4 dataset file to playback instead of live camera feed.

    StartRecording(ArRecordingConfig)

    Starts a new MP4 dataset file recording that is written to the specific filesystem path.

    StopRecording()

    Stops recording and flushes unwritten data to disk. The MP4 dataset file is ready to read after this call.

    Operators

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

    Tests for equality.

    operator ==(ArSession, ArSession)

    Tests for equality. Same as Equals(ArSession).

    explicit operator IntPtr(ArSession)

    Casts an ArSession to its underlying native pointer.

    operator !=(ArSession?, ArSession?)

    Tests for inequality.

    operator !=(ArSession, ArSession)

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

    See Also

    beforeSetConfiguration
    ARCoreBeforeSetConfigurationEventArgs
    beforeGetCameraConfiguration
    ARCoreBeforeGetCameraConfigurationEventArgs
    In This Article
    Back to top Copyright © 2023 Unity Technologies — Terms of use
    Generated by DocFX
    on Friday, September 22, 2023