All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
Cloud Image Target Feature

Classes

struct  VuCloudImageTargetConfig
 Configuration for Cloud Image Target observer creation. More...
 
struct  VuCloudImageTargetObservationTargetInfo
 Target info for a Cloud Image Target from its respective observation. More...
 
struct  VuImageTargetCloudObservationConfig
 Configuration for creating an Image Target observer from a Cloud Image Target observation. More...
 

Typedefs

typedef void VuCloudImageTargetObservationsHandler(const VuObservationList *observations, void *clientData)
 Cloud Image Target observation handler.
 
typedef void VuCloudImageTargetQueryErrorHandler(VuCloudImageTargetQueryError queryError, void *clientData)
 Cloud Image Target query error handler.
 

Enumerations

enum  VuCloudImageTargetCreationError : int32_t {
  VU_CLOUD_IMAGE_TARGET_CREATION_ERROR_NONE = 0x0 ,
  VU_CLOUD_IMAGE_TARGET_CREATION_ERROR_INTERNAL = 0x1 ,
  VU_CLOUD_IMAGE_TARGET_CREATION_ERROR_AUTOACTIVATION_FAILED = 0x2 ,
  VU_CLOUD_IMAGE_TARGET_CREATION_ERROR_FEATURE_NOT_SUPPORTED = 0x3 ,
  VU_CLOUD_IMAGE_TARGET_CREATION_ERROR_SERVICE_MISSING_AUTHENTICATION ,
  VU_CLOUD_IMAGE_TARGET_CREATION_ERROR_NO_NETWORK_CONNECTION = 0x5 ,
  VU_CLOUD_IMAGE_TARGET_CREATION_ERROR_SERVICE_NOT_AVAILABLE = 0x6
}
 Configuration error for Cloud Image Target Observer creation. More...
 
enum  VuCloudImageTargetQueryError : int32_t {
  VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_NONE = 0x0 ,
  VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_AUTHORIZATION_FAILED = 0x1 ,
  VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_PROJECT_SUSPENDED = 0x2 ,
  VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_NO_NETWORK_CONNECTION = 0x3 ,
  VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_SERVICE_NOT_AVAILABLE = 0x4 ,
  VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_BAD_FRAME_QUALITY = 0x5 ,
  VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_UPDATE_SDK = 0x6 ,
  VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_TIMESTAMP_OUT_OF_RANGE = 0x7 ,
  VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_REQUEST_TIMEOUT = 0x8
}
 Cloud Image Target query errors. More...
 
enum  { VU_OBSERVER_CLOUD_IMAGE_TARGET_TYPE = 0xA }
 
enum  { VU_OBSERVATION_CLOUD_IMAGE_TARGET_TYPE = 0xA }
 
enum  VuImageTargetCloudObservationCreationError : int32_t {
  VU_IMAGE_TARGET_CLOUD_OBSERVATION_ERROR_NONE = 0x0 ,
  VU_IMAGE_TARGET_CLOUD_OBSERVATION_ERROR_INTERNAL = 0x1 ,
  VU_IMAGE_TARGET_CLOUD_OBSERVATION_ERROR_INVALID_SCALE = 0x2
}
 Configuration error for Image Target creation with Cloud Observation. More...
 

Functions

VuCloudImageTargetConfig vuCloudImageTargetConfigDefault ()
 Default Cloud Image Target observer configuration.
 
VuResult vuEngineCreateCloudImageTargetObserver (VuEngine *engine, VuObserver **observer, const VuCloudImageTargetConfig *config, VuCloudImageTargetCreationError *errorCode)
 Create a Cloud Image Target observer.
 
VuResult vuEngineGetCloudImageTargetObservers (const VuEngine *engine, VuObserverList *observerList)
 Get all Cloud Image Target observers.
 
VuResult vuCloudImageTargetObserverRegisterHandlers (VuObserver *observer, VuCloudImageTargetObservationsHandler *observationHandler, VuCloudImageTargetQueryErrorHandler *errorHandler, void *clientData)
 Register handlers for Cloud Image Targets.
 
VuBool vuCloudImageTargetObserverIsRequesting (const VuObserver *observer)
 Returns whether the Cloud Image Target observer is currently performing a cloud request.
 
VuResult vuCloudImageTargetObservationGetTargetInfo (const VuObservation *observation, VuCloudImageTargetObservationTargetInfo *targetInfo)
 Get target info associated with a Cloud Image Target observation.
 
VuImageTargetCloudObservationConfig vuImageTargetCloudObservationConfigDefault ()
 Default configuration for creating an Image Target observer from a Cloud Image Target observation.
 
VuResult vuEngineCreateImageTargetObserverFromCloudObservation (VuEngine *engine, VuObserver **observer, const VuImageTargetCloudObservationConfig *config, VuImageTargetCloudObservationCreationError *errorCode)
 Create an Image Target observer from a Cloud Image Target observation.
 

Detailed Description

Enumeration Type Documentation

◆ VuCloudImageTargetCreationError

Configuration error for Cloud Image Target Observer creation.

Enumerator
VU_CLOUD_IMAGE_TARGET_CREATION_ERROR_NONE 

No error.

VU_CLOUD_IMAGE_TARGET_CREATION_ERROR_INTERNAL 

