C API Unity API
C API Reference (Version 10.22.5)
Classes | Enumerations | Functions
Engine Error Handler Configuration
Engine Configuration

Classes

struct  VuErrorHandlerConfig
 Data structure to configure the handling of Engine lifecycle-related errors via a callback after the Engine instance has been created. More...
 

Enumerations

enum  VuEngineError : int32_t {
  VU_ENGINE_ERROR_INVALID_LICENSE = 0x600,
  VU_ENGINE_ERROR_CAMERA_DEVICE_LOST = 0x601,
  VU_ENGINE_ERROR_PLATFORM_FUSION_PROVIDER_INFO_INVALIDATED = 0x602
}
 Error codes for Engine lifecycle-related errors reported via the VuErrorHandler error handler function. More...
 

Functions

typedef void (VuErrorHandler(VuEngineError errorCode, void *clientData))
 Handler function type to report an Engine lifecycle-related error asynchronously.
 
VuErrorHandlerConfig vuErrorHandlerConfigDefault ()
 Default error handler configuration. More...
 
VuResult vuEngineConfigSetAddErrorHandlerConfig (VuEngineConfigSet *configSet, const VuErrorHandlerConfig *config)
 Add error handler configuration to the engine configuration to handle errors that impact the Engine lifecycle and occur asynchronously after the Engine instance has been created.
 

Detailed Description

Enumeration Type Documentation

◆ VuEngineError

enum VuEngineError : int32_t

Error codes for Engine lifecycle-related errors reported via the VuErrorHandler error handler function.

Enumerator
VU_ENGINE_ERROR_INVALID_LICENSE 

License key validation has failed, Engine has stopped.

VU_ENGINE_ERROR_CAMERA_DEVICE_LOST 

The operating system has reported that the camera device has become unavailable to Vuforia and therefore Engine has stopped. This may be because of a device error or another App or user action has caused the operating system to close Engine's connection to the camera.

VU_ENGINE_ERROR_PLATFORM_FUSION_PROVIDER_INFO_INVALIDATED 

This error can only happen on Android when using ARCore. 

                                                                 If ARCore Fusion Provider info was retrieved previously via
                                                                 \ref vuPlatformControllerGetARCoreInfo, this will be invalidated
                                                                 (including all platform pointers) after the callback has
                                                                 returned and should not be accessed any more after that (as this
                                                                 might lead to undefined behavior). The info must be retrieved
                                                                 again.

                                                                 \note All the ARCore entities previously created by using these
                                                                 pointers directly (such as anchors, planes) will also become
                                                                 invalid and so must be created again.

                                                                 \see The \ref VuPlatformARCoreInfo documentation.

Function Documentation

◆ vuErrorHandlerConfigDefault()

VuErrorHandlerConfig vuErrorHandlerConfigDefault ( )

Default error handler configuration.

Note
Use this function to initialize the VuErrorHandlerConfig data structure with default values.