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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss