B. Remote Control Protocol
freezeDestSources
•Definition
- This API Freezes/Unfreezes the sources.
• Request:
- params: {"type": x, "id": y, "screengroup": z ,"mode": 0/1}
o
type—type of source.
o
0—Input source.
o
1—Background source.
o
2—ScreenD estination.
o
3—AuxDes tination.
o
id—Index o f the source.
- id—Index of the source.
- Screengroup—For future use. Always set to 0.
- Mode—0 : UnFreeze, 1 : Freeze.
• Response:
- response: null
- succ e ss : (0 = su cc e ss, an yth in g else is a n error)
• Example:
- {"params": {"type": 0, "id": 0, "screengroup": 0 ,"mode": 1}, "method":"freezeDest-
Source", "id":"1234", "jsonrpc":"2.0"}
listStill
•Definition
- This API lists all the stills with properties such as id, N am e, H/V size, LockMode, StillState, PngState, File size.
• Request:
- params: {}
• Response:
- response: Array of : [{"id":0,"Name":"StillStore1","Lock-
Mode":0,"HSize":{"Min":0,"Max":99999,"$t":1920},"VSize":{"Min":0,"Max":99999,"$t":1080},"Still-
State":{"Min":0,"Max":4,"$t":3},"PngState":{"Min":0,"Max":2,"$t":0},"File-
Size":{"Min":0,"Max":100000,"$t":9331.2}}]
o
id—Index of still store.
o
Name—Name of still store.
o
LockMode—For future use. Always set to 0.
o
H/V s ize—Horizontal and vertical s ize, Min, max and current value. It shows the c urrent value.
o
StillState—This tells user if the still is currently being c aptured or not, or if it is getting deleted.
o
PngState—The “PNG ” for stills are for the thumbnails we capture for the stills.
o
FileSize—S ize of the file created in KBs.
- succ e ss : (0 = su cc e ss, an yth in g else is a n error)
• Example:
- {"params": {}, "method":"listStill", "id":"1234", "jsonrpc":"2.0"}
deleteStill
•Definition
- This API deletes a still.
• Request:
- params: {“id”: x}
o
id—Index of still.
• Response:
- response: null
- succ e ss : (0 = su cc e ss, an yth in g else is a n error)
• Example:
- {"params":{"id": 0}, "method":"deleteStill", "id":"1234", "jsonrpc":"2.0"}
518
R5905948 EVENT MASTER DEVICES 17/07/2017