documentation

vlSDK-C API

General C-Interface for the vlSDK, which works on all devices. More...

Modules

 CalibratedImageWrapper
 Functions for managing CalibratedImageWrapper objects.
 
 ExtrinsicDataWrapper
 Functions for managing ExtrinsicDataWrapper objects.
 
 Global
 Global functions which can be called without a corresponding object which handles the request.
 
 ImageWrapper
 Functions for managing ImageWrapper objects.
 
 IntrinsicDataWrapper
 Functions for managing IntrinsicDataWrapper objects.
 
 SimilarityTransformWrapper
 Functions for managing SimilarityTransformWrapper objects.
 
 Utils
 Functions for general purpose and supporting your app.
 
 Worker
 Functions for managing Worker objects.
 

Typedefs

typedef struct vlCalibratedImageWrapper_s vlCalibratedImageWrapper_t
 Type which represents a CalibratedImageWrapper. More...
 
typedef void(VL_CALLINGCONVENTION * vlCallbackCalibratedImageWrapper) (vlCalibratedImageWrapper_t *calibratedImage, void *clientData)
 A pointer to a callback function which receives a pointer to a CalibratedImageWrapper object as parameter. Please notice, that the object is only valid inside the callback and it will automatically get deleted afterwards. More...
 
typedef void(VL_CALLINGCONVENTION * vlCallbackExtrinsicDataWrapper) (vlExtrinsicDataWrapper_t *extrinsicData, void *clientData)
 A pointer to a callback function which receives a pointer to an ExtrinsicDataWrapper object as parameter. Please notice, that the object is only valid inside the callback and it will automatically get deleted afterwards. More...
 
typedef void(VL_CALLINGCONVENTION * vlCallbackImageWrapper) (vlImageWrapper_t *image, void *clientData)
 A pointer to a callback function which receives a pointer to an ImageWrapper object as parameter. More...
 
typedef void(VL_CALLINGCONVENTION * vlCallbackIntrinsicDataWrapper) (vlIntrinsicDataWrapper_t *intrinsicData, void *clientData)
 A pointer to a callback function which receives a pointer to an IntrinsicDataWrapper object as parameter. Please notice, that the object is only valid inside the callback and it will automatically get deleted afterwards. More...
 
typedef void(VL_CALLINGCONVENTION * vlCallbackJsonAndBinaryString) (const char error[], const char result[], const char data[], unsigned int size, void *clientData)
 A pointer to a callback function which receives a zero terminated result string (usually in JSON), a zero terminated error string and a binary buffer which plain binary data. Please note that the use of this function might change in future and is considered as BETA! More...
 
typedef void(VL_CALLINGCONVENTION * vlCallbackJsonString) (const char error[], const char data[], void *clientData)
 A pointer to a callback function which receives two zero terminated string which contain JSON data. More...
 
typedef void(VL_CALLINGCONVENTION * vlCallbackSimilarityTransformWrapper) (vlSimilarityTransformWrapper_t *similarityTransform, void *clientData)
 A pointer to a callback function which receives a pointer to an SimilarityTransformWrapper object as parameter. Please notice, that the object is only valid inside the callback and it will automatically get deleted afterwards. More...
 
typedef void(VL_CALLINGCONVENTION * vlCallbackZString) (const char data[], void *clientData)
 A pointer to a callback function which receives a zero terminated string as parameter. More...
 
typedef struct vlExtrinsicDataWrapper_s vlExtrinsicDataWrapper_t
 Type which represents an ExtrinsicDataWrapper. More...
 
typedef struct vlImageWrapper_s vlImageWrapper_t
 Type which represents an ImageWrapper. More...
 
typedef struct vlIntrinsicDataWrapper_s vlIntrinsicDataWrapper_t
 Type which represents an IntrinsicDataWrapper. More...
 
typedef struct vlSimilarityTransformWrapper_s vlSimilarityTransformWrapper_t
 Type which represents a SimilarityTransformWrapper. More...
 
typedef struct vlWorker_s vlWorker_t
 Type which represents a Worker. More...
 

Enumerations

