OSM
- Martijn Friggen
Configuration Article | CA-20230703-MF-20 VDG Sense | API | Functions | Layouts  |  |
Note:
This function requires an API license
Introduced in VDG Sense version 2.7.3
The OSM (OnScreenMessage) signal with the supplied value parameter is used to link a status message to a camera. This status message can be showed in a OnScreenMenu which is described here.
Special care must be taken when including xml specific characters. These are ‘&’, ‘<' en '>‘. The ampersand (‘&’) character can not be sent by this command because it will be part of the URL. See next paragraph.
As the value of this event is in the query part of an URL, the ampersand character (‘&’) cannot be part of it. It must be URL Encoded. See i.e. http://www.w3schools.com/TAGS/ref_urlencode.asp. The best practive is to URL Encode the complete value.
Request
command=osm&osmindex=[UID]&value=[string]&serverid=[UID]&deviceid=[UID] |
Response
parameter | type | remarks |
|---|---|---|
osmindex | [UID] | index of the messagebox [1-4] |
value | [string] | The value used for the generic event. |
serverid | [UID] | unique server id |
deviceid | [UID] | unique device id. |
error code | description | remarks |
|---|---|---|
0 | Ok | Ok, no error |
-1 | Not implemented. | Function not implemented. |
-2 | No device | Â No device found for the supplied cameraid/deviceid. |
-17 | No server | There's no server with the supplied id. |
-21 | Device not active | Â |
-53 | Device connection lost | Device has no connection. |
-57 | No osmindex | Â |
-58 | Invalid osmindex | osmindex [1-4] |
Related
Changelog
2.7.2 - Introduced