C API Unity API
Unity API Reference
Vuforia Namespace Reference

Namespaces

namespace  Internal
 

Classes

class  AnchorBehaviour
 An anchor that helps stabilize a GameObjects position in the real world More...
 
class  AnchorInputListenerBehaviour
 Provides a convenient way of capturing user interaction (mouse click or screen tap) and forwarding it to another component, e.g. the ContentPositioningBehaviour More...
 
class  AreaTargetBehaviour
 This class serves both as an augmentation definition for an AreaTarget in the editor as well as a tracked AreaTarget result at runtime More...
 
class  AreaTargetCaptureBehaviour
 
class  CameraDevice
 Represents the physical camera used to capture the real world More...
 
class  CloudRecoBehaviour
 This is the main behaviour class that encapsulates cloud recognition behaviour. It just has to be added to a Vuforia-enabled Unity scene and will initialize the target finder and wait for new results. State changes and new results will be sent to registered ICloudRecoEventHandlers More...
 
class  ContentPlacedEvent
 
class  ContentPositioningBehaviour
 This class provides convenience methods for anchoring content in the real world. Can be used in combination with the PlaneFinderBehaviour or MidAirPositionerBehaviour to easily place content on a plane or at 3d coordinates More...
 
class  CylinderTargetBehaviour
 This class serves both as an augmentation definition for a CylinderTarget in the editor as well as a tracked CylinderTarget result at runtime More...
 
class  DataSetTrackableBehaviour
 This is the base class for all behaviours observing targets that are part of a dataset More...
 
class  DevicePoseBehaviour
 Represents the device, such as a phone or a digital eyewear device, of which a position is tracked enabling/disabling the Device MonoBehaviour causes the device to start/stop being tracked More...
 
class  GLTFModelCreator
 
class  GuideView
 This class represents a Guide View which can be extracted from the DataSet More...
 
class  GuideView2DBehaviour
 Class representing a 2D Guide View for Model Target Detection. More...
 
class  GuideView3DBehaviour
 Class representing a 3D Guide View for Model Target Detection. More...
 
class  GuideViewCameraBehaviour
 This class represents a Guide View Camera, which can be used to configure the guide view pose for detection of a Model Target. When attaching this component to a game object, a Camera will be created automatically. This Camera is only used at Editor time to faciliate the Application developer to adjust the Pose visually by looking at the Camera preview. At runtime, the Camera component will be automatically disabled. More...
 
class  GuideViewRenderingBehaviour
 Class handling the activation/update/rendering of the Guide View for Model Target detection. More...
 
class  HitTestEvent
 An Event that passes a HitTestResult after a performed hit test. HitTestResult can be null. More...
 
class  HitTestResult
 The result of performing a hit test in the world More...
 
class  IlluminationData
 Provides realtime data of real-world illumination calculations by ARKit, when used by Vuforia Fusion More...
 
class  Image
 Representation of an image, typically returned by the CameraDevice. More...
 
class  ImageDescription
 
class  ImageTargetBehaviour
 This class serves both as an augmentation definition for an ImageTarget in the editor as well as a tracked image target result at runtime More...
 
interface  ISessionRecorder
 The session recorder allows the user to record Vuforia sessions for playback in the editor and on a device More...
 
class  MaskOutBehaviour
 
class  MeshSetModelCreator
 
class  MidAirPositionerBehaviour
 This class is best used in combination with the AnchorInputListenerBehaviour and the ContentPositioningBehaviour as it provides sanitation of the input and forwards the result to the ContentPositioningBehaviour for mid-air anchor placement More...
 
class  ModelTargetBehaviour
 This class serves both as an augmentation definition for a ModelTarget in the editor as well as a tracked ModelTarget result at runtime More...
 
class  MultiTargetBehaviour
 This class serves both as an augmentation definition for a MultiTarget in the editor as well as a tracked MultiTarget result at runtime More...
 
class  ObserverBehaviour
 The base class of all observer behaviour components. Provides access to base functionality and information of the observer More...
 
class  ObserverFactory
 Provides methods to create Vuforia tracked targets More...
 
class  PlaneFinderBehaviour
 This component provides convenience functionality for typical use cases of detecting a plane and showing a preview of where content would be placed on that plane. Can also be used to perform manual hit tests More...
 
struct  RecordingSources
 The sources of data the session recorder can use. More...
 
struct  RectangleData
 This struct defines the 2D coordinates of a rectangle. The struct is internally used for setting Virtual Buttons or getting bounding boxes of letters. More...
 
