Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AugmentedReality > UARBlueprintLibrary > UARBlueprintLibrary::GetARSessionStatus

Light Theme

Dark Theme

UARBlueprintLibrary::GetARSessionStatus

It is intended that you check the status of the Augmented Reality session on every frame and take action accordingly.

Windows

MacOS

Linux

References

Module	AugmentedReality
Header	/Engine/Source/Runtime/AugmentedReality/Public/ARBlueprintLibrary.h
Include	#include "ARBlueprintLibrary.h"
Source	/Engine/Source/Runtime/AugmentedReality/Private/ARBlueprintLibrary.cpp

Syntax

static FARSessionStatus GetARSessionStatus()

Remarks

It is intended that you check the status of the Augmented Reality session on every frame and take action accordingly. e.g. if the session stopped for an unexpected reason, you might give the user a prompt to re-start the session

Returns

The status of a current Augmented Reality session: e.g. Running or Not running for a specific reason.

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

Take our survey

Dismiss