Barco S3 - Page 518

B. Remote Control Protocol
listDestinationsForPreset
•Definition
- Lists the content of a Preset.
• Request:
- params: {“id”:x },
“x” can b e :
o
–1: List all presets.
o
0–999: list only that specificpreset.
• Response:
- response: Array of: [{"id": 0, "Name": "Preset3.00", "LockMode": 0, "presetSno": 3.00,
"ScreenDest":[{"id": 0}, {"id": 3}],"AuxDest":[{"id": 0}, {"id": 1}]}]
o
Response contains the array of presets.
- succ e ss : (0 = su cc e ss, an yth in g else is a n error)
• Example:
- { "params":{"id": 0}, "method":"listDestinationsForPreset", "id":"1234", "jsonrpc":"2.0"}
savePreset
•Definition
- Creates a Preset on the Event Master processor.
• Request:
- params: {"presetName": "NewPreset", "ScreenDestination":[{"id": 2}, {"id": 3}],"AuxDes-
tination":[{"id": 1}, {"id": 2}]}
o
“presetName”—Name of the pre set to save.
o
ScreenDestinations—ScreenDest id for which prese t to be created.
o
AuxDestinations—AuxDest id for which preset to be created.
o
ScreenDestination, AuxDestinations are optional param eters. If us er didn’t provide it, preset w ill be sav ed for selected
destinations.
• Response:
- response: null
- succ e ss : (0 = su cc e ss, an yth in g else is a n error)
• Example:
- {"params": {"presetName": "NewPreset"}, "method":"savePreset", "id":"1234", "json-
rpc":"2.0"}
- {"params": {"presetName": "NewPreset", "ScreenDestination":{"id": 0},"AuxDestina-
tion":{"id": 0}}, "method":"savePreset", "id":"1234", "jsonrpc":"2.0"}
Key points regarding preset, which are same for renam e, activate, and delete:
- “id”—id of the pres e t.
- “presetSno”—preset serial number. User can provide floating point num ber if required. Eg. "presetSno": 1.01, "presetSno":
1.00, "presetSno": 1, "presetSno": 1.1, "presetSno": 1.10.
Kindly note that 1.1 and 1.10 or 1.00 and 1 are same.
- “presetName”—Name of the preset.
renamePreset
•Definition
- Rename a Preset on the E vent Master processor. User c an rename Pr eset with id, Preset serial num ber, or preset name.
- Send any one of the parameters to rename Preset.
• Request params:
- params: {"id": x, "newPresetName": "NewPresetName"}
- params: {"presetSno": x.y, "newPresetName": "NewPresetName"}
- params: {"presetName": "OldPresetName", "newPresetName": "NewPresetName"}
o
“newPresetName”—New P reset nam e to set.
• Response:
- response: null
- succ e ss : (0 = su cc e ss, an yth in g else is a n error)
• Example:
- {"params": {"id": 0, "newPresetName": " newPr esetName "}, "method":"renamePreset", "id":"
1234", "jsonrpc":"2.0"}
- {"params": {"presetName": "NewPreset", "newPresetName": "NewP resetName"}, "me thod":"renamePreset", "id":"1234",
"jsonrpc":"2.0"}
- {"params": {"presetSno": 1.00, "newPresetName": " newPresetName "}, "method":"renamePreset", "id":"1234",
"jsonrpc":"2.0"}
514
R5905948 EVENT MASTER DEVICES 17/07/2017