class  ScalableDataSetTrackableBehaviour
 This is the base class for all trackables that are part of a dataset and are scalable More...
 
class  SessionRecorder
 The session recorder allows the user to record Vuforia sessions for playback in the editor and on a device More...
 
class  SessionRecorderBehaviour
 The session recorder allows the user to record Vuforia sessions for playback in the editor and on a device More...
 
class  SmartTerrainBehaviour
 
struct  TargetStatus
 Includes tracking status and tracking information of a target More...
 
class  TurnOffBehaviour
 A utility behaviour to disable rendering of a game object at run time. More...
 
class  VideoBackground
 Provides access to VideoBackground rendering specific features More...
 
struct  VideoModeData
 This struct stores video mode data. This includes the width and height of the frame and the framerate of the camera. More...
 
class  VirtualButtonBehaviour
 This behaviour associates a Virtual Button with a game object. Use the functionality in ImageTargetBehaviour to create and destroy Virtual Buttons at run-time. More...
 
class  VuforiaApplication
 The VuforiaApplication class provides a way to initialize and deinitialize Vuforia as well register to lifecycle events More...
 
class  VuforiaAugmentationRenderer
 Special Augmentations which need custom render-(dis/en)abling are inherited from this class More...
 
class  VuforiaBehaviour
 The central Vuforia class. Allows to start and stop the engine and provides access to the current state and physical camera among other things. More...
 
class  VuforiaConfiguration
 Global settings for Vuforia which are used for all scenes More...
 
class  VuforiaMonoBehaviour
 This is the base class for all MonoBehaviours that are used in Vuforia. If no Behaviours of this type are found in a scene, the VuforiaBehaviour will not be automatically attached at runtime. This means no VideoBackground is rendered. More...
 
class  VuforiaRuntimeUtilities
 A utility class containing various helper methods More...
 
class  VuMarkBehaviour
 This class serves both as an augmentation definition for a VuMark in the editor as well as a tracked VuMark result at runtime More...
 
interface  VuMarkInstanceId
 The InstanceId contains the id for a particular VuMark. More...
 
class  World
 Provides functions to perform hit tests and create anchors in the world More...
 

Enumerations

enum  AreaTargetCaptureCreationError {
  NONE = 0x0,
  INTERNAL = 0x1,
  AUTOSTART_FAILED,
  FEATURE_NOT_SUPPORTED,
  MULTIPLE_INSTANCES_NOT_SUPPORTED,
  INVALID_DEVICE_POSE_OBSERVER
}
 Area Target Capture creation error More...
 
enum  AreaTargetCaptureGenerationError {
  NONE = 0x0,
  INTERNAL = 0x1,
  ENGINE_NOT_RUNNING = 0x2,
  INVALID_STATUS = 0x3,
  INSUFFICIENT_DATA = 0x4,
  MISSING_AUTHENTICATION = 0x5,
  INVALID_OUTPUT_DIRECTORY = 0x6,
  INVALID_TARGET_NAME = 0x7,
  AUTHORING_FILES_GENERATION_REQUIRED = 0x8,
  DATABASE_GENERATION_REQUIRED = 0x9
}
 Area Target Capture generation error More...
 
enum  AreaTargetCaptureStatus {
  INITIALIZED = 0x1,
  PREPARING = 0x2,
  CAPTURING = 0x3,
  PAUSED = 0x4,
  STOPPED = 0x5,
  GENERATING = 0x6
}
 
enum  AreaTargetCaptureStatusInfo {
  NORMAL = 0x01,
  RELOCALIZING = 0x02,
  EXCESSIVE_MOTION = 0x03,
  CAPACITY_WARNING = 0x04,
  INTERRUPTED = 0x05,
  SUSPENDED = 0x06,
  TRACKING_DATA_GENERATION = 0x07,
  AUTHORING_DATA_GENERATION = 0x08,
  DEVICE_DATABASE_GENERATION = 0x09,
  PACKAGE_GENERATION = 0x0A,
  GENERATION_SUCCESS = 0x0B,
  GENERATION_CANCELED = 0x0C,
  GENERATION_ERROR_INTERNAL = 0x0D,
  GENERATION_ERROR_NO_NETWORK_CONNECTION = 0x0E,
  GENERATION_ERROR_SERVICE_NOT_AVAILABLE = 0x0F,
  GENERATION_ERROR_AUTHORIZATION_FAILED = 0x10
}
 
