Event Control API
API For working with built-in websocket.
GET /event/list
Get the list of events that can be subscribed to using the websocket API.
Response
200 - OK
The response is a JSON object.
Name Type Description
events array
events[i] string
List of events that can be subscribed to using the
websocket API
Notification websocket - 1.0.0
Service that notifies subscribers of device state changes.
messages
Subscribe (The messages from the server/device)
(JSON)
Name Type Description
.data object
.data.action string
Possible values are: subscribe, unsubscribe,
listSubscriptions, listProperties .
.data.properties array
.data.properties[i] string
Device property the user can subscribe to. The user can
either choose a value from the predefined enum or provide
a wildcard string. Possible values are: /media/active,
/system, /system/codecFormat, /system/videoFormat,
/timelines/0, /transports/0, /transports/0/stop, /transports/0/
play, /transports/0/playback, /transports/0/record . Must
match the pattern: .*.
.data.values object
An object with property names as the key and a property
value as json. Check the next section for a the device
properties and their return values.
.data.success boolean
.type string Possible values are: response .
.id number
Optional parameter that repeats the id in the output for
tracking messages
1057Developer Information
To Next Page
Loading...
Need help?
General
