Versions Compared

Old Version 13

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 14

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone

...

Code Block
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.

...

Code Block
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.

...

Code Block
{
  "value": 100
}

Response Body

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

...

Code Block
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.

...

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 /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.

...

Code Block
{
  "enable": true
}

Response Body

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

...

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

Response Body

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

...

Code Block
languagejson
{
  "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.

...

Code Block
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.

...

Code Block
languagejson
{
  "setting": "standby"
}

Response Body

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

...

Code Block
languagejson
{
  "data": {
    "result": {
      "success": true,
      "setting": "standby"
    }
  }
}

GET /v1/display-control/

...

standby-timeout/ 

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

...

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

Response Body

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

...

Code Block
languagejson
{
  "data": {
    "result": {
      "volumeseconds": 5060
    }
  }
}

PUT /v1/display-control/

...

standby-timeout/  

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

...

Code Block
PUT /api/v1/display-control/volumestandby-timeout/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 1619

This is the example request body:

Code Block
{
  "volumeseconds": 10060
}

Response Body

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

...

Code Block
{
  "data": {
    "result": {
      "success": true,
      "volumeseconds": 10060
    }
  }
}

PUT /v1/display-control/

...

usb-

...

connection/  

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

...

Code Block
PUT /api/v1/display-control/standbyusb-timeoutconnection/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 19

This is the example request body:

Code Block
{
  "secondsconnection": 60"tv"
}

Response Body

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

...

Code Block
{
  "data": {
    "result": {
      "success": true,
      "secondsconnection": 60"tv"
    }
  }
}

PUT /v1/display-control/

...

video-

...

output/  

Changes the USB connection video output setting of a display connected to a BrightSign player.

...

Code Block
PUT /api/v1/display-control/usbvideo-connectionoutput/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 1918

This is the example request body:

Code Block
{
  "connectionoutput": "tvHDMI2"
}

Response Body

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

...

Code Block
{
  "data": {
    "result": {
      "success": true,
      "connectionoutput": "tvHDMI2"
    }
  }
}

PUT /v1/display-control/

...

white-

...

balance/  

Changes the video output white balance setting of a display connected to a BrightSign player.

...

Code Block
PUT /api/v1/display-control/videowhite-outputbalance/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 1855

This is the example request body:

Code Block
{
  "output": "HDMI2""redBalance": 120,
  "greenBalance": 120,
  "blueBalance": 120
}

Response Body

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

...

Code Block
{
  "data": {
    "result": {
      "success": true,
      "outputredBalance": "HDMI2"120,
    }  "greenBalance": 120,
      "blueBalance": 120
    }
  }
}

GET /v1/display-control/volume/ 

Returns the volume settings for a display that is connected to a BrightSign player.

Request Example

Code Block
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.

Response Example

Code Block
languagejson
{
  "data": {
    "result": {
      "volume": 50
    }
  }
}

PUT /v1/display-control/

...

volume/  

Changes the white balance setting volume of a display connected to a BrightSign player.

...

Code Block
PUT /api/v1/display-control/white-balancevolume/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 5516

This is the example request body:

Code Block
{
  "redBalancevolume": 120,
  "greenBalance": 120,
  "blueBalance": 120
100
}

Response Body

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

...

Code Block
{
  "data": {
    "result": {
      "success": true,
      "redBalancevolume": 120,
      "greenBalance": 120,
      "blueBalance": 120100
    }
  }
}