enum  CameraMode {
  MODE_DEFAULT = -1,
  MODE_OPTIMIZE_SPEED = -2,
  MODE_OPTIMIZE_QUALITY = -3
}
 The mode used for camera capturing and video rendering. The camera device mode is set through the Unity inspector. More...
 
enum  DriverPixelFormat : int {
  UNKNOWN = 0,
  YUYV = 1,
  NV12 = 2,
  NV21 = 3,
  RGB888,
  RGBA8888
}
 A list of the supported pixel formats by the driver for camera frames. More...
 
enum  FocusMode {
  FOCUS_MODE_NORMAL,
  FOCUS_MODE_TRIGGERAUTO,
  FOCUS_MODE_CONTINUOUSAUTO,
  FOCUS_MODE_INFINITY,
  FOCUS_MODE_MACRO
}
 The different focus modes for the active camera More...
 
enum  FusionProviderOption {
  PREFER_PLATFORM_FUSION_PROVIDER,
  VUFORIA_FUSION_ONLY
}
 Options for the Fusion Provider configuration. Use VuforiaApplication.Instance.Initialize(FusionProviderOption) to initialize Vuforia with the selected configuration. More...
 
enum  FusionProviderType {
  UNKNOWN = 1,
  VISION_ONLY = 2,
  SENSOR_FUSION = 3,
  PLATFORM_SENSOR_FUSION = 4
}
 Used when calling GetActiveFusionProvider() More...
 
enum  HitTestMode {
  AUTOMATIC,
  INTERACTIVE
}
 The mode in which the surface is found. Automatic is used to perform a hit test from the screen center periodically. Interactive is used to perform a hit test on manual input (touch, mouse) More...
 
enum  ImageTargetType {
  PREDEFINED = 0,
  CLOUD_RECO = 2,
  INSTANT = 3,
  UNKNOWN = int.MaxValue
}
 The type of an ImageTarget. An ImageTarget can be predefined in a dataset, created at runtime as a user defined target, or fetched at runtime via cloud recognition More...
 
enum  InstanceIdType {
  BYTE = 0,
  STRING = 1,
  NUMERIC = 2
}
 VuMark ID Type More...
 
enum  ModelTargetMode {
  DEFAULT,
  CARS
}
 Model Target tracking modes to optimize tracking quality and robustness for different target types More...
 
enum  PixelFormat {
  UNKNOWN_FORMAT = 1,
  RGB565 = 2,
  RGB888 = 3,
  GRAYSCALE = 4,
  RGBA8888 = 5,
  NV21 = 6,
  NV12 = 7,
  YV12 = 8,
  YUV420P = 9,
  YUYV = 10
}
 Pixel encoding types More...
 
enum  PlayModeType {
  WEBCAM,
  SIMULATOR,
  RECORDING
}
 
enum  RecordingSource {
  VIDEO = 0x01,
  CAMERA_METADATA = 0x02,
  SENSORS = 0x04,
  DEVICE_POSE = 0x08,
  AUDIO = 0x10
}
 The sources of data the session recorder can use. More...
 
enum  RecordingStartError {
  NONE = 0,
  INTERNAL = 1,
  ANOTHER_RECORDING_RUNNING = 2,
  ENGINE_NOT_RUNNING = 3,
  INVALID_STATUS = 4,
  FILE_CREATION = 5,
  UNKNOWN_ORIENTATION = 6,
  DATA_SOURCE = 7,
  INSUFFICIENT_FREE_SPACE = 8,
  DATA_FLAGS_NOT_SUPPORTED = 9,
  UNITY_PLAYMODE_NOT_SUPPORTED = 100
}
 Recording start error. More...
 
enum  RecordingStatus {
  INITIALIZED = 1,
  RUNNING = 2,
  STOPPED = 3,
  COMPLETED = STOPPED,
  SOURCES_NOT_AVAILABLE = 4,
  STORAGE_LOCATION_RETRIEVAL_ERROR = 5,
  SOURCE_OPERATION_ERROR = 6,
  INSUFFICIENT_FREE_SPACE = 7,
  ORIENTATION_NOT_SUPPORTED = 8,
  ANOTHER_RECORDING_RUNNING = 9,
  UNITY_PLAYMODE_NOT_SUPPORTED = 10
}
 Status of the session recorder. More...
 
enum  RecordingStatusInfo {
  NORMAL = 0,
  SUCCESS = 1,
  ERROR_INTERNAL = 2,
  ERROR_ORIENTATION_CHANGED = 3,
  ERROR_DATA_SOURCE = 4,
  ERROR_INSUFFICIENT_FREE_SPACE = 5
}
 Session recording status info. More...
 
