documentation
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... | |
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) |
General C-Interface for the vlSDK, which works on all devices.
| 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.
| 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.
| calibratedImage | Pointer to a CalibratedImageWrapper object. You can use the vlCalibratedImageWrapper_..." functions to work with it. |
| clientData | Pointer value which was initially received from the user. This can be used to invoke a member function. |
| 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.
| extrinsicData | Pointer to an ExtrinsicDataWrapper object. You can use the vlExtrinsicDataWrapper_..." functions to work with it. |
| clientData | Pointer value which was initially received from the user. This can be used to invoke a member function. |
| 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.
| image | Pointer 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. |
| clientData | Pointer value which was initially received from the user. This can be used to invoke a member function. |
| 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.
| intrinsicData | Pointer to an IntrinsicDataWrapper object. You can use the vlIntrinsicDataWrapper_..." functions to work with it. |
| clientData | Pointer value which was initially received from the user. This can be used to invoke a member function. |
| 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.
| error | Zero terminated string with JSON data. This will be NULL, if no error occurred. The JSON format of the error is
|
| result | Zero terminated string with JSON data. The JSON format of the object depends on the context. |
| data | Binary data pointer (might be Zero). The context specific description might point to offsets within the binary data pointer. |
| size | Size of the binary data. |
| clientData | Pointer value which was initially received from the user. This can be used to invoke a member function. |
| 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.
| error | Zero terminated string with JSON data. This will be NULL, if no error occurred. The JSON format of the error is
|
| data | Zero terminated string with JSON data. This could be NULL, if an error occurred. The JSON format of the data object depends on the context. |
| clientData | Pointer value which was initially received from the user. This can be used to invoke a member function. |
| 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.
| extrinsicData | Pointer to a SimilarityTransformWrapper object. You can use the vlSimilarityTransformWrapper_..." functions to work with it. |
| clientData | Pointer value which was initially received from the user. This can be used to invoke a member function. |
| typedef void(VL_CALLINGCONVENTION * vlCallbackZString) (const char data[], void *clientData) |
A pointer to a callback function which receives a zero terminated string as parameter.
| data | Zero terminated string. The meaning depends on the context. |
| clientData | Pointer value which was initially received from the user. This can be used to invoke a member function. |
| typedef struct vlExtrinsicDataWrapper_s vlExtrinsicDataWrapper_t |
Type which represents an ExtrinsicDataWrapper.
Please use the vlExtrinsicDataWrapper_... functions to manipulate instances of it.
| typedef struct vlImageWrapper_s vlImageWrapper_t |
Type which represents an ImageWrapper.
Please use the vlImageWrapper_... functions to manipulate instances of it.
| typedef struct vlIntrinsicDataWrapper_s vlIntrinsicDataWrapper_t |
Type which represents an IntrinsicDataWrapper.
Please use the vlIntrinsicDataWrapper_... functions to manipulate instances of it.
| typedef struct vlSimilarityTransformWrapper_s vlSimilarityTransformWrapper_t |
Type which represents a SimilarityTransformWrapper.
Please use the vlSimilarityTransformWrapper_... functions to manipulate instances of it.
| typedef struct vlWorker_s vlWorker_t |
Type which represents a Worker.
Please use the vlWorker_... functions to manipulate instances of it.
| enum vlErrorCode |
Error codes.
| Enumerator | |
|---|---|
| VL_INTERNAL_ERROR | An internal error occurred during initialization. |
| VL_ERROR_DEVICE_NAME_LOAD_FAILED | No information of the device name passed in the configuration could be loaded. The info string holds the device name requested. |
| 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 |
| 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 |
| 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. |
| enum vlImageFormat |
Internal image formats.
| enum vlLogLevel |
| enum vlRenderRotation |
Screen orientations.