Versions Compared

Key

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

...

  • This function requires an API license

  • Introduced in VDG Sense version 2.7.23

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.

...

Request

Code Block
command=custommessageosm&custommessageindexosmindex=[UID]&value=[string]&serverid=[UID]&deviceid=[UID]

Response

parameter

type

remarks

custommessageindexosmindex

[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 custommessageindexosmindex

-58

Invalid custommessageindexosmindex

custommessageindex osmindex [1-4]

Changelog

  • 2.7.2 - Introduced