enum  Sensitivity {
  HIGH,
  MEDIUM,
  LOW
}
 The sensitivity of this virtual button. This is a trade off between fast detection and robustness again accidental occlusion. More...
 
enum  Status {
  NO_POSE = 0,
  LIMITED = 1,
  TRACKED = 3,
  EXTENDED_TRACKED = 4
}
 The tracking status of the TrackableBehaviour. More...
 
enum  StatusInfo {
  NORMAL = 0,
  NOT_OBSERVED = 1,
  UNKNOWN = 2,
  INITIALIZING = 3,
  RELOCALIZING = 4,
  EXCESSIVE_MOTION = 5,
  INSUFFICIENT_FEATURES = 6,
  INSUFFICIENT_LIGHT = 7,
  RECOMMENDING_GUIDANCE = 8,
  WRONG_SCALE = 9
}
 Information on the tracking status. Gives the primary reason about the problem with tracking (STATUS::NO_POSE or STATUS::LIMITED). More...
 
enum  StorageType {
  APP = 1,
  APP_RESOURCE = 2,
  ABSOLUTE = 3
}
 Storage type is used to interpret a given path string. More...
 
enum  TrackingOptimization {
  DEFAULT,
  LOW_FEATURE_OBJECTS,
  AR_CONTROLLER
}
 Optimize tracking quality and robustness for different target types More...
 
enum  VirtualButtonSensitivity {
  HIGH,
  MEDIUM,
  LOW
}
 The sensitivity of this virtual button. This is a trade off between fast detection and robustness again accidental occlusion. More...
 
enum  VuforiaInitError {
  NONE = 0x0,
  INIT_SUCCESS = NONE,
  DEVICE_NOT_SUPPORTED = 0x1,
  INIT_EXTERNAL_DEVICE_NOT_DETECTED = DEVICE_NOT_SUPPORTED,
  PERMISSION_ERROR = 0x2,
  INIT_NO_CAMERA_ACCESS = PERMISSION_ERROR,
  LICENSE_ERROR = 0x3,
  INITIALIZATION = 0x4,
  INIT_ERROR = INITIALIZATION,
  DRIVER_CONFIG_LIBRARY_NOT_FOUND = 0x100,
  DRIVER_CONFIG_LOAD_ERROR = 0x101,
  INIT_VUFORIA_DRIVER_FAILED = DRIVER_CONFIG_LOAD_ERROR,
  DRIVER_CONFIG_FEATURE_NOT_SUPPORTED = 0x102,
  LICENSE_CONFIG_MISSING_KEY = 0x200,
  INIT_LICENSE_ERROR_MISSING_KEY = LICENSE_CONFIG_MISSING_KEY,
  LICENSE_CONFIG_INVALID_KEY = 0x201,
  INIT_LICENSE_ERROR_INVALID_KEY = LICENSE_CONFIG_INVALID_KEY,
  LICENSE_CONFIG_NO_NETWORK_PERMANENT = 0x202,
  INIT_LICENSE_ERROR_NO_NETWORK_PERMANENT = LICENSE_CONFIG_NO_NETWORK_PERMANENT,
  LICENSE_CONFIG_NO_NETWORK_TRANSIENT = 0x203,
  INIT_LICENSE_ERROR_NO_NETWORK_TRANSIENT = LICENSE_CONFIG_NO_NETWORK_TRANSIENT,
  LICENSE_CONFIG_BAD_REQUEST = 0x204,
  INIT_LICENSE_ERROR_BAD_REQUEST = LICENSE_CONFIG_BAD_REQUEST,
  LICENSE_CONFIG_KEY_CANCELED = 0x205,
  INIT_LICENSE_ERROR_CANCELED_KEY = LICENSE_CONFIG_KEY_CANCELED,
  LICENSE_CONFIG_PRODUCT_TYPE_MISMATCH = 0x206,
  INIT_LICENSE_ERROR_PRODUCT_TYPE_MISMATCH = LICENSE_CONFIG_PRODUCT_TYPE_MISMATCH,
  LICENSE_CONFIG_UNKNOWN = 0x207,
  PLATFORM_ANDROID_CONFIG_INITIALIZATION_ERROR = 0x510,
  PLATFORM_ANDROID_CONFIG_INVALID_ACTIVITY = 0x511,
  PLATFORM_ANDROID_CONFIG_INVALID_JAVA_VM = 0x512
}
 VuforiaInitError is an error value that is returned by Vuforia if something goes wrong at initialization. More...
 
