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,
      "tvInfoidleStandbyTimeout": 50,
{      "powerSetting": "on",
      "macAddressvideoOutput": "ff:ff:ff:ff:ff:ff",HDMI1",
      "usbConnection": "brightsign",
      "fastTvStartEnabled": true
    }
   "wifiMacAddress": "ff:ff:ff:ff:ff:ff",
        "serialNo": "1234567890",
 }
}

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": {
      "osVersionresult": "V8-AM963BS-0020015",
 {
      "hwRevisionbrightness": 1100
    }
  },
      "whiteBalance": {
        "redBalance": 120,
        "greenBalance": 120,
        "blueBalance": 120
      },
      "volume": 50,
}

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": {
      "brightnesssuccess": 50true,
      "contrastbrightness": 50,100
    }
   "idleStandbyTimeout": 50,
      "powerSetting": "on",
      "videoOutput": "HDMI1",
}
}

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": {
     "usbConnectionresult": "brightsign",{
      "fastTvStartEnabledcontrast": true45
    }
  }
}

...

PUT /v1/display-control/

...

contrast/

...

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

Request Example

Code Block

GETPUT /api/v1/display-control/brightnesscontrast/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
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 brightness updated contrast setting for the display, as shown in the example below.

...

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
      "brightnesscontrast": 10045
    }
  }
}

...

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
PUTGET /api/v1/display-control/brightnessfast-tv-start/ 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 } {{playerIP}} Authorization: {{DigestAuth}} Accept: application/json

Response Body

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

Response Example

Code Block

language	json

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

...

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

This is the example request body:

Code Block

language	json

{
  "enable": true
}

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "dataresult": {
      "resultsuccess": {true,
      "contrastenable": 45true
    }
  }
}

PUT /v1/display-control/

...

firmware/

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

...

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

This is the example request body:

Code Block

language	json

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

Response Body

200202: This returns the updated contrast setting for the displayupdates the firmware and reboots the player, as shown in the example below.

Response Example

Code Block

language	json

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

GET /v1/display-control/

...

info/

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

Request Example

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

Response Body

200: This returns the fast tv start 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

json

{
  "data": {
    "result": {
      "macAddress": "ff:ff:ff:ff:ff:ff",
      "serialNo": "1234567890",
      "dataosVersion": { "V8-AM963BS-0020015",
      "resulthwRevision": {2,
      "enabledwifiMacAddress": true"ff:ff:ff:ff:ff:ff"
    }
  }
}

...

GET /v1/display-control/

...

power-

...

settings/

...

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

Request Example

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

This is the example request body:

Code Block
{ "enable": true }

Response Body

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

Response Example

Code Block

language	json

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

...

PUT /v1/display-control/

...

power-settings/

...

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

Request Example

Code Block

GETPUT /api/v1/display-control/firmwarepower-settings/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json}
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 firmware updated power setting for the display, as shown in the example below.

...

Code Block

language	json

{
  "data": {
    "result": {
      "enabledsuccess": 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"
},
      "setting": "standby"
    }
  }
}

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

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

Request Example

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

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "successseconds": true,
60
     "reboot": true
    }
  }
}

...

PUT /v1/display-control/

...

standby-

...

timeout/

...

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

Request Example

Code Block

GETPUT /api/v1/display-control/powerstandby-settingstimeout/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/jsonHost: {{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 power updated standby/timeout setting for the display, as shown in the example below.

...

Code Block

language	json

{
  "data": {
    "result": {
      "powerSettingsuccess": "on"true,
      "seconds": 60
    }
  }
}

...

GET /v1/display-control/

...

usb-

...

connection/

...

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

Request Example

Code Block
PUTGET /api/v1/display-control/powerusb-settingsconnection/ 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 USB connection setting for the display, as shown in the example below.

...

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
      "settingconnection": "standbybrightsign"
    }
  }
}

...

PUT /v1/display-control/

...

usb-

...

connection/

...

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

Request Example

Code Block

GETPUT /api/v1/display-control/standbyusb-timeoutconnection/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
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 timeout/standby updated USB connection setting for the display, as shown in the example below.

...

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
    "seconds": 60  "connection": "tv"
     }
  }
}

...

GET /v1/display-control/

...

video-

...

output/

...

Changes the standby-timeout 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/standbyvideo-timeoutoutput/ 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 } Accept: application/json

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "successoutput": true,
      "seconds": 60"HDMI1"
    }
  }
}

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

language	json

{
  "connectionoutput": "tvHDMI2"
}

Response Body

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

Response Example

Code Block

language	json

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

...

GET /v1/display-control/

...

volume/

...

Changes the video output 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/video-outputvolume/ 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" }1 Host: {{playerIP}} Authorization: {{DigestAuth}} Accept: application/json

Response Body

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "successvolume": true,
    50
 "output": "HDMI2"
    }
  }
}

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

language	json

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

Response Example

Code Block

language	json

{
  "data": {
    "result": {
      "success": true,
 
    "redBalanceresult": 120,{
      "greenBalancesuccess": 120true,
      "blueBalancevolume": 120100
    }
  }
}

GET /v1/display-control/

...

white-balance/

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

...

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

Response Body

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

...

Code Block

language	json

{
  "data": {
    "result": {
      "volumeredBalance": 120,
      "greenBalance": 120,
      "blueBalance": 50120
    }
  }
}

PUT /v1/display-control/

...

white-balance/

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

...

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

This is the example request body:

Code Block

language	json

{
  "redBalance": 120,
  "volume"greenBalance": 120,
  "blueBalance": 100120
}

Response Body

200: This returns the updated volume 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,
      "volumeblueBalance": 100120
    }
  }
}

Page Comparison

Versions Compared

Old Version 14

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/

PUT /v1/display-control/firmware/

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/