C API Unity API
Unity API Reference (Version 10.22.5)
Vuforia Namespace Reference

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  BarcodeBehaviour
 This class serves both as an augmentation definition for a Barcode observer More...
 
interface  BarcodeInstanceData
 Instance info for a barcode from its respective observation More...
 
class  CameraDevice
 Represents the physical camera used to capture the real world More...
 
class  CameraRegionOfInterest
 Data structure for setting and getting focus and exposure regions of interest in the camera image More...
 
class  CloudRecoBehaviour
 This is the main behaviour class that encapsulates cloud recognition behaviour. 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  DatabaseTargetInfo
 
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
 A utility class that creates Unity meshes from glTF. Used with ModelTarget and AreaTarget datasets More...
 
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
 Contains detailed information of image data More...
 
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...
 
class  Intrinsics
 Representation of physical details of the camera. 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...
 
class  RuntimeMeshRenderingBehaviour
 Renders the runtime Mesh of a Vuforia Target 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  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  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  VuforiaRuntimeResourcesRegister
 
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,
  ALIGNMENT_DATABASE_LOAD_ERROR = 0xA,
  INVALID_ALIGNMENT_TARGET_NAME = 0xB,
  ALIGNMENT_TARGET_NOT_FOUND = 0xC
}
 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,
  GENERATION_ERROR_MISSING_ALIGNMENT_DATA = 0x11,
  GENERATION_ERROR_ALIGNMENT_FAILED = 0x12
}
 
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  DatabaseTargetInfoError : int {
  NONE = 0,
  DATABASE_LOAD_ERROR = 1,
  NO_TARGETS = 2,
  DATABASE_XML_REQUIRED = 3
}
 Database target info error More...
 
enum  DistortionMode {
  MODE_LINEAR = 1,
  MODE_1_PARAM = 5,
  MODE_2_PARAMS = 6,
  MODE_3_PARAMS = 2,
  MODE_4_PARAMS = 3,
  MODE_5_PARAMS = 4,
  MODE_6_PARAMS = 7,
  MODE_8_PARAMS = 8
}
 
enum  ExposureMode {
  EXPOSURE_MODE_TRIGGERAUTO = 1,
  EXPOSURE_MODE_CONTINUOUSAUTO = 2,
  EXPOSURE_MODE_FIXED = 3
}
 The different exposure modes for the active camera More...
 
enum  FocusMode {
  FOCUS_MODE_TRIGGERAUTO = 1,
  FOCUS_MODE_CONTINUOUSAUTO = 2,
  FOCUS_MODE_INFINITY = 3,
  FOCUS_MODE_MACRO = 4,
  FOCUS_MODE_FIXED = 5
}
 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
}
 
enum  ImageTargetType {
  PREDEFINED = 0,
  CLOUD_RECO = 2,
  INSTANT = 3,
  UNKNOWN = int.MaxValue
}
 The type of an ImageTarget More...
 
enum  InstanceIdType {
  BYTE = 0,
  STRING = 1,
  NUMERIC = 2
}
 VuMark ID Type More...
 
enum  LogLevel {
  ALL,
  ERROR_AND_WARNING,
  ERROR,
  NONE
}
 Log level for Vuforia logging 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
}
 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  RecordingVideoEncodingQuality {
  HIGH = 0x1,
  MEDIUM = 0x2
}
 Quality settings used for encoding the recorded video. 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,
  MISSING_DATA = 10
}
 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  VuforiaEngineError {
  INVALID_LICENSE = 0x600,
  CAMERA_DEVICE_LOST = 0x601
}
 VuforiaEngineError is an error value that Vuforia reports when a lifecycle-related engine error occurs after initialization More...
 
enum  VuforiaInitError {
  NONE = 0x0,
  DEVICE_NOT_SUPPORTED = 0x1,
  PERMISSION_ERROR = 0x2,
  LICENSE_ERROR = 0x3,
  INITIALIZATION = 0x4,
  DRIVER_CONFIG_LIBRARY_NOT_FOUND = 0x100,
  DRIVER_CONFIG_LOAD_ERROR = 0x101,
  DRIVER_CONFIG_FEATURE_NOT_SUPPORTED = 0x102,
  LICENSE_CONFIG_MISSING_KEY = 0x200,
  LICENSE_CONFIG_INVALID_KEY = 0x201,
  LICENSE_CONFIG_NO_NETWORK_PERMANENT = 0x202,
  LICENSE_CONFIG_NO_NETWORK_TRANSIENT = 0x203,
  LICENSE_CONFIG_BAD_REQUEST = 0x204,
  LICENSE_CONFIG_KEY_CANCELED = 0x205,
  LICENSE_CONFIG_PRODUCT_TYPE_MISMATCH = 0x206,
  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

◆ DatabaseTargetInfoError

enum DatabaseTargetInfoError : int
strong

Database target info error

Enumerator
NONE 

No error

DATABASE_LOAD_ERROR 

Database file not found or an error occurred when reading data from it (potentially unknown or corrupted file)

NO_TARGETS 

Could not find any targets in the database from which an observer could be created

DATABASE_XML_REQUIRED 

The database contains targets that do not support loading directly from the database's DAT file. Image Target or VuMark databases generated prior to Vuforia version release must to be loaded from the database's XML file. To query the target infos from this database, and subsequently create observers, either provide the database XML file instead or regenerate the database to the latest version.

◆ ExposureMode

enum ExposureMode
strong

The different exposure modes for the active camera

Enumerator
EXPOSURE_MODE_TRIGGERAUTO 

Triggers a single auto-exposure operation

EXPOSURE_MODE_CONTINUOUSAUTO 

Continuous auto-exposure mode

EXPOSURE_MODE_FIXED 

Fixed exposure mode

◆ PlayModeType

enum PlayModeType
strong
Enumerator
WEBCAM 

Use the webcam when entering Play Mode

SIMULATOR 

Start Vuforia Simulator Mode when entering Play Mode

RECORDING 

Play back a session recording when entering Play Mode

◆ RecordingSource

enum RecordingSource
strong

The sources of data the session recorder can use.

Enumerator
VIDEO 

Camera images.

CAMERA_METADATA 

Camera metadata required for AR session playback.

SENSORS 

Data from device sensors (accelerometer, gyroscope and magnetometer) depending on which are available on the current device.

DEVICE_POSE 

Device poses generated by the platform-provided Vuforia Fusion provider.

AUDIO 

Audio recording from the default audio input device.

◆ 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.

◆ 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

◆ RecordingVideoEncodingQuality

Quality settings used for encoding the recorded video.

Enumerator
HIGH 

High quality video encoding with minimal compression artifacts.

Recordings with this setting are suitable for playback as AR sessions, but will have an increased file size. This is the default (approx. 15MBit/s video bitrate for 720p@30 video).

MEDIUM 

Medium quality video encoding for general purpose video recording.

Approx. 5MBit/s video bitrate for 720p@30 video.