Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Configuration Article | CA-20220907-TP-76

VDG Sense | API | References

Image Added

View file
nameCA-20220907-TP-76.pdf

Table of Contents

This chapter gives a summary of the actions and their parameters as available at the moment of the creation of this document. It’s purpose is to demonstrate some of the possibilities of VDG Sense. Actions can be executed on the system with the executeAction command.

To determine which actions are supported by a particular server the command getActionList should be executed. This command returns a xml structure with all supported actions and their parameters.

The commmands executeAction and getActionList are available as of version 2.2.1.

...

This table gives a brief summary of the actions. Refer to the section below for details.

parameter

type

remarks

camera.setDeviceSetting

Sets one device setting.

deviceid

The id of the device.

name

The name of a device setting to change.

serverid

The id of the server where the camera is located.

value

The new value for the device setting.

camera.sendDeviceCommand

Requests a URL from a device, but does not return any contents.

deviceid

The id of the device.

serverid

The id of the server where the device is located.

url

The url of the device command to call.

server.tagVideoStart

Starts tagging video. Tagged video is not deleted until manually released.

serverid

The id of the server where the device is located.

deviceid

The id of the device.

pretime

The number of seconds the start time will be moved in the past.

title

The title of the VideoTag.

comment

The comment of the VideoTag.

server.tagVideoStop

Stops tagging video. Tagged video is not deleted until manually released

deviceid

The id of the device.

serverid

The id of the server where the device is located.

viewer.executeMacro

Executes a macro on a specific viewer.

divaid

The id of the viewer where the macro should be executed

name

The (unique) name of the macro to be executed.

server.executeMacro

Executes a macro on a specific viewer.

divaid

The id of the server where the macro should be executed

name

The (unique) name of the macro to be executed.

viewer.selectPanel

Selects or deselects a panel on a specific viewer. If both of the parameters 'panelid' and 'panelindex' are supplied, the parameter 'panelid' takes precedence over the parameter 'panelindex', one of the parameters is required and not both.

divaid

The id of the viewer where the action should be executed

layoutid

The id of the layout that the panel contains.

panelid

The id of the panel that should be selected.

panelindex

The index of the panel that should be selected.