*License Functions

Configuration Article | CA-20220907-TP-86

VDG Sense | API | References

License Functions

Some functions require an API license option. This option is available in the pro-version of our license model.

Function	Available without API license	Available with API license

Function	Available without API license	Available with API license
addClip	✓	✓
addPerson		✓
deleteClip	✓	✓
deletePerson		✓
downloadClip	✓	✓
executeAction		✓
exportEvents	✓	✓
exportVideoTag	✓	✓
fillLayout		✓
genericEvent		✓
getActionList		✓
getCameraList	✓	✓
getClips	✓	✓
getDeviceList	✓	✓
getDivaList	✓	✓
getEventTypes		✓
getEvents		✓
getHardwareStatus		✓
getHistoricalImage	✓	✓
getHistoricalImageData	✓	✓
getImageSequence	✓	✓
getLayoutList		✓
getLayoutStatus		✓
getLicensePlate		✓
getLiveImage	✓	✓
getMacroList		✓
getMultiLayoutList		✓
getOptions	✓	✓
getPersonFields		✓
getPersonList		✓
getPluginOptions	✓	✓
getPosition	✓	✓
getPresetImage	✓	✓
getServerList	✓	✓
getServerMacroList		✓
getServerOptions	✓	✓
getServerStatus		✓
getStatusTypes		✓
getSystemStatus		✓
getVideoTagList		✓
getViewerMacroList		✓
gotoPreset	✓	✓
grabLicensePlate		✓
holdPosition	✓	✓
releaseVideoTag		✓
selectCamera		✓
selectLayout		✓
selectMultiLayout		✓
setAbsolutePosition	✓	✓
setParameters	✓	✓
setPlaybackDateTime		✓
setPlaybackSpeed		✓
setPreset	✓	✓
setRelativePosition	✓	✓
startPlayback		✓
startVideoTag		✓
stopPlayback		✓
stopVideoTag		✓
streamEvents		✓
streamStatus		✓
streamVideo	✓	✓
updateClip	✓	✓
updatePerson		✓
updateVideoTag		✓

Knowledge Base