enum  vlErrorCode {
  VL_INTERNAL_ERROR = 1 , VL_ERROR_NO_CAMERA_CONNECTED = 4 , VL_ERROR_NO_CAMERA_ACCESS = 5 , VL_ERROR_FILE_SYNTAX_ERROR = 95 ,
  VL_ERROR_FILE_WRITING_FAILED = 96 , VL_ERROR_FILE_READING_FAILED = 98 , VL_ERROR_FILE_INVALID = 99 , VL_ERROR_FILE_FORMAT_NOT_ALLOWED = 100 ,
  VL_ERROR_LICENSE_INVALID = 101 , VL_ERROR_LICENSE_EXPIRED = 102 , VL_ERROR_LICENSE_EXCEEDS_RUNS = 103 , VL_ERROR_LICENSE_INVALID_HOST_ID = 105 ,
  VL_ERROR_LICENSE_NOT_SET = 106 , VL_ERROR_LICENSE_INVALID_PLATFORM = 107 , VL_ERROR_LICENSE_FILE_NOT_FOUND = 109 , VL_ERROR_LICENSE_INVALID_PROGRAM_VERSION = 110 ,
  VL_ERROR_LICENSE_INVALID_SEAT = 111 , VL_ERROR_LICENSE_INVALID_FEATURE = 112 , VL_ERROR_LICENSE_INVALID_BUNDLE_ID = 114 , VL_ERROR_LICENSE_EXCEEDED_ALLOWED_NUMBER_OF_ANCHORS = 115 ,
  VL_ERROR_FEATURE_NOT_SUPPORTED = 200 , VL_ERROR_MODEL_LOAD_FAILED = 300 , VL_ERROR_MODEL_DECODE_FAILED = 301 , VL_ERROR_DUPLICATE_MODEL_NAME = 303 ,
  VL_ERROR_POSTER_LOAD_FAILED = 350 , VL_ERROR_GRAPH_SETUP_FAILED_UNKNOWN_ERROR = 400 , VL_ERROR_GRAPH_NODE_NOT_FOUND = 401 , VL_ERROR_GRAPH_INVALID_DATA_PATH = 402 ,
  VL_ERROR_GRAPH_INPUT_NOT_FOUND = 403 , VL_ERROR_GRAPH_OUTPUT_NOT_FOUND = 404 , VL_ERROR_GRAPH_HAS_CYCLES = 405 , VL_ERROR_GRAPH_TRACKERS_EMPTY = 406 ,
  VL_ERROR_GRAPH_DUPLICATE_DEVICE_NAME = 407 , VL_ERROR_GRAPH_DUPLICATE_TRACKER_NAME = 408 , VL_ERROR_DUPLICATE_ANCHOR_NAME = 500 , VL_ERROR_ANCHOR_NAME_NOT_FOUND = 501 ,
  VL_ERROR_DLL_NOT_LOADED = 600 , VL_WARNING_DLL_LOAD_FAILED = 601 , VL_WARNING_DLL_NOT_FOUND = 602 , VL_WARNING_DLL_VERSION_DIFFERENT = 603 ,
  VL_ERROR_COMMAND_CANCELED = 700 , VL_ERROR_COMMAND_NOT_SUPPORTED = 701 , VL_ERROR_COMMAND_INTERNAL_PROBLEM = 702 , VL_ERROR_COMMAND_INVALID_PARAMETER = 703 ,
  VL_ERROR_COMMAND_PARAMETER_VALUE_NOT_SUPPORTED = 704 , VL_WARNING_CALIBRATION_MISSING_FOR_DEVICE = 2 , VL_WARNING_CALIBRATION_DB_LOAD_FAILED = 10 , VL_WARNING_CALIBRATION_DB_INVALID = 11 ,
  VL_WARNING_CALIBRATION_DB_LOAD_ERROR = 12 , VL_WARNING_CALIBRATION_DEVICE_ID_OVERWRITTEN_ON_LOAD = 13 , VL_WARNING_CALIBRATION_DEVICE_ID_OVERWRITTEN_BY_ALTERNATIVE_ID = 14 , VL_WARNING_PERMISSION_NOT_SET = 97 ,
  VL_WARNING_LICENSE_MODEL_BOUND_FEATURE_INVALD = 104 , VL_WARNING_LICENSE_USING_UNREGISTERED_MODELS = 108 , VL_WARNING_LICENSE_EXPIRING_SOON = 113 , VL_WARNING_IMPLAUSIBLE_METRIC = 302 ,
  VL_WARNING_POSTER_QUALITY_CRITICAL = 351 , VL_DEPRECATION_WARNING = 20
}
 
enum  vlFittingMode { VL_FITTING_MODE_COVER = 0 , VL_FITTING_MODE_CONTAIN = 1 }
 
