Page Comparison

...

GET /api/v1/display-control/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Response Body

200: This returns the display control settings, as shown in the example below.

...

GET /api/v1/display-control/brightness/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Response Body

200: This returns the brightness setting for the display, as shown in the example below.

...

{
  "value": 100
}

Response Body

200: This returns the updated brightness setting for the display, as shown in the example below.

...

GET /api/v1/display-control/contrast/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Response Body

200: This returns the contrast setting for the display, as shown in the example below.

...

{
  "contrast": 45
}

Response Body

200: This returns the updated contrast setting for the display, as shown in the example below.

...

GET /api/v1/display-control/fast-tv-start/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Response Body

200: This returns the fast tv start setting for the display, as shown in the example below.

...

{
  "enable": true
}

Response Body

200: Returns the fast start setting for the display as true, as shown in the example below.

...

{
  "filepath": "path/to/firmware/relative/to/sd",
  "url": "https://example.com/tv-firmware.zip"
}

Response Body

200: This updates the firmware and reboots the player, as shown in the example below.

...

GET /api/v1/display-control/power-settings/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Response Body

200: This returns the power setting for the display, as shown in the example below.

...

{
  "setting": "standby"
}

Response Body

200: This returns the updated power setting for the display, as shown in the example below.

...

GET /v1/display-control/standby-timeout/ 

Returns the standby/timeout /standby settings for a display that is connected to a BrightSign player.

...

GET /api/v1/display-control/standby-timeout/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Response Body

200: This returns the standby/timeout /standby setting for the display, as shown in the example below.

...

PUT /v1/display-control/standby-timeout/  

Changes the standby-/timeout setting of a display connected to a BrightSign player.

...

{
  "seconds": 60
}

Response Body

200: This returns the updated standby-/timeout setting for the display, as shown in the example below.

...

GET /api/v1/display-control/usb-connection/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Response Body

200: This returns the USB connection setting for the display, as shown in the example below.

...

{
  "connection": "tv"
}

Response Body

200: This returns the updated USB connection setting for the display, as shown in the example below.

...

GET /api/v1/display-control/video-output/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Response Body

200: This returns the video output setting for the display, as shown in the example below.

...

{
  "output": "HDMI2"
}

Response Body

200: This returns the updated video output connection setting for the display, as shown in the example below.

...

GET /api/v1/display-control/volume/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Response Body

200: This returns the volume setting for the display, as shown in the example below.

...

{
  "volume": 100
}

Response Body

200: This returns the updated volume setting for the display, as shown in the example below.

...

GET /api/v1/display-control/white-balance/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Response Body

200: This returns the white balance setting for the display, as shown in the example below.

...

{
  "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.

...