All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
Engine License Configuration
enum  VuLicenseConfigError : int32_t {
  VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_MISSING_KEY = 0x200 ,
  VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_INVALID_KEY = 0x201 ,
  VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_NO_NETWORK_PERMANENT = 0x202 ,
  VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_NO_NETWORK_TRANSIENT = 0x203 ,
  VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_BAD_REQUEST ,
  VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_KEY_CANCELED = 0x205 ,
  VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_PRODUCT_TYPE_MISMATCH = 0x206 ,
  VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_UNKNOWN = 0x207
}
 License configuration error code type for errors occurring when creating a Vuforia Engine instance. More...
 
VuLicenseConfig vuLicenseConfigDefault ()
 Default license configuration.
 
VuResult vuEngineConfigSetAddLicenseConfig (VuEngineConfigSet *configSet, const VuLicenseConfig *config)
 Add a license configuration to the engine configuration.
 

Detailed Description

Enumeration Type Documentation

◆ VuLicenseConfigError

enum VuLicenseConfigError : int32_t

License configuration error code type for errors occurring when creating a Vuforia Engine instance.

Note
The error code is reported via the errorCode parameter of the vuEngineCreate() function if an error related to applying the license configuration occurs while initializing the new Engine instance.
The Vuforia Engine checks during the creation of the Engine instance whether the license key is valid both with a synchronous and an asynchronous mechanism. If the synchronous mechanism finds a license-related error, then vuEngineCreate() will fail and report one of the VuLicenseConfigError error codes. If only the asynchronous mechanism reports a license-related error, then Engine initialization will finish without a license-related error, but Engine will stop soon afterwards, and any subsequent attempt to call vuEngineStart() will fail.
Enumerator
VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_MISSING_KEY 

License key is missing.

VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_INVALID_KEY 

Invalid license key passed to SDK.

VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_NO_NETWORK_PERMANENT 

Unable to verify license key due to network (Permanent error)

VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_NO_NETWORK_TRANSIENT 

Unable to verify license key due to network (Transient error)

VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_BAD_REQUEST 

Malformed request sent to license server. Please ensure your app has valid name and version fields.

VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_KEY_CANCELED 

Provided key is no longer valid.

VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_PRODUCT_TYPE_MISMATCH 

Provided key is not valid for current product.

VU_ENGINE_CREATION_ERROR_LICENSE_CONFIG_UNKNOWN 

Unknown error.

Function Documentation

◆ vuLicenseConfigDefault()

VuLicenseConfig vuLicenseConfigDefault ( )

Default license configuration.

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