Camera.Presets
Description
Marks an Object as capable of the Preset Operation.
If this Functionality is declared, the UI presets controls are available in the Video Manager.
Operations
Preset
This Operation allows to set, call and delete camera PTZ presets.
In case of the set command, the preset_id parameter contains a suggestion for the ID which was provided by the WinGuard user.
The final ID under which the preset was saved has to be returned in the Operation result as parameter id.
The commands call and delete will be called later from WinGuard with the returned ID.
If any command fails, an Operation error result should be returned.
Properties
| Name | Type | Values | Description |
|---|---|---|---|
| cmd | string | “call” | Calls a stored preset by given preset_id or, as fallback, by preset_name. |
| “set” | Stores a preset at current camera position with given preset_id and preset_name. |
||
| “delete” | Deletes a preset with given preset_id. |
||
| preset_id | string | ID of the preset. | |
| preset_name | string | Name of the preset, can be used as fallback if ID was not found. In case of a presetlink namely the preset references another one, the name of referenced preset will be taken. If the referenced preset is not available, name is empty. |
Returned Properties
In case of the set command, the final ID of the preset as it was created in the third-party system has to be returned. It may be different from the ID that was passed as the preset_id parameter.
| Name | Type | Description |
|---|---|---|
| id | string | ID of the preset that was created in the third-party system. |
The other commands do not have returned Properties.
Properties
Presets
The camera Object can declare the Presets Property which contains information about the presets stored for the respective camera in the third-party system. This information can be supplied during automatic data supply.
<Property id="Presets" type="object[]" kind="cam_preset" readonly="1" />Each preset object has the following Properties:
| Name | Type | Description |
|---|---|---|
| id | string | The ID of the preset. |
| name | string | The name of the preset. |