enum  vlImageFormat {
  VL_IMAGE_FORMAT_UNDEFINED = 0 , VL_IMAGE_FORMAT_GREY = 1 , VL_IMAGE_FORMAT_RGB = 2 , VL_IMAGE_FORMAT_RGBA = 3 ,
  VL_IMAGE_FORMAT_DEPTH = 4
}
 
enum  vlLogLevel { VL_LOG_MUTE = 0 , VL_LOG_ERROR = 1 , VL_LOG_WARNING = 2 , VL_LOG_DEBUG = 3 }
 
enum  vlRenderRotation { VL_RENDER_ROTATION_CCW_0 = 0 , VL_RENDER_ROTATION_CCW_90 = 2 , VL_RENDER_ROTATION_CCW_180 = 1 , VL_RENDER_ROTATION_CCW_270 = 3 }
 

Functions

VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddNodeDataExtrinsicDataListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackExtrinsicDataWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddNodeDataImageListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackImageWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddNodeDataIntrinsicDataListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackIntrinsicDataWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddNodeDataSimilarityTransformListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackSimilarityTransformWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_AddNodeTrackingStateListener (vlWorker_t *worker, const char node[], vlCallbackZString listener, void *clientData)
 
VL_SDK_API char *VL_CALLINGCONVENTION vlWorker_GetNodeTrackingStateJsonSync (vlWorker_t *worker, const char node[])
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveNodeDataExtrinsicDataListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackExtrinsicDataWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveNodeDataImageListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackImageWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveNodeDataIntrinsicDataListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackIntrinsicDataWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveNodeDataSimilarityTransformListener (vlWorker_t *worker, const char node[], const char key[], vlCallbackSimilarityTransformWrapper listener, void *clientData)
 
VL_SDK_API bool VL_CALLINGCONVENTION vlWorker_RemoveNodeTrackingStateListener (vlWorker_t *worker, const char node[], vlCallbackZString listener, void *clientData)
 

Detailed Description

General C-Interface for the vlSDK, which works on all devices.

Typedef Documentation

◆ vlCalibratedImageWrapper_t

typedef struct vlCalibratedImageWrapper_s vlCalibratedImageWrapper_t

Type which represents a CalibratedImageWrapper.

A calibrated image contains an image together with the corresponding intrinsic data and the transformation form the (camera) device to the calibrated image. Please use the vlCalibratedImageWapper_... functions to manipulate instances of it.

◆ vlCallbackCalibratedImageWrapper

typedef void(VL_CALLINGCONVENTION* vlCallbackCalibratedImageWrapper) (vlCalibratedImageWrapper_t *calibratedImage, void *clientData)

A pointer to a callback function which receives a pointer to a CalibratedImageWrapper object as parameter. Please notice, that the object is only valid inside the callback and it will automatically get deleted afterwards.

Parameters
calibratedImagePointer to a CalibratedImageWrapper object. You can use the vlCalibratedImageWrapper_..." functions to work with it.
clientDataPointer value which was initially received from the user. This can be used to invoke a member function.

◆ vlCallbackExtrinsicDataWrapper

typedef void(VL_CALLINGCONVENTION * vlCallbackExtrinsicDataWrapper) (vlExtrinsicDataWrapper_t *extrinsicData, void *clientData)

A pointer to a callback function which receives a pointer to an ExtrinsicDataWrapper object as parameter. Please notice, that the object is only valid inside the callback and it will automatically get deleted afterwards.

Parameters
extrinsicDataPointer to an ExtrinsicDataWrapper object. You can use the vlExtrinsicDataWrapper_..." functions to work with it.
clientDataPointer value which was initially received from the user. This can be used to invoke a member function.

◆ vlCallbackImageWrapper

typedef void(VL_CALLINGCONVENTION * vlCallbackImageWrapper) (vlImageWrapper_t *image, void *clientData)

A pointer to a callback function which receives a pointer to an ImageWrapper object as parameter.

Parameters
imagePointer to an ImageWrapper object. You can use the vlImageWrapper_..." functions to work with it. Please notice, that the object is only valid inside the callback and it will automatically get deleted afterwards.
clientDataPointer value which was initially received from the user. This can be used to invoke a member function.

◆ vlCallbackIntrinsicDataWrapper

typedef void(VL_CALLINGCONVENTION * vlCallbackIntrinsicDataWrapper) (vlIntrinsicDataWrapper_t *intrinsicData, void *clientData)

A pointer to a callback function which receives a pointer to an IntrinsicDataWrapper object as parameter. Please notice, that the object is only valid inside the callback and it will automatically get deleted afterwards.

