These display-control APIs can only be used on Moka displays that have built-in BrightSign players and are only available in BOS 9.0.189and above.
Base URL for these endpoints: https://ws.bsn.cloud/rest/v1/
_________________________________________________________________________
GET /v1/display-control/
...
Code Block |
---|
GET /rest/v1/display-control/?destinationType=player&destinationName={{playerSerial}} HTTP/1.1 Host: ws.bsn.cloud Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json |
Response Body
200: This returns the display control settings, as shown in the example below.
...
Code Block |
---|
GET /rest/v1/display-control/brightness/?destinationType=player&destinationName={{playerSerial}} HTTP/1.1 Host: ws.bsn.cloud Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json |
Response Body
200: This returns the brightness setting for the display, as shown in the example below.
...
Code Block | ||
---|---|---|
| ||
{ "brightness": 100 } |
Response Body
200: This returns the updated brightness setting for the display, as shown in the example below.
...
Code Block |
---|
GET /rest/v1/display-control/contrast/?destinationType=player&destinationName={{playerSerial}} HTTP/1.1 Host: ws.bsn.cloud Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json |
Response Body
200: This returns the contrast setting for the display, as shown in the example below.
...
Code Block | ||
---|---|---|
| ||
{ "contrast": 45 } |
Response Body
200: This returns the updated contrast setting for the display, as shown in the example below.
...
Code Block |
---|
GET /rest/v1/display-control/always-connected/?destinationType=player&destinationName={{playerSerial}} HTTP/1.1 Host: ws.bsn.cloud Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json |
Response Body
200: This returns the connection setting for the display, as shown in the example below.
...
Code Block | ||
---|---|---|
| ||
{ "enable": true } |
Response Body
200: Returns the connection setting for the display as true
, as shown in the example below.
...
Code Block | ||
---|---|---|
| ||
{ "url": "https://example.com/tv-firmware.zip" } |
Response Body
202: This updates the firmware and reboots the player, as shown in the example below.
...
Code Block |
---|
GET /rest/v1/display-control/info/?destinationType=player&destinationName={{playerSerial}} HTTP/1.1 Host: ws.bsn.cloud Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json |
Response Body
200: This returns information about a display that is connected to a BrightSign player, as shown in the example below.
...
Code Block |
---|
GET /rest/v1/display-control/power-settings/?destinationType=player&destinationName={{playerSerial}} HTTP/1.1 Host: ws.bsn.cloud Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json |
Response Body
200: This returns the power setting for the display, as shown in the example below.
...
Code Block | ||
---|---|---|
| ||
{ "setting": "standby" } |
Response Body
200: This returns the updated power setting for the display, as shown in the example below.
...
Code Block |
---|
GET /rest/v1/display-control/standby-timeout/?destinationType=player&destinationName={{playerSerial}} HTTP/1.1 Host: ws.bsn.cloud Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json |
Response Body
200: This returns the standby/timeout setting for the display, as shown in the example below.
...
Code Block | ||
---|---|---|
| ||
{ "seconds": 60 } |
Response Body
200: This returns the updated standby/timeout setting for the display, as shown in the example below.
...
Code Block |
---|
GET /rest/v1/display-control/sd-connection/?destinationType=player&destinationName={{playerSerial}} HTTP/1.1 Host: ws.bsn.cloud Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json |
Response Body
200: This returns the SD connection setting for the display, as shown in the example below.
...
Code Block | ||
---|---|---|
| ||
{ "connection": "display" } |
Response Body
200: This returns the updated SD connection setting for the display, as shown in the example below.
...
Code Block |
---|
GET /rest/v1/display-control/video-output/?destinationType=player&destinationName={{playerSerial}} HTTP/1.1 Host: ws.bsn.cloud Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json |
Response Body
200: This returns the video output setting for the display, as shown in the example below.
...
Code Block | ||
---|---|---|
| ||
{ "output": "HDMI2" } |
Response Body
200: This returns the updated video output connection setting for the display, as shown in the example below.
...
Code Block |
---|
GET /rest/v1/display-control/volume/?destinationType=player&destinationName={{playerSerial}} HTTP/1.1 Host: ws.bsn.cloud Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json |
Response Body
200: This returns the volume setting for the display, as shown in the example below.
...
Code Block | ||
---|---|---|
| ||
{ "volume": 100 } |
Response Body
200: This returns the updated volume setting for the display, as shown in the example below.
...
Code Block |
---|
GET /rest/v1/display-control/white-balance/?destinationType=player&destinationName={{playerSerial}} HTTP/1.1 Host: ws.bsn.cloud Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json |
Response Body
200: This returns the white balance setting for the display, as shown in the example below.
...
Code Block | ||
---|---|---|
| ||
{ "redBalance": 120, "greenBalance": 120, "blueBalance": 120 } |
Response Body
200: This returns the updated white balance setting for the display, as shown in the example below.
...