enum  WorldCenterMode {
  SPECIFIC_TARGET,
  FIRST_TARGET,
  DEVICE
}
 The world center mode defines how the relative coordinates between Trackables and camera are translated into Unity world coordinates. If a world center is present the virtual camera in the Unity scene is transformed with respect to that. The world center mode is set through the Unity inspector. More...
 

Enumeration Type Documentation

◆ AreaTargetCaptureCreationError

Area Target Capture creation error

Enumerator
NONE 

No error

INTERNAL 

An internal error occurred while creating the capture

AUTOSTART_FAILED 

Immediate start of the capture failed

FEATURE_NOT_SUPPORTED 

Feature is not supported on the current device

MULTIPLE_INSTANCES_NOT_SUPPORTED 

Multiple captures are not allowed to exist at the same time

INVALID_DEVICE_POSE_OBSERVER 

DevicePose Observer is null or invalid

◆ AreaTargetCaptureGenerationError

Area Target Capture generation error

Enumerator
NONE 

No error

INTERNAL 

An internal error occurred

ENGINE_NOT_RUNNING 

Generation failed because Engine is not running

INVALID_STATUS 

Generation is not allowed because the capture is in the wrong status

INSUFFICIENT_DATA 

Generation failed because the capture has not yet created an initial reconstruction of the environment

MISSING_AUTHENTICATION 

Generation failed because authentication details are missing (user authentication or authentication secret)

INVALID_OUTPUT_DIRECTORY 

Generation failed because the output directory does not exist or can not be written to

INVALID_TARGET_NAME 

Generation failed because the target name does not satisfy requirements

AUTHORING_FILES_GENERATION_REQUIRED 

Generation failed because authoring files generation is required, but was not enabled

DATABASE_GENERATION_REQUIRED 

Generation failed because database generation is required, but was not enabled

◆ AreaTargetCaptureStatus

Enumerator
INITIALIZED 

The capture has been created and can be started

PREPARING 

Reconstruction of the environment is running, not able to generate a target yet

CAPTURING 

Basic reconstruction is done, generation possible, capturing more data

PAUSED 

Reconstruction of the environment has been paused

STOPPED 

Reconstruction of the environment has been stopped

GENERATING 

Target generation from captured data

◆ AreaTargetCaptureStatusInfo

Enumerator
NORMAL 

The capture is running normally

RELOCALIZING 

The capture is relocalizing, the user should move around or return towards a previously mapped area in order to resume normal capturing

EXCESSIVE_MOTION 

The user is moving too quickly

CAPACITY_WARNING 

The capture is removing old data to make room for new data and should be stopped soon

INTERRUPTED 

The capture is unable to add new data, the user should stop the capture

SUSPENDED 

The capture was paused automatically by Engine, all operations will fail until Engine resumes the capture

TRACKING_DATA_GENERATION 

The capture is processing the captured data

AUTHORING_DATA_GENERATION 

The capture is generating the authoring artifacts (3dt, glb)

DEVICE_DATABASE_GENERATION 

The capture is generating the Vuforia device database (dat, xml)

PACKAGE_GENERATION 

The capture is generating the package(s)

GENERATION_SUCCESS 

Generation successful

GENERATION_CANCELED 

Generation was canceled

GENERATION_ERROR_INTERNAL 

Generation failed because an internal error occurred

GENERATION_ERROR_NO_NETWORK_CONNECTION 

Generation failed because the device has no network connection

GENERATION_ERROR_SERVICE_NOT_AVAILABLE 

Generation failed because the server was not found, is unreachable, or overloaded

GENERATION_ERROR_AUTHORIZATION_FAILED 

Generation failed because the credentials are wrong or outdated

◆ CameraMode

enum CameraMode
strong

The mode used for camera capturing and video rendering. The camera device mode is set through the Unity inspector.

Enumerator
MODE_DEFAULT 

Best compromise between speed and quality.

MODE_OPTIMIZE_SPEED 

Optimize for speed. Quality of the video background could suffer.

MODE_OPTIMIZE_QUALITY 

Optimize for quality. Application performance could go down.

◆ DriverPixelFormat

enum DriverPixelFormat : int
strong

A list of the supported pixel formats by the driver for camera frames.

Enumerator
UNKNOWN 

Unknown format.

YUYV 

YUV 4:2:2. Single 16bit interleaved plane. Same as YUY2.

NV12 

YUV 4:2:0. 8bit Y plane + 8bit interleaved UV plane (subsampled 2x2).

NV21 