Parameters
intrinsicDataPointer to an IntrinsicDataWrapper object. You can use the vlIntrinsicDataWrapper_..." functions to work with it.
clientDataPointer value which was initially received from the user. This can be used to invoke a member function.

◆ vlCallbackJsonAndBinaryString

typedef void(VL_CALLINGCONVENTION * vlCallbackJsonAndBinaryString) (const char error[], const char result[], const char data[], unsigned int size, void *clientData)

A pointer to a callback function which receives a zero terminated result string (usually in JSON), a zero terminated error string and a binary buffer which plain binary data. Please note that the use of this function might change in future and is considered as BETA!

NOTE: The passed data pointer should be released using the vlReleaseBinaryBuffer function.

Parameters
errorZero terminated string with JSON data. This will be NULL, if no error occurred. The JSON format of the error is
  • "errorCode" (see Initialization Issues)
  • "command" (the name of the command triggering the error)
  • "info" (detailed information of the specific error)
  • "message"
resultZero terminated string with JSON data. The JSON format of the object depends on the context.
dataBinary data pointer (might be Zero). The context specific description might point to offsets within the binary data pointer.
sizeSize of the binary data.
clientDataPointer value which was initially received from the user. This can be used to invoke a member function.

◆ vlCallbackJsonString

typedef void(VL_CALLINGCONVENTION * vlCallbackJsonString) (const char error[], const char data[], void *clientData)

A pointer to a callback function which receives two zero terminated string which contain JSON data.

Parameters
errorZero terminated string with JSON data. This will be NULL, if no error occurred. The JSON format of the error is
  • "errorCode" (see Initialization Issues)
  • "command" (the name of the command triggering the error)
  • "info" (detailed information of the specific error)
  • "message"
dataZero terminated string with JSON data. This could be NULL, if an error occurred. The JSON format of the data object depends on the context.
clientDataPointer value which was initially received from the user. This can be used to invoke a member function.

◆ vlCallbackSimilarityTransformWrapper

typedef void(VL_CALLINGCONVENTION * vlCallbackSimilarityTransformWrapper) (vlSimilarityTransformWrapper_t *similarityTransform, void *clientData)

A pointer to a callback function which receives a pointer to an SimilarityTransformWrapper object as parameter. Please notice, that the object is only valid inside the callback and it will automatically get deleted afterwards.

Parameters
extrinsicDataPointer to a SimilarityTransformWrapper object. You can use the vlSimilarityTransformWrapper_..." functions to work with it.
clientDataPointer value which was initially received from the user. This can be used to invoke a member function.

◆ vlCallbackZString

typedef void(VL_CALLINGCONVENTION * vlCallbackZString) (const char data[], void *clientData)

A pointer to a callback function which receives a zero terminated string as parameter.

Parameters
dataZero terminated string. The meaning depends on the context.
clientDataPointer value which was initially received from the user. This can be used to invoke a member function.

◆ vlExtrinsicDataWrapper_t

typedef struct vlExtrinsicDataWrapper_s vlExtrinsicDataWrapper_t

Type which represents an ExtrinsicDataWrapper.

Please use the vlExtrinsicDataWrapper_... functions to manipulate instances of it.

◆ vlImageWrapper_t

typedef struct vlImageWrapper_s vlImageWrapper_t

Type which represents an ImageWrapper.

Please use the vlImageWrapper_... functions to manipulate instances of it.

◆ vlIntrinsicDataWrapper_t

typedef struct vlIntrinsicDataWrapper_s vlIntrinsicDataWrapper_t

Type which represents an IntrinsicDataWrapper.

Please use the vlIntrinsicDataWrapper_... functions to manipulate instances of it.

◆ vlSimilarityTransformWrapper_t

typedef struct vlSimilarityTransformWrapper_s vlSimilarityTransformWrapper_t

Type which represents a SimilarityTransformWrapper.

Please use the vlSimilarityTransformWrapper_... functions to manipulate instances of it.

◆ vlWorker_t

typedef struct vlWorker_s vlWorker_t

Type which represents a Worker.

Please use the vlWorker_... functions to manipulate instances of it.

Enumeration Type Documentation

◆ vlErrorCode

Error codes.

Enumerator
VL_INTERNAL_ERROR 

An internal error occurred during initialization.

VL_ERROR_NO_CAMERA_CONNECTED 

There is maybe no camera connected to your system or no Camera/WebCam capabilities are set.

