unreal.ARDependencyHandler

class unreal.ARDependencyHandler(outer=None, name='None')

Bases: unreal.Object

Helper class that allows the user to explicitly request AR service installation and permission granting. Recommended flow for explicit management: 1. Call “GetARDependencyHandler” to get a handler, if valid: 2. Call “CheckARServiceAvailability” to check availability, if the device is supported: 3. Call “InstallARService” to install AR service dependency, if installed: 4. Call “RequestARSessionPermission” to request permission, if granted: 5. Call “UARBlueprintLibrary::StartARSession” to start the session. Alternatively, you can also call “StartARSessionLatent” which handles dependency and permission internally.

C++ Source:

  • Module: AugmentedReality

  • File: ARDependencyHandler.h

check_ar_service_availability(world_context_object, latent_info) → ARServiceAvailability

Latent action to check AR availability on the current platform.

Parameters
Returns

out_availability (ARServiceAvailability):

Return type

ARServiceAvailability

classmethod get_ar_dependency_handler() → ARDependencyHandler
Returns

the dependency handler for the current platform. Can return null if the current platform doesn’t support AR, or the AR system doesn’t require dependency handling.

Return type

ARDependencyHandler

install_ar_service(world_context_object, latent_info) → ARServiceInstallRequestResult

Latent action to install AR service on the current platform.

Parameters
Returns

out_install_result (ARServiceInstallRequestResult):

Return type

ARServiceInstallRequestResult

request_ar_session_permission(world_context_object, session_config, latent_info) → ARServicePermissionRequestResult

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

Parameters
Returns

out_permission_result (ARServicePermissionRequestResult):

Return type

ARServicePermissionRequestResult

start_ar_session_latent(world_context_object, session_config, latent_info) → None

Latent action to start AR session. Will make sure dependency and permission issues are resolved internally, only returns the AR session starts successfully.

Parameters