Page Comparison

...

style	none

GET /v1/display-control/

Returns all control settings for a display that is connected to a BrightSign player.

...

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

language	json

{
  "data": {
    "result": {
      "tvInfo": {
        "macAddress": "ff:ff:ff:ff:ff:ff",
        "wifiMacAddress": "ff:ff:ff:ff:ff:ff",
        "serialNo": "1234567890",
        "osVersion": "V8-AM963BS-0020015",
        "hwRevision": 1
      },
      "whiteBalance": {
        "redBalance": 120,
        "greenBalance": 120,
        "blueBalance": 120
      },
      "volume": 50,
      "brightness": 50,
      "contrast": 50,
      "idleStandbyTimeout": 50,
      "powerSetting": "on",
      "videoOutput": "HDMI1",
      "usbConnection": "brightsign",
      "fastTvStartEnabled": true
    }
  }
}

GET /v1/display-control/brightness/

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

...

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

language	json

{
  "data": {
    "result": {
      "brightness": 100
    }
  }
}

PUT /v1/display-control/brightness/

Changes the brightness setting of a display connected to a BrightSign player.

...

This is the example request body:

Code Block

language	json

{
  "value": 100
}

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
      "brightness": 100
    }
  }
}

GET /v1/display-control/contrast/

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

...

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

language	json

{
  "data": {
    "result": {
      "contrast": 45
    }
  }
}

PUT /v1/display-control/contrast/

Changes the contrast of a display connected to a BrightSign player.

...

This is the example request body:

Code Block

language	json

{
  "contrast": 45
}

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
      "contrast": 45
    }
  }
}

GET /v1/display-control/fast-tv-start/

Returns the fast tv start settings for a display that is connected to a BrightSign player.

...

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

language	json

{
  "data": {
    "result": {
      "enabled": true
    }
  }
}

PUT /v1/display-control/fast-tv-start/

Changes the fast start setting of a display connected to a BrightSign player.

...

This is the example request body:

{

Code Block

language

json

{
  "enable": true
}

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
      "enable": true
    }
  }
}

...

PUT /v1/display-control/firmware/

...

Returns Changes the firmware settings setting for a display that is connected to a BrightSign player.

Request Example

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

Response Example


Content-Type: application/json
Content-Length: 105

This is the example request body:

Code Block

language	json

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

Response Body

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

Response Example

Code Block

language	json

{
  "enableddata": true{
    "result": {
      "success": true,
      "reboot": true
    }
  }
}

...

GET /v1/display-control/

...

info/

...

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

Request Example

Code Block
PUTGET /api/v1/display-control/firmwareinfo/ HTTP/1.1 Host: {{playerIP}} Authorization: {{DigestAuth}} Accept: application/json Content-Type: application/json Content-Length: 105

...

Response Body

200: This returns the information about the BrightSign player that is connected to a display, as shown in the example below.

Response Example

Code Block

language	json

{
  "data": {
    "filepathresult": "path/to/firmware/relative/to/sd",
  "url": "https://example.com/tv-firmware.zip"
}{
      "macAddress": "ff:ff:ff:ff:ff:ff",
      "serialNo": "1234567890",
      "osVersion": "V8-AM963BS-0020015",
      "hwRevision": 2,
      "wifiMacAddress": "ff:ff:ff:ff:ff:ff"
    }
  }
}

GET /v1/display-control/power-settings/

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

Request Example

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

Response Body

200: This updates the firmware and reboots the playerreturns the power setting for the display, as shown in the example below.

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "successpowerSetting": true,       "reboot": true
"on"
    }
  }
}

...

PUT /v1/display-control/power-settings/

...

Returns Changes the power settings setting for a display that is connected to a BrightSign player.

Request Example

Code Block
GETPUT /api/v1/display-control/power-settings/ HTTP/1.1 Host: {{playerIP}} Authorization: {{DigestAuth}} Accept: application/json Content-Type: application/json Content-Length: 38

This is the example request body:

Code Block

language	json

{
  "setting": "standby"
}

Response Body

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

...

Code Block

language	json

{
  "data": {
    "result": {
      "powerSettingsuccess": true,
      "setting": "onstandby"
    }
  }
}

...

GET /v1/display-control/

...

standby-

...

timeout/

...

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

Request Example

Code Block
PUTGET /api/v1/display-control/powerstandby-settingstimeout/ HTTP/1.1 Host: {{playerIP}} Authorization: {{DigestAuth}} Accept: application/json Content-Type: application/json Content-Length: 38

This is the example request body:

Code Block

language	json

{
  "setting": "standby"
}1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Response Body

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