VL_ERROR_NO_CAMERA_ACCESS 

The camera may be removed or used by another application.

VL_ERROR_FILE_SYNTAX_ERROR 

Syntax error encountered while parsing file.

VL_ERROR_FILE_WRITING_FAILED 

Could not write into the specified file.

VL_ERROR_FILE_READING_FAILED 

The file specified could not be acquired or loaded.

VL_ERROR_FILE_INVALID 

No valid tracking configuration. The file can not be handled or has the wrong format.

VL_ERROR_FILE_FORMAT_NOT_ALLOWED 

You have passed a file different to the ones allowed or it is not valid (e.g. only .json and .vl files allowed for the configuration).

VL_ERROR_LICENSE_INVALID 

Will be issued when the license is not a valid file.

VL_ERROR_LICENSE_EXPIRED 

Will be issued when the license has been expired. In this case a black image will be shown with the watermark instead of the camera image. The extrinsic data cannot be acquired.

VL_ERROR_LICENSE_EXCEEDS_RUNS 

Will be issued when you have started the license more than 5 times without re-deploying. In this case a black image will be shown with the watermark instead of the camera image. The extrinsic data cannot be acquired.

VL_ERROR_LICENSE_INVALID_HOST_ID 

Will be issued when the license is not registered for this id. If you have licensed a commercial or poc license you might send us this id for updating your license file.

VL_ERROR_LICENSE_NOT_SET 

Will be issued when no license file or data has been set.

VL_ERROR_LICENSE_INVALID_PLATFORM 

The given license is not valid for running for the current platform (e.g. on HoloLens).

VL_ERROR_LICENSE_FILE_NOT_FOUND 

Will be issued when the specified license file has not been found at the specified location.

VL_ERROR_LICENSE_INVALID_PROGRAM_VERSION 

Will be issued when the license is encountering a program version incompatibility (e.g. Lifetime License bound to certain versions).

VL_ERROR_LICENSE_INVALID_SEAT 

Will be issued when the license is bound to a software protection dongle and does not work with the current seat.

VL_ERROR_LICENSE_INVALID_FEATURE 

Will be issued when a certain feature of the VisionLib is not available due to license restrictions.

VL_ERROR_LICENSE_INVALID_BUNDLE_ID 

Will be issued when the license is not registered for this bundle id. If you have licensed a commercial or poc license you might send us this id for updating your license file.

VL_ERROR_LICENSE_EXCEEDED_ALLOWED_NUMBER_OF_ANCHORS 

Will be issued when the number of allowed tracking anchors is exceeded. Info contains: the number of allowed anchors.

VL_ERROR_FEATURE_NOT_SUPPORTED 

A required feature is not available on this system. Info holds the name of the feature

VL_ERROR_MODEL_LOAD_FAILED 

The model name passed could not be loaded. Info holds the filename uri requested.

VL_ERROR_MODEL_DECODE_FAILED 

The model downloaded by the specified fileURI could not be decoded.

VL_ERROR_DUPLICATE_MODEL_NAME 

The given modelname has been used twice or was used before.

VL_ERROR_POSTER_LOAD_FAILED 

The image passed in the poster tracker configuration could not be loaded. Info holds the filename uri requested.

VL_ERROR_GRAPH_SETUP_FAILED_UNKNOWN_ERROR 

The setup of the graph failed with an unknown reason.

VL_ERROR_GRAPH_NODE_NOT_FOUND 

Could not find the node with the given name. Info holds the name of the node.

VL_ERROR_GRAPH_INVALID_DATA_PATH 

The data path doesn't comply with the expected pattern nodeName.dataName. Info holds the data path that was invalid.

VL_ERROR_GRAPH_INPUT_NOT_FOUND 

Could not find an input of a node. Info contains: The nodename :: The Key that has not been found :: The keys that are defined on that node.

VL_ERROR_GRAPH_OUTPUT_NOT_FOUND 

Could not find an output of a node. Info contains: The nodename :: The Key that has not been found :: The keys that are defined on that node.

VL_ERROR_GRAPH_HAS_CYCLES 

There is a cycle in the graph - so no order of execution could be determined.

VL_ERROR_GRAPH_TRACKERS_EMPTY 

There was no tracker defined.

VL_ERROR_GRAPH_DUPLICATE_DEVICE_NAME 

The same name has been used for two or more devices.

VL_ERROR_GRAPH_DUPLICATE_TRACKER_NAME 

