Navigation
API > API/Runtime > API/Runtime/AugmentedReality
Helper class that allows the user to explicitly request AR service installation and permission granting. Recommended flow for explicit management:
Call "GetARDependencyHandler" to get a handler, if valid:
Call "CheckARServiceAvailability" to check availability, if the device is supported:
Call "InstallARService" to install AR service dependency, if installed:
Call "RequestARSessionPermission" to request permission, if granted:
Call "UARBlueprintLibrary::StartARSession" to start the session. Alternatively, you can also call "StartARSessionLatent" which handles dependency and permission internally.
| Name | UARDependencyHandler |
| Type | class |
| Header File | /Engine/Source/Runtime/AugmentedReality/Public/ARDependencyHandler.h |
| Include Path | #include "ARDependencyHandler.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, Abstract, Category="")
class UARDependencyHandler :
public UObject,
public IModularFeature
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UARDependencyHandler
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CheckARServiceAvailability
(
UObject* WorldContextObject, |
Latent action to check AR availability on the current platform. | ARDependencyHandler.h |
|
virtual void InstallARService
(
UObject* WorldContextObject, |
Latent action to install AR service on the current platform. | ARDependencyHandler.h |
|
virtual void RequestARSessionPermission
(
UObject* WorldContextObject, |
Latent action to request permission to run the supplied session configuration. | ARDependencyHandler.h |
|
virtual void StartARSessionLatent
(
UObject* WorldContextObject, |
Latent action to start AR session. | ARDependencyHandler.h |
|
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UARDependencyHandler * GetARDependencyHandler() |
ARDependencyHandler.h |
|
|
static FName GetModularFeatureName() |
ARDependencyHandler.h |