YUV 4:2:0. 8bit Y plane + 8bit interleaved VU plane (subsampled 2x2).

RGB888 

RGB. 24-bits in 3 channels, 8 bits per channel.

RGBA8888 

RGB. 32-bits in 4 channels, 8 bits per channel.

◆ FocusMode

enum FocusMode
strong

The different focus modes for the active camera

Enumerator
FOCUS_MODE_NORMAL 

Default focus mode

FOCUS_MODE_TRIGGERAUTO 

Triggers a single autofocus operation

FOCUS_MODE_CONTINUOUSAUTO 

Continuous autofocus mode

FOCUS_MODE_INFINITY 

Focus set to infinity

FOCUS_MODE_MACRO 

Macro mode for close-up focus

◆ FusionProviderOption

enum FusionProviderOption
strong

Options for the Fusion Provider configuration. Use VuforiaApplication.Instance.Initialize(FusionProviderOption) to initialize Vuforia with the selected configuration.

Enumerator
PREFER_PLATFORM_FUSION_PROVIDER 

When initializing Vuforia, try to use the platform Fusion Provider. If not supported by the device, Vuforia will automatically fallback to the next best configuration available.

VUFORIA_FUSION_ONLY 

When initializing Vuforia, do not try to use the platform Fusion Provider and use the Vuforia Fusion Provider instead.

◆ FusionProviderType

enum FusionProviderType
strong

Used when calling GetActiveFusionProvider()

Vuforia Fusion is a capability, introduced with Vuforia 7, that is designed to provide the best possible AR experience on a wide range of devices. Fusion solves the problem of fragmentation in AR-enabling technologies, including cameras, sensors, chipsets, and software frameworks such as ARKit, ARCore and Windows Holographic. It senses the capabilities of the underlying device and fuses them with Vuforia features, allowing developers to rely on a single Vuforia API for an optimal AR experience.

The FusionProviderType enums provide advanced developers with a way to control which technologies Fusion will use. Developers using these APIs should be aware:

  • of the functionality provided by the underlying platforms
  • of the technology involved in enabling AR
  • of the robustness of the various options
  • that features such as GroundPlane will cease to work. ModelTargets will operate in a less robust manner if VUFORIA_VISION_ONLY is selected.
Enumerator
UNKNOWN 

Fusion provider is unknown.

VISION_ONLY 

Use vision-based Fusion only. Please note that not all Vuforia Engine features are supported when using this provider.

SENSOR_FUSION 

Use Vuforia-provided technology for Fusion. Vuforia Engine will make use of camera and IMU information to try to create a tracking experience that, when compared to vision-only, is more robust to erratic motions and sparse or featureless environments.

PLATFORM_SENSOR_FUSION 

Use platform-provided technology for Fusion. Vuforia Engine will make use of tracking services offered by the underlying platform, such as ARKit on iOS, ARCore on Android, or Windows Holographic on UWP.

◆ HitTestMode

enum HitTestMode
strong

The mode in which the surface is found. Automatic is used to perform a hit test from the screen center periodically. Interactive is used to perform a hit test on manual input (touch, mouse)

Enumerator
AUTOMATIC 
INTERACTIVE 

◆ ImageTargetType

enum ImageTargetType
strong

The type of an ImageTarget. An ImageTarget can be predefined in a dataset, created at runtime as a user defined target, or fetched at runtime via cloud recognition

Enumerator
PREDEFINED 
CLOUD_RECO 
INSTANT 
UNKNOWN 

◆ InstanceIdType

enum InstanceIdType
strong

VuMark ID Type

Enumerator
BYTE 

Generic byte data, stored in little-endian order in the buffer. For example, and ID of 0x123456 would appear as { 0x56, 0x34, 0x12 }

STRING 

Printable ASCII string data.

NUMERIC 

Numeric data, no larger than a 64 bit unsigned long long.

◆ ModelTargetMode

enum ModelTargetMode
strong

Model Target tracking modes to optimize tracking quality and robustness for different target types

Enumerator
DEFAULT 

Model Target tracking parameters optimized to work well on a broad range of object types

CARS 

Model Target tracking parameters optimized for car exteriors.

◆ PixelFormat

enum PixelFormat
strong

Pixel encoding types

Enumerator
UNKNOWN_FORMAT 

Unknown format - default pixel type for undefined images

RGB565 

A color pixel stored in 2 bytes using 5 bits for red, 6 bits for green and 5 bits for blue

RGB888 

A color pixel stored in 3 bytes using 8 bits each

GRAYSCALE 