The same name has been used for two or more trackers.

VL_ERROR_DUPLICATE_ANCHOR_NAME 

The same name has been used for two or more anchors.

VL_ERROR_ANCHOR_NAME_NOT_FOUND 

The given anchor name does not exist.

VL_ERROR_DLL_NOT_LOADED 

The dll needed for using a device is not loaded.

VL_WARNING_DLL_LOAD_FAILED 

Could not load the dll.

VL_WARNING_DLL_NOT_FOUND 

Could not find the dll needed as dependency.

VL_WARNING_DLL_VERSION_DIFFERENT 

The version of the dll is not compatible with the vlSDK.

VL_ERROR_COMMAND_CANCELED 

The given command wasn't executed but canceled.

VL_ERROR_COMMAND_NOT_SUPPORTED 

The given command is not supported by the current pipeline.

VL_ERROR_COMMAND_INTERNAL_PROBLEM 

The given command could not be executed because of problems inside VisionLib.

VL_ERROR_COMMAND_INVALID_PARAMETER 

The given command could not be executed because the given parameter does not fit parameter structure.

VL_ERROR_COMMAND_PARAMETER_VALUE_NOT_SUPPORTED 

The given command could not be executed because the given parameter value isn't supported by the current pipeline.

VL_WARNING_CALIBRATION_MISSING_FOR_DEVICE 

No calibration available for device. The device ID is passed in the info field. Please be aware that some standard calibration might be used which will can harm the tracking quality massively.

VL_WARNING_CALIBRATION_DB_LOAD_FAILED 

The calibration DB could not be loaded.

VL_WARNING_CALIBRATION_DB_INVALID 

The calibration DB is not valid JSON.

VL_WARNING_CALIBRATION_DB_LOAD_ERROR 

While loading a calibration data base an internal error occurred reading the database. Please review the error log of the VisionLib for more information!

VL_WARNING_CALIBRATION_DEVICE_ID_OVERWRITTEN_ON_LOAD 

While loading a calibration data base the following deviceID has been overwritten.

VL_WARNING_CALIBRATION_DEVICE_ID_OVERWRITTEN_BY_ALTERNATIVE_ID 

While loading a calibration data base the following deviceID has been overwritten due to a defined alternative deviceID in 'Source'.

VL_WARNING_PERMISSION_NOT_SET 

An optional permission is not set. The program might not run as expected.

VL_WARNING_LICENSE_MODEL_BOUND_FEATURE_INVALD 

Will be issued when no valid license for a model bound feature could be found. This will not load this model and will result in undefined tracking behaviour. You should contact your license provider for updating the model hash provided in the info string.

VL_WARNING_LICENSE_USING_UNREGISTERED_MODELS 

Will be issued when the loaded model has NOT been registered in the license.

VL_WARNING_LICENSE_EXPIRING_SOON 

Will be issued when the license is only valid for less than a week. You should contact your license provider for obtaining a new license.

VL_WARNING_IMPLAUSIBLE_METRIC 

The bounding box of the model using the given metric is implausibly large or small. You should check the metric parameter. Info contains the dimensions of the bounding box.

VL_WARNING_POSTER_QUALITY_CRITICAL 

Will be issued when the poster quality is below a critical value. You should replace the poster in the tracker with one of a better quality.

VL_DEPRECATION_WARNING 

Will be issued when a parameter used in your tracking configuration is deprecated. It should be replaced by the one provided.

◆ vlFittingMode

Modes of scaling images while maintaining a constant aspect ratio.

Enumerator
VL_FITTING_MODE_COVER 

Let the image cover the available space.

VL_FITTING_MODE_CONTAIN 

Contain the image inside the available space.

◆ vlImageFormat

Internal image formats.

Enumerator
VL_IMAGE_FORMAT_UNDEFINED 

Unsupported image format.

VL_IMAGE_FORMAT_GREY 

Grey value image.

VL_IMAGE_FORMAT_RGB 

Image with a red, green and blue channel.

VL_IMAGE_FORMAT_RGBA 

Image with a red, green, blue and alpha channel.

VL_IMAGE_FORMAT_DEPTH 

Image with one float channel describing the distance in meters.

◆ vlLogLevel

enum vlLogLevel

Log levels.

Enumerator
VL_LOG_MUTE 

No logs.

VL_LOG_ERROR 

Error level.

VL_LOG_WARNING 

Warning level.

VL_LOG_DEBUG 

Debug level.

◆ vlRenderRotation

Screen orientations.