...

Code Block

language	json

{
  "data": {
    "result": {
      "successseconds": true,60
      "setting": "standby"
    }
  }
}

...

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

...

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

Request Example

Code Block
GETPUT /api/v1/display-control/standby-timeout/ 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

language	json

{
  "seconds": 60
}

Response Body

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

Response Example

Code Block

language	json

{{
  "data": {
    "dataresult": {
      "resultsuccess": {true,
      "seconds": 60
    }
  }
}

...

GET /v1/display-control/

...

usb-

...

connection/

...

Changes the standby-timeout setting of Returns the USB connection settings for a display that is connected to a BrightSign player.

Request Example

Code Block
PUTGET /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
{ "seconds": 60 } Host: {{playerIP}} Authorization: {{DigestAuth}} Accept: application/json

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "successconnection": true,       "seconds": 60
"brightsign"
    }
  }
}

...

PUT /v1/display-control/usb-connection/

...

Returns Changes the USB connection settings for setting of a display that is connected to a BrightSign player.

Request Example

Code Block
GETPUT /api/v1/display-control/usb-connection/ 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

language	json

{
  "connection": "tv"
}

Response Body

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

...

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
      "connection": "brightsigntv"
    }
  }
}

...

GET /v1/display-control/

...

video-

...

output/

...

Changes the USB connection setting of Returns the video output settings for a display that is connected to a BrightSign player.

Request Example

Code Block
PUTGET /api/v1/display-control/usbvideo-connectionoutput/ 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
{ "connection": "tv" } Authorization: {{DigestAuth}} Accept: application/json

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
      "connectionoutput": "tvHDMI1"
    }
  }
}

PUT /v1/display-control/video-output/

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

...

This is the example request body:

Code Block

language	json

{
  "output": "HDMI2"
}

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
      "output": "HDMI2"
    }
  }
}

GET /v1/display-control/volume/

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

...

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.

...

Code Block

language	json

{
  "data": {
    "result": {
      "volume": 50
    }
  }
}

PUT /v1/display-control/volume/

Changes the volume of a display connected to a BrightSign player.

...

This is the example request body:

Code Block

language	json

{
  "volume": 100
}

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
      "volume": 100
    }
  }
}

GET /v1/display-control/white-balance/

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

...

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

...

Code Block

language	json

{
  "data": {
    "result": {
      "redBalance": 120,
      "greenBalance": 120,
      "blueBalance": 120
    }
  }
}

PUT /v1/display-control/white-balance/

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

...

This is the example request body:

Code Block

language	json

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
      "redBalance": 120,
      "greenBalance": 120,
      "blueBalance": 120
    }
  }
}

...

Versions Compared

Old Version 16

New Version Current

Key

GET /v1/display-control/

GET /v1/display-control/brightness/

PUT /v1/display-control/brightness/

GET /v1/display-control/contrast/

PUT /v1/display-control/contrast/

GET /v1/display-control/fast-tv-start/

PUT /v1/display-control/fast-tv-start/

PUT /v1/display-control/firmware/

GET /v1/display-control/

info/

GET /v1/display-control/power-settings/

PUT /v1/display-control/power-settings/

GET /v1/display-control/

standby-

timeout/

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

GET /v1/display-control/

usb-

connection/

PUT /v1/display-control/usb-connection/

GET /v1/display-control/

video-

output/

PUT /v1/display-control/video-output/

GET /v1/display-control/volume/

PUT /v1/display-control/volume/

GET /v1/display-control/white-balance/

PUT /v1/display-control/white-balance/

Page Comparison

Versions Compared

Old Version 16

New Version Current

Key

<span class="diff-html-changed" data-a11y-before="Start of changed content" data-a11y-after="End of changed content" id="changed-diff-0">[data-colorid=</span>

GET /v1/display-control/

GET /v1/display-control/brightness/

PUT /v1/display-control/brightness/

GET /v1/display-control/contrast/

PUT /v1/display-control/contrast/

GET /v1/display-control/fast-tv-start/

PUT /v1/display-control/fast-tv-start/

PUT /v1/display-control/firmware/

GET /v1/display-control/

info/

GET /v1/display-control/power-settings/

PUT /v1/display-control/power-settings/

GET /v1/display-control/

standby-

timeout/

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

GET /v1/display-control/

usb-

connection/

PUT /v1/display-control/usb-connection/

GET /v1/display-control/

video-

output/

PUT /v1/display-control/video-output/

GET /v1/display-control/volume/

PUT /v1/display-control/volume/

GET /v1/display-control/white-balance/

PUT /v1/display-control/white-balance/