Barco S3 - Page 525

B. Remote Control Protocol
listAuxContent
•Definition
- This A PI shows Aux destination information.
• Request:
- params: {“id” : x}
o
Id—Index of the Aux destination.
• Response:
- response: {"id":0,"Name":"AuxDest1","PvwLastSrcIndex":0,"PgmLastSrcIndex":0}
o
id—Index of Aux destination.
o
Name—Nam e of A ux destination.
o
PvwLastSrcIndex—Input/Background source index in pre view area.
o
PgmLastSrcIndex—Input/Background source index in pro gram area.
- succ e ss : (0 = su cc e ss, an yth in g else is a n error)
• Example:
- {"params": {"id": 0}, "method":"listAuxContent", "id":"1234", "jsonrpc":"2.0"}
changeAuxContent
•Definition
- This API c hanges the source in the Aux destinations.
• Request:
- params: {"id":x , "Name": "AuxDest1" , "PvwLastSrcIndex": y , "PgmLastSrcIndex": z}
o
id—Index of the A ux destination.
o
Name—Nam e of Aux destination. (Optional par amter)
o
PvwLastSrcIndex—Input/Background s ource index to s et in aux destination in preview area.
o
PgmLastSrcIndex—Input/Background source index to set in aux destination in program area.
• Response:
- response: null
- succ e ss : (0 = su cc e ss, an yth in g else is a n error)
• Example:
- {"params": {"id":0 , "Name": "AuxDest1" , "PvwLastSrcIndex": 6 , "PgmLastSrcIndex":
1}, "method":"changeAuxContent", "id":"1234", "jsonrpc":"2.0"}
Subscription and Un-Subscription
When a subscription is done from a JS ON-bas ed application, a notification is sent to the ip port where the application is running
when there is c hange for which the user has subscribed.
Actual notification is sent as ynchronously as an HTTP Post, with the following s tructure: {result: {method: "notifica-
tion",notificationType: "ScreenDestChanged",change: { add: [2], remove: [], update: [0, 1,
2] }}}.
The c hange field contains the XmlId(s) of the screens that were added/removed or updated.
All subscriptions are lost on ce the E vent Master p rocessor is restarted, and they must be subscribed again if
required.
R5905948 EVENT MASTER DEVICES 17/07/2017 521