Barco S3 - Page 521

B. Remote Control Protocol
listContent
•Definition
- This API shows the content of a screen destination.
• Request:
- params: {"id": x}
o
“id”—Screen destination index.
• Response:
- response: { "id": 0, "Name": "ScreenDest1""BGLyr":[{"id": 0, "LastBGSourceIndex": 0,
"BGShowMatte":0, "BGColor":[{"id":0, "Red":0, "Green":0, "Blue":0}]}, {"id": 1, "LastBG-
SourceIndex": 0, "BGShowMatte":0, "BGColor":[{"id":0, "Red":0, "Green":0, "Blue":0}]}],(0
= PGM Background, 1 = PVW Background)"Layers":[{"id": 0, "LastSrcIdx": 0, "HPos": 0,
"VPos": 0, "HSize": 400, "VSize": 300, "PvwMode": 0, "PgmMode": 0, "Freeze": 0,
"FlexZOrder": 0,"LayerTrans":[{"id": 0, "TransTime": 30, "TransPos": 0}, {"id": 1,
"TransTime": 30, "TransPos": 0}] , "3D": "Yes", "Freeze": 0, "Capacity": 2}]}]}
success: (0=success, anything else is an erro r )
o
id—index o f screen destination.
o
Name—Nam e of ScreenDes tination.
o
BGLayer—There are 2 bglayer , one in program and one in preview. Henc e, showing Index of background on screen
destination.
o
LastBGSoureIndex— This is –1 if no background is dropped, else this is index of last background dropped on screen
destination.
o
BGShowMatte—T his is if BG to be matte or not.
o
BGColor—Th is is background color.
o
Layers—Lists layers on screen d estination with its properties.
o
Transition—This property of s creen de stination contains the t ransition time (from time to move from preview to program).
• Example:
- {"params": {"id": 0}, "method":"listContent", "id":"1234", "jsonrpc":"2.0"}
changeContent
•Definition
- This A PI changes the content of a sc reen destination by putting background and lay ers in it.
• Request:
- params: {"id":0,"BGLyr":[{"id":0,"LastBGSourceIndex":0,"BGShowMatte":0,"BG-
Color":[{"id":0,"Red":0,"Green":0,"Blue":0}]},{"id":1,"LastBGSourceIn-
dex":0,"BGShowMatte":0,"BGColor":[{"id":0,"Red":0,"Green":0,"Blue":0}]}],"Lay-
ers":[{"id":0,"LastSrcIdx":0,"Window":{"HPos":0,"VPos":0,"HSize":400,"VSize":300},
"Source":{"HPos":0,"VPos":0,"HSize":1920,"VSize":1080}, "Mask":{ "
Left":0.01,
"Right":10.1, "Top":0.0,"Bottom":0.0},"PvwMode":1,"PgmMode":0,"Freeze":0,"Pgm-
ZOrder":0,"PvwZOrder":0}]}
o
id—Screen de stination index.
o
BGLayer—Background layer index, Las t source index of bac kground.
o
Layers—Layer informa tion.
o
Window—Layer window s ize.
o
Source—Source info and size.
o
Mask—Crop the visible part of the layer.
o
PvwMode— Se t 1 if you want the content in prev iew. (Default)
o
PgmMode— S et 1 if you wa nt the content in program.
• Response:
- response: null
- succ e ss : (0 = su cc e ss, an yth in g else is a n error)
• Example:
- {"params":{"id":0,"BGLyr":[{"id":0,"LastBGSourceIndex":0,"BGShowMatte":0,"BG-
Color":[{"id":0,"Red":0,"Green":0,"Blue":0}]},{"id":1,"LastBGSourceIn-
dex":0,"BGShowMatte":0,"BGColor":[{"id":0,"Red":0,"Green":0,"Blue":0}]}],"Lay-
ers":[{"id":0,"LastSrcIdx":0,"Window":{"HPos":0,"VPos":0,"HSize":400,"VSize":300},
"Source":{"HPos":0,"VPos":0,"HSize":1920,"VSize":1080}, "Mask":{ "Left":0.01,
"Right":10.1, "Top":0.0,"Bottom":0.0},"PvwMode":1,"PgmMode":0,"Freeze":0,"Pgm-
ZOrder":0,"PvwZOrder":0}]}, "method":"changeContent", "id":"1234", "jsonrpc":"2.0"}.
R5905948 EVENT MASTER DEVICES 17/07/2017
517