Barco PDS-4K HDMI Presentation Switcher User Manual

Page 207

Advertising
background image

207

R5912621 /01 PDS–4K

listStill

•

Definition:
-

This API lists all the stills with properties such as id, Name, H/V size, LockMode, StillState, PngState,
File size.

•

Request:
-

params:

{}

•

Response:
-

response: Array of :

[{"id":0,"Name":"StillStore1","LockMode":0,"HSize":

{"Min":0,"Max":99999,"$t":1920},"VSize":{"Min":0, "Max":99999,"$t":1080},

"StillState":{"Min":0,"Max":4,"$t":3},"PngState":{"Min":0,"Max":2,"$t":

0},"FileSize":{"Min":0,"Max":100000,"$t":9331.2}}]

◦

id—Index of still store.

◦

Name—Name of still store.

◦

LockMode—For future use. Always set to 0.

◦

H/V size—Horizontal and vertical size, Min, max and current value. It shows the current value.

◦

StillState—This tells user if the still is currently being captured or not, or if it is getting deleted.

◦

PngState—The “PNG” for stills are for the thumbnails we capture for the stills.

◦

FileSize—Size of the file created in KBs.

-

success: (0=success, anything else is an error)

•

Example:
-

{"params": {}, "method":"listStill", "id":"1234", "jsonrpc":"2.0"}

deleteStill

•

Definition:
-

This API deletes a still.

•

Request:
-

params:

{"id": x}

◦

id—Index of still.

•

Response:
-

response: null

-

success: (0=success, anything else is an error)

•

Example:
-

{"params":{"id": 0}, "method":"deleteStill", "id":"1234", "jsonrpc":"2.0"}

takeStill

•

Definition:
-

This API creates/overwrites a still.

•

Request:
-

params:

{ "type": x, "id": y, "file": z}

◦

type—0 for input source, 1 for BG source.

◦

Id—Index of the source. If the source id of the destination is provided, no still is created and an error
is shown.

◦

File—still file id. If you pass “file” : 5, this creates StillStore6.

•

Response:
-

response: null

-

success: (0=success, anything else is an error)

•

Example:
-

{"params":{"type":0 , "id": 1, "file": 5}, "method":"takeStill", "id":"1234",

"jsonrpc":"2.0"}

◦

This creates a still from input source id 1 as StillStore6.

Remote Control Protocol

Advertising