EARSessionStatus

Describes the current status of the AR session.

Windows
MacOS
Linux

References

Module

AugmentedReality

Header

/Engine/Source/Runtime/AugmentedReality/Public/ARTypes.h

Include

#include "ARTypes.h"

Syntax

enum EARSessionStatus
{
    NotStarted,
    Running,
    NotSupported,
    FatalError,
    PermissionNotGranted,
    UnsupportedConfiguration,
    Other,
}

Values

Name

Description

NotStarted

Unreal AR session has not started yet.

Running

Unreal AR session is running.

NotSupported

Unreal AR session failed to start due to the AR subsystem not being supported by the device.

FatalError

The AR session encountered fatal error; the developer should call `StartARSession()_ to re-start the AR subsystem.

PermissionNotGranted

AR session failed to start because it lacks the necessary permission (likely access to the camera or the gyroscope).

UnsupportedConfiguration

AR session failed to start because the configuration isn't supported.

Other

Session isn't running due to unknown reason;

Remarks

Describes the current status of the AR session.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback