Page Comparison

...

style	none

GET /v1/display-control/

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

Request Example

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.

Response Example

...

language	json

...

GET /v1/display-control/

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

Request Example

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.

Response Example

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.

Request Example

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.

Response Example

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.

Request Example

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

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.

Request Example

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.

Response Example

Code Block

language	json

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

PUT /v1/display-control/contrast/

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

Request Example

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

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,
      "brightnesscontrast": 50,45
    }
  }
}

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

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

Request Example

Code Block

GET /api/v1/display-control/fast-tv-start/   "contrast": 50,
      "idleStandbyTimeout": 50,
      "powerSetting": "on",
      "videoOutput": "HDMI1",
 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.

Response Example

Code Block

language	json

{
  "data": {
    "usbConnectionresult": "brightsign",{
      "fastTvStartEnabledenabled": true
    }
  }
}

...

PUT /v1/display-control/

...

fast-tv-start/

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

Request Example

Code Block
GETPUT /api/v1/display-control/brightness//fast-tv-start/ 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.

Response Example


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

This is the example request body:

Code Block

language	json

{
  "data": {
    "result": {
  {
   "brightnessenable": 100
    }
  }
}

PUT /v1/display-control/brightness/

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

Request Example

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

This is the example request body:

Code Block
{ "value": 100 }

Response Body

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

Response Example

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

Request Example

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

Response Body

...

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/

Changes the firmware setting for a display connected to a BrightSign player.

Request Example

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

This is the example request body:

Code Block

language	json

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

...

Code Block

language	json

{
  "data": {
    "result": {
      "contrastsuccess": true,
      "reboot": 45true
    }
  }
}

...

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/contrastinfo/ HTTP/1.1 Host: {{playerIP}} Authorization: {{DigestAuth}} Accept: application/json Content-Type: application/json Content-Length: 22

This is the example request body:

Code Block
{ "contrast": 45 }

Response Body

200: This returns the updated contrast setting for 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": {
    "result": {
      "macAddress": "ff:ff:ff:ff:ff:ff",
      "dataserialNo": {"1234567890",
      "resultosVersion": {"V8-AM963BS-0020015",
      "successhwRevision": true2,
      "contrastwifiMacAddress": 45"ff:ff:ff:ff:ff:ff"
    }
  }
}

GET /v1/display-control/

...

power-

...

settings/

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

...

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

Response Body

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

...

Code Block

language	json

{
  "data": {
    "result": {
      "enabledpowerSetting": true"on"
    }
  }
}

PUT /v1/display-control/

...

power-

...

settings/

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

...

Code Block
PUT /api/v1/display-control/fastpower-tv-startsettings/ HTTP/1.1 Host: {{playerIP}} Authorization: {{DigestAuth}} Accept: application/json Content-Type: application/json Content-Length: 2338

This is the example request body:

Code Block

language	json

{
  "enablesetting": true"standby"
}

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
      "enablesetting": true"standby"
    }
  }
}

GET /v1/display-control/

...

standby-timeout/

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

...

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

Response Body

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

...

Code Block

language	json

{
  "data": {
    "result": {
      "enabledseconds": true60
    }
  }
}

PUT /v1/display-control/

...

standby-timeout/

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

...

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

This is the example request body:

Code Block

language	json

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

Response Body

200: This updates the firmware and reboots the playerreturns the updated standby/timeout setting for the display, as shown in the example below.

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
      "rebootseconds": true60
    }
  }
}

GET /v1/display-control/

...

usb-

...

connection/

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

...

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

Response Body

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

...

Code Block

language	json

{
  "data": {
    "result": {
      "powerSettingconnection": "onbrightsign"
    }
  }
}

PUT /v1/display-control/

...

usb-

...

connection/

Changes the power USB connection setting for of a display connected to a BrightSign player.

...

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

This is the example request body:

Code Block

language	json

{
  "settingconnection": "standbytv"
}

Response Body

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

...

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
      "setting": "standby",
    }   }
}

PUT /v1/display-control/firmware/

Changes the firmware setting for a display connected to a BrightSign player.

Request Example

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

This is the example request body:

Code Block

language	json

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

GET /v1/display-control/video-output/

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

Request Example

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

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "successoutput": true,       "reboot": true"HDMI1"
    }
  }
}

PUT /v1/display-control/

...

video-output/

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

...

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

This is the example request body:

Code Block

language	json

{
  "volumeoutput": 100"HDMI2"
}

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
      "volumeoutput": 100"HDMI2"
    }
  }
}

...

GET /v1/display-control/

...

volume/

...

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

Request Example

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

This is the example request body:

code

{
  "seconds": 60
}

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "successvolume": true,
   50
  "seconds": 60     }
  }
}

PUT /v1/display-control/

...

volume/

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

...

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

This is the example request body:

Code Block

language	json

{
  "connectionvolume": "tv"100
}

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
      "connectionvolume": "tv"100
    }
  }
}

...

GET /v1/display-control/

...

white-

...

balance/

...

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

Request Example

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

This is the example request body:

Code Block
{ "output": "HDMI2" }: {{playerIP}} Authorization: {{DigestAuth}} Accept: application/json

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "successredBalance": true120,
      "outputgreenBalance": 120,
      "HDMI2blueBalance": 120
    }
  }
}

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

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

...

Code Block
PUT /api/v1/display-control/white-balance/ 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

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
    }
  }
}

...

Page Comparison

Versions Compared

Old Version 12

New Version 24

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

GET /v1/display-control/contrast/

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/

PUT /v1/display-control/firmware/

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/