Class ARKitSessionDelegate

A set of callbacks related to the ARKit session. Implement this class to provide custom handling of certain session events.

Inheritance
Object
ARKitSessionDelegate
DefaultARKitSessionDelegate
Inherited Members
Namespace: UnityEngine.XR.ARKit
Syntax
public abstract class ARKitSessionDelegate

Methods

OnCoachingOverlayViewDidDeactivate(ARKitSessionSubsystem)

Invoked when the coaching experience is completely deactivated. This base class implementation does nothing.

Declaration
protected virtual void OnCoachingOverlayViewDidDeactivate(ARKitSessionSubsystem sessionSubsystem)
Parameters
Type Name Description
ARKitSessionSubsystem sessionSubsystem

The ARKitSessionSubsystem which provides an interface to the ARKit session.
Remarks

See coachingOverlayViewDidDeactivate: for more information.

See Also

OnCoachingOverlayViewWillActivate(ARKitSessionSubsystem)

Invoked when the coaching overlay view activates. This base class implementation does nothing.

Declaration
protected virtual void OnCoachingOverlayViewWillActivate(ARKitSessionSubsystem sessionSubsystem)
Parameters
Type Name Description
ARKitSessionSubsystem sessionSubsystem

The ARKitSessionSubsystem which provides an interface to the ARKit session.
Remarks

See coachingOverlayViewWillActivate: for more information.

See Also

OnConfigurationChanged(ARKitSessionSubsystem)

Invoked when a change to the ARConfiguration is requested.

Declaration
protected virtual void OnConfigurationChanged(ARKitSessionSubsystem sessionSubsystem)
Parameters
Type Name Description
ARKitSessionSubsystem sessionSubsystem

The ARKitSessionSubsystem which provides an interface to the ARKit session.

OnSessionDidFailWithError(ARKitSessionSubsystem, NSError)

Invoked when the session fails. This base class implementation does nothing.

Declaration
protected virtual void OnSessionDidFailWithError(ARKitSessionSubsystem sessionSubsystem, NSError error)
Parameters
Type Name Description
ARKitSessionSubsystem sessionSubsystem

The ARKitSessionSubsystem which provides an interface to the ARKit session.
NSError error

The NSError object describing the failure. This object is only valid during this callback. See also ARKitErrorCode.
Remarks

Use this to respond to session failures. For example, the DefaultARKitSessionDelegate implementation tries to restart the session by calling Reset.

See session:didFailWithError: for more information.

See Also