Barco S3 - Page 526

B. Remote Control Protocol
subscribe
•Definition
- User can use this API to subscribe to change events in the Event Master processor.
- Once subscribed, the API sends a notification in the form of an HTTP Post to the Url: http://hostname:port/.
• Request:
- params: {"hostname": hostname, "port": port, "notification" : notificationType[]}
o
hostname—Hostname or IP A ddress to which the notifications are sent.
o
port—TCP port to which the notification are posted.
o
notificationTypes—an array of notifications to which a user wants to subscribe.
o
ScreenDestChanged
o
AUXDestChanged
o
FrameChanged
o
NativeRateChanged
o
InputCfgChanged
o
SourceChanged
o
BGSourceChanged
o
PresetChanged
o
StillChanged
o
OutputCfgChanged
• Response:
- response: {"method": "subscribe"}
- succ e ss : (0 = su cc e ss, an yth in g else is a n error)
• Example:
- {"params": {"hostname" : "192.168.247.131", "port": "3000", "notification" : ["Screen-
DestChanged", "AUXDestChanged"]}, "method":"subscribe", "id":"1234", "jsonrpc":"2.0"}
unsubscribe
•Definition
- User can use this API to remove the subscription for the given hostname: port and notificationType.
• Request:
- params: {"hostname": hostname, "port": port, "notification" : notificationType[]}
o
hostname—Hostname or IP Address from which the subscription is to be removed.
o
port—TCP port.
o
notificationTypes—an array of notifications to which a user wants to subscribe.
o
ScreenDestChanged
o
AUXDestChanged
o
FrameChanged
o
NativeRateChanged
o
InputCfgChanged
o
SourceChanged
o
BGSourceChanged
o
PresetChanged
o
StillChanged
o
OutputCfgChanged
• Response:
- response: {"method": " unsubscribe"}
- succ e ss : (0 = su cc e ss, an yth in g else is a n error)
• Example:
- {"params": {"hostname" : "192.168.247.131", "port": "3000", "notification" : ["Screen-
DestChanged", "AUXDestChanged"]}, "method":"unsubscribe", "id":"1234", "jsonrpc":"2.0"}
522
R5905948 EVENT MASTER DEVICES 17/07/2017