An internal error occurred while creating the observer.

VU_CLOUD_IMAGE_TARGET_CREATION_ERROR_AUTOACTIVATION_FAILED 

An error occurred while auto-activating the observer.

VU_CLOUD_IMAGE_TARGET_CREATION_ERROR_FEATURE_NOT_SUPPORTED 

Feature is not supported by the current license.

VU_CLOUD_IMAGE_TARGET_CREATION_ERROR_SERVICE_MISSING_AUTHENTICATION 

Missing authentication details (user authentication or authentication secret)

VU_CLOUD_IMAGE_TARGET_CREATION_ERROR_NO_NETWORK_CONNECTION 

No network connection.

VU_CLOUD_IMAGE_TARGET_CREATION_ERROR_SERVICE_NOT_AVAILABLE 

Service is not available.

◆ VuCloudImageTargetQueryError

Cloud Image Target query errors.

Enumerator
VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_NONE 

No error.

VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_AUTHORIZATION_FAILED 

Credentials are wrong or outdated.

VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_PROJECT_SUSPENDED 

The specified project was suspended.

VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_NO_NETWORK_CONNECTION 

Device has no network connection.

VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_SERVICE_NOT_AVAILABLE 

Server not found, down or overloaded.

VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_BAD_FRAME_QUALITY 

Low frame quality has been continuously observed.

VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_UPDATE_SDK 

SDK Version outdated.

VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_TIMESTAMP_OUT_OF_RANGE 

Client/Server clocks too far away.

VU_CLOUD_IMAGE_TARGET_QUERY_ERROR_REQUEST_TIMEOUT 

No response to network request after timeout.

◆ anonymous enum

anonymous enum
Enumerator
VU_OBSERVER_CLOUD_IMAGE_TARGET_TYPE 

Type identifier for Cloud Image Target observers.

◆ anonymous enum

anonymous enum
Enumerator
VU_OBSERVATION_CLOUD_IMAGE_TARGET_TYPE 

Type identifier for Cloud Image Target observations.

◆ VuImageTargetCloudObservationCreationError

Configuration error for Image Target creation with Cloud Observation.

Enumerator
VU_IMAGE_TARGET_CLOUD_OBSERVATION_ERROR_NONE 

No error.

VU_IMAGE_TARGET_CLOUD_OBSERVATION_ERROR_INTERNAL 

Internal error.

VU_IMAGE_TARGET_CLOUD_OBSERVATION_ERROR_INVALID_SCALE 

Invalid value passed to the scale parameter.

Function Documentation

◆ vuCloudImageTargetConfigDefault()

VuCloudImageTargetConfig vuCloudImageTargetConfigDefault ( )

Default Cloud Image Target observer configuration.

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

◆ vuEngineCreateCloudImageTargetObserver()

VuResult vuEngineCreateCloudImageTargetObserver ( VuEngine * engine,
VuObserver ** observer,
const VuCloudImageTargetConfig * config,
VuCloudImageTargetCreationError * errorCode )

Create a Cloud Image Target observer.

This observer supports the recognition of Image Targets using cloud-based recognition. The creation process requires an active network connection and runs asynchronously. After the observer has been created, activating the observer starts continuous recognition of Image Targets in the camera feed. Search results are reported via a registered observation handler function (see VuCloudImageTargetObservationsHandler), whereas query errors are reported via a registered query error handler function (see VuCloudImageTargetQueryErrorHandler). Both of them are registered by calling vuCloudImageTargetObserverRegisterHandlers(). The VuCloudImageTargetObservation reported by the respective handler function represents a known Image Target that the cloud-based image recognition system has detected in the camera feed. You can inspect information about the detected targets by calling the vuCloudImageTargetObservationGetTargetInfo function.

◆ vuCloudImageTargetObserverRegisterHandlers()

VuResult vuCloudImageTargetObserverRegisterHandlers ( VuObserver * observer,
VuCloudImageTargetObservationsHandler * observationHandler,
VuCloudImageTargetQueryErrorHandler * errorHandler,
void * clientData )

Register handlers for Cloud Image Targets.

The observation handler is triggered whenever new observations are reported back by the Cloud Image Target observer. The client may choose to call "vuEngineCreateImageTargetObserverFromCloudObservation()" to start tracking the image.

The error handler is triggered whenever an error gets reported by the Cloud Image Target observer.

Note
The handlers are triggered on the thread that pushes a notification about a new Vuforia State and that the client can register for by calling "vuEngineRegisterStateHandler()".
The list of observations delivered through the observation handler is only valid for the duration of the callback. Storing and accessing the list of it's elements after the callback has finished results in undefined behavior.
Passing a new handler will overwrite the previous handler. Passing NULL will disable updates for the respective handler.
Parameters
observerThe Cloud Image Target observer to register the handlers for
observationHandlerThe handler for receiving Cloud Image Target observation updates
errorHandlerThe handler for receiving Cloud Image Target query-related error updates
clientDataThe client data to pass with the observation and error updates
Returns
VU_SUCCESS on success, VU_FALSE on failure.

◆ vuImageTargetCloudObservationConfigDefault()

VuImageTargetCloudObservationConfig vuImageTargetCloudObservationConfigDefault ( )

Default configuration for creating an Image Target observer from a Cloud Image Target observation.

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