UARDependencyHandler

Helper class that allows the user to explicitly request AR service installation and permission granting.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UARDependencyHandler

References

Module

AugmentedReality

Header

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

Include

#include "ARDependencyHandler.h"

Syntax

class UARDependencyHandler :
    public UObject,
    public IModularFeature

Remarks

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.

Functions

Name Description

Public function Virtual

void

 

CheckARServiceAvailability

(
    UObject* WorldContextObject,
    FLatentActionInfo LatentInfo,
    EARServiceAvailability& OutAvailab...
)

Latent action to check AR availability on the current platform.

Public function Static

UARDependenc...

 

GetARDependencyHandler()

Public function Static

FName

 

GetModularFeatureName()

Public function Virtual

void

 

InstallARService

(
    UObject* WorldContextObject,
    FLatentActionInfo LatentInfo,
    EARServiceInstallRequestResult& Ou...
)

Latent action to install AR service on the current platform.

Public function Virtual

void

 

RequestARSessionPermission

(
    UObject* WorldContextObject,
    UARSessionConfig* SessionConfi...,
    FLatentActionInfo LatentInfo,
    EARServicePermissionRequestResult&...
)

Latent action to request permission to run the supplied session configuration.

Public function Virtual

void

 

StartARSessionLatent

(
    UObject* WorldContextObject,
    UARSessionConfig* SessionConfi...,
    FLatentActionInfo LatentInfo
)

Latent action to start AR session.