A grayscale pixel stored in one byte

RGBA8888 

A color pixel stored in 4 bytes using 8 bits each

NV21 

A color pixel stored in 12 or more bits using Y, U and V planes

NV12 

A color pixel stored in 12 or more bits using Y, U and V planes

YV12 

A color pixel stored in 12 or more bits using discreet Y, U and V planes

YUV420P 

A color pixel stored in 12 or more bits using discreet Y, U and V planes

YUYV 

A color pixel stored in 12 or more bits using interleaved Y, U and V planes

◆ PlayModeType

enum PlayModeType
strong
Enumerator
WEBCAM 
SIMULATOR 
RECORDING 

◆ RecordingSource

enum RecordingSource
strong

The sources of data the session recorder can use.

Enumerator
VIDEO 
CAMERA_METADATA 
SENSORS 
DEVICE_POSE 
AUDIO 

◆ RecordingStartError

enum RecordingStartError
strong

Recording start error.

Enumerator
NONE 

No error

INTERNAL 

Starting failed due to an internal error

ANOTHER_RECORDING_RUNNING 

Failed to start a recording because another recording is already in progress. Stop the other recording before starting a new one.

ENGINE_NOT_RUNNING 

Recording cannot be started as the engine is not running

INVALID_STATUS 

Cannot start a recording that is not in the initialized state. Create a new recording.

FILE_CREATION 

Cannot start the recording because the output file could not be created

UNKNOWN_ORIENTATION 

Device is in an unknown or unsupported orientation

DATA_SOURCE 

Failed to start recording from some of the selected data sources. This could happen if e.g. another application has exclusive access to a source.

INSUFFICIENT_FREE_SPACE 

Cannot start a recording as there isn't sufficient free space on the device to store it

DATA_FLAGS_NOT_SUPPORTED 

One or more requested data flags are not supported on the current device

UNITY_PLAYMODE_NOT_SUPPORTED 

Failed to start recording because it is not supported in Unity PlayMode.

◆ RecordingStatus

enum RecordingStatus
strong

Status of the session recorder.

Enumerator
INITIALIZED 

The recording has been created and can be started.

RUNNING 

The recording is in progress.

STOPPED 

The recording has stopped. It cannot be started again. Check the status info for further details.

COMPLETED 
SOURCES_NOT_AVAILABLE 
STORAGE_LOCATION_RETRIEVAL_ERROR 
SOURCE_OPERATION_ERROR 
INSUFFICIENT_FREE_SPACE 
ORIENTATION_NOT_SUPPORTED 
ANOTHER_RECORDING_RUNNING 
UNITY_PLAYMODE_NOT_SUPPORTED 

◆ RecordingStatusInfo

enum RecordingStatusInfo
strong

Session recording status info.

Enumerator
NORMAL 

Normal operation. No error has occurred.

SUCCESS 

The recording completed successfully

ERROR_INTERNAL 

Recording was aborted due to an internal error

ERROR_ORIENTATION_CHANGED 

The device orientation changed during recording

ERROR_DATA_SOURCE 

Recording from one of the selected data sources failed

ERROR_INSUFFICIENT_FREE_SPACE 

The recording stopped as there isn't sufficient free space on the device to store it

◆ Sensitivity

enum Sensitivity
strong

The sensitivity of this virtual button. This is a trade off between fast detection and robustness again accidental occlusion.

Enumerator
HIGH 

Fast detection.

MEDIUM 

Balanced between fast and robust.

LOW 

Robust detection.

◆ Status

enum Status
strong

The tracking status of the TrackableBehaviour.

Enumerator
NO_POSE 

Pose for the trackable could not be delivered.

LIMITED 

The tracking is limited.

TRACKED 

The trackable was tracked.

EXTENDED_TRACKED 

The trackable was extended tracked.

◆ StatusInfo

enum StatusInfo
strong

Information on the tracking status. Gives the primary reason about the problem with tracking (STATUS::NO_POSE or STATUS::LIMITED).

Enumerator
NORMAL 

Tracking is working normally.

NOT_OBSERVED 

Target is not detected.

UNKNOWN 

Unknown reason for limited status.

INITIALIZING 

Not enough information yet for accurate tracking.

RELOCALIZING 

The tracking system is currently relocalizing.

EXCESSIVE_MOTION 

Moving too fast for accurate tracking.

INSUFFICIENT_FEATURES 

Not enough features for accurate tracking.

INSUFFICIENT_LIGHT 

Not enough light for accurate tracking.

RECOMMENDING_GUIDANCE 

