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:ffHDMI1",
        "wifiMacAddressusbConnection": "ff:ff:ff:ff:ff:ffbrightsign",

       "serialNofastTvStartEnabled": "1234567890", 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}} "osVersion": "V8-AM963BS-0020015", 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

{
  "hwRevisiondata": 1
    {
 },       "whiteBalanceresult": {
        "redBalancebrightness": 120,100
    }
   "greenBalance": 120,
        "blueBalance": 120
      },
      "volume": 50,
      "brightness": 50,
      "contrast": 50,
      "idleStandbyTimeout": 50,
      "powerSetting": "on",
      "videoOutput": "HDMI1",}
}

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": {
      "usbConnectionsuccess": "brightsign"true,
      "fastTvStartEnabledbrightness": true100
    }
  }
}

GET /v1/display-control/

...

contrast/

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

...

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

Response Body

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

...

Code Block

language	json

{
  "data": {
    "result": {
      "brightnesscontrast": 10045
    }
  }
}

PUT /v1/display-control/

...

contrast/

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

...

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

This is the example request body:

Code Block

language	json

{
  "valuecontrast": 10045
}

Response Body

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

Response Example

Code Block

language	json

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

GET /v1/display-control/

...

fast-tv-start/

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

...

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

Response Body

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

...

Code Block

language	json

{
  "data": {
    "result": {
      "contrastenabled": 45true
    }
  }
}

PUT /v1/display-control/

...

fast-tv-start/

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

...

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

This is the example request body:

Code Block

language	json

{
  "contrastenable": 45true
}

Response Body

200: This returns the updated contrast 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,
      "contrastenable": 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/ HTTP/1.1 Host: {{playerIP}} Authorization: {{DigestAuth}} Accept: application/json

Response Body

...

 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": {
      "enabled"success": true,
      "reboot": true
    }
  }
}

...

GET /v1/display-control/

...

info/

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

Request Example

Code Block

PUTGET /api/v1/display-control/fast-tv-startinfo/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{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 the fast start setting for the display as true, as shown in the example below.

Response Example

Code Block
{ "data": { {{DigestAuth}} Accept: application/json

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": {
    "result": {
      "macAddress": "ff:ff:ff:ff:ff:ff",
      "serialNo": "1234567890",
      "resultosVersion": {"V8-AM963BS-0020015",
      "successhwRevision": true2,
      "enable": truewifiMacAddress": "ff:ff:ff:ff:ff:ff"
     }
  }
}

GET /v1/display-control/

...

power-settings/

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

...

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

Response Body

200: This returns the firmware 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 firmware power setting for a display connected to a BrightSign player.

...

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

This is the example request body:

Code Block

language	json

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

Response Body

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

Response Example

Code Block

language	json

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

GET /v1/display-control/

...

standby-

...

timeout/

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

...

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

Response Body

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

...

Code Block

language	json

{
  "data": {
    "result": {
      "powerSettingseconds": "on"60
    }
  }
}

PUT /v1/display-control/

...

standby-

...

timeout/

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

...

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

{
  "settingseconds": "standby"60
}

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": {
      "success": true,
      "settingseconds": "standby"60
    }
  }
}

GET /v1/display-control/

...

usb-

...

connection/

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

...

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

Response Body

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

...

Code Block

language	json

{
  "data": {
    "result": {
      "secondsconnection": 60"brightsign"
    }
  }
}

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

language	json

{
  "secondsconnection": 60"tv"
}

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": {
      "success": true,
      "secondsconnection": 60"tv"
    }
  }
}

...

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" }{{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": {
      "successoutput": true,
      "connectionHDMI1":
"tv"     }
  }
}

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

...

Page Comparison

Versions Compared

Old Version 15

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/

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