| Table of Contents | ||
|---|---|---|
|
...
| 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 | ||
|---|---|---|
| ||
{
"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 | ||
|---|---|---|
| ||
{
"setting": "standby"
} |
Response Body
200: This returns the updated power setting for the display, as shown in the example below.
...
| Code Block |
|---|
GET /api/v1/display-control/standby-timeout/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json |
Response Body
200: This returns the timeout/standby setting for the display, as shown in the example below.
...
| Code Block |
|---|
{
"seconds": 60
} |
Response Body
200: This returns the updated standby-timeout setting for the display, as shown in the example below.
...
| Code Block |
|---|
{
"connection": "tv"
} |
Response Body
200: This returns the updated USB connection setting for the display, as shown in the example below.
...
| Code Block |
|---|
{
"output": "HDMI2"
} |
Response Body
200: This returns the updated video output connection setting for the display, as shown in the example below.
...
| Code Block |
|---|
{
"data": {
"result": {
"success": true,
"output": "HDMI2"
}
}
} |
...
GET /v1/display-control/
...
volume/
...
Changes the white balance 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/white-balancevolume/ 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 | ||
|---|---|---|
| ||
{
"data": {
"result": {
"volume": 50
}
}
} |
PUT /v1/display-control/volume/
Changes the volume of a display connected to a BrightSign player.
Request Example
| Code Block |
|---|
PUT /api/v1/display-control/volume/ 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.
Response Example
| Code Block |
|---|
{
"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 | ||
|---|---|---|
| ||
{
"data": {
"result": {
"volume"redBalance": 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 |
|---|
{
"redBalance": 120,
"volumegreenBalance": 120,
"blueBalance": 100120
} |
Response Body
200: This returns the updated volume white balance setting for the display, as shown in the example below.
...
| Code Block |
|---|
{
"data": {
"result": {
"success": true,
"volumeredBalance": 120,
"greenBalance": 120,
"blueBalance": 100120
}
}
} |