Could not snap the target. Recommend to show a Guide View overlay.

WRONG_SCALE 

The target scale does not match the physical scale of the object.

◆ StorageType

enum StorageType
strong

Storage type is used to interpret a given path string.

Enumerator
APP 

Indicates a relative path to an app-local storage location.

APP_RESOURCE 

Indicates a path relative to the StreamingAssets folder.

ABSOLUTE 

Indicates an absolute path.

◆ TrackingOptimization

enum TrackingOptimization
strong

Optimize tracking quality and robustness for different target types

Enumerator
DEFAULT 

Best tracking performance for the majority of use cases and targets.

LOW_FEATURE_OBJECTS 

Optimize tracking for objects with smooth, untextured surfaces, that lack features and detailed structures, including cars, sheet metal parts and many inustrial objects.

Do not use for objects that move while being tracked.

AR_CONTROLLER 

Optimize tracking for use cases where small, handheld fast moving targets are used like a AR/VR controller. Tracking will be less stable if the object is stationary.

◆ VirtualButtonSensitivity

The sensitivity of this virtual button. This is a trade off between fast detection and robustness again accidental occlusion.

Enumerator
HIGH 

Fast detection.

MEDIUM 

Balanced between fast and robust.

LOW 

Robust detection.

◆ VuforiaInitError

enum VuforiaInitError
strong

VuforiaInitError is an error value that is returned by Vuforia if something goes wrong at initialization.

Enumerator
NONE 

No error

INIT_SUCCESS 
DEVICE_NOT_SUPPORTED 

The device is not supported

INIT_EXTERNAL_DEVICE_NOT_DETECTED 
PERMISSION_ERROR 

One or more permissions required by Vuforia Engine are missing or not granted by user

INIT_NO_CAMERA_ACCESS 
LICENSE_ERROR 

A valid license configuration is required

INITIALIZATION 

An error occurred during initialization of the Vuforia Engine instance (e.g. an instance already exists)

INIT_ERROR 
DRIVER_CONFIG_LIBRARY_NOT_FOUND 

Specified library file not found

DRIVER_CONFIG_LOAD_ERROR 

An error occurred while loading the driver

INIT_VUFORIA_DRIVER_FAILED 
DRIVER_CONFIG_FEATURE_NOT_SUPPORTED 

Vuforia Driver is not supported by the current license

LICENSE_CONFIG_MISSING_KEY 

License key is missing

INIT_LICENSE_ERROR_MISSING_KEY 
LICENSE_CONFIG_INVALID_KEY 

Invalid license key passed to SDK

INIT_LICENSE_ERROR_INVALID_KEY 
LICENSE_CONFIG_NO_NETWORK_PERMANENT 

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

INIT_LICENSE_ERROR_NO_NETWORK_PERMANENT 
LICENSE_CONFIG_NO_NETWORK_TRANSIENT 

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

INIT_LICENSE_ERROR_NO_NETWORK_TRANSIENT 
LICENSE_CONFIG_BAD_REQUEST 

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

INIT_LICENSE_ERROR_BAD_REQUEST 
LICENSE_CONFIG_KEY_CANCELED 

Provided key is no longer valid

INIT_LICENSE_ERROR_CANCELED_KEY 
LICENSE_CONFIG_PRODUCT_TYPE_MISMATCH 

Provided key is not valid for current product

INIT_LICENSE_ERROR_PRODUCT_TYPE_MISMATCH 
LICENSE_CONFIG_UNKNOWN 

Unknown error

PLATFORM_ANDROID_CONFIG_INITIALIZATION_ERROR 

An error occurred during initialization of the platform. Note that these errors are generated only when the Engine is used on an Android device.

PLATFORM_ANDROID_CONFIG_INVALID_ACTIVITY 

Invalid Android Activity jobject passed to the configuration

PLATFORM_ANDROID_CONFIG_INVALID_JAVA_VM 

Invalid Java VM (JavaVM*) passed to the configuration

◆ WorldCenterMode

enum WorldCenterMode
strong

The world center mode defines how the relative coordinates between Trackables and camera are translated into Unity world coordinates. If a world center is present the virtual camera in the Unity scene is transformed with respect to that. The world center mode is set through the Unity inspector.

Enumerator
SPECIFIC_TARGET 

User defines a single Trackable that defines the world center.

FIRST_TARGET 

Tracker uses the first Trackable that comes into view as the world center (world center changes during runtime).

DEVICE 

The device/camera is considered the world center, trackables are positioned with respect to it.