Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

GET /v1/display-control/ 

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

Request Example 

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

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

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

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

PUT /v1/display-control/brightness/  

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

Request Example

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:

{
  "value": 100
}

Response Body

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

Response Example

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

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

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

PUT /v1/display-control/contrast/  

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

Request Example

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:

{
  "contrast": 45
}

Response Body

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

Response Example

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

Request Example 

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.

Response Example

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

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

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

Request Example

PUT /api/v1/display-control/fast-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:

{
  "enable": true
}

Response Body

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

Response Example

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

GET /v1/display-control/firmware/ 

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

Request Example 

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.

Response Example

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

PUT /v1/display-control/firmware/  

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

Request Example

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:

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

Response Example

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

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

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

Request Example 

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.

Response Example

{
  "data": {
    "result": {
      "powerSetting": "on"
    }
  }
}

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

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

Request Example 

PUT /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: 

{
  "setting": "standby"
}

Response Body

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

Response Example 

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

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

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

Request Example 

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.

Response Example

{
  "data": {
    "result": {
      "seconds": 60
    }
  }
}

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

Changes the standby-timeout setting of a display connected to a BrightSign player.

Request Example

PUT /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:

{
  "seconds": 60
}

Response Body

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

Response Example

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

GET /v1/display-control/usb-connection/ 

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

Request Example 

GET /api/v1/display-control/usb-connection/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Response Body

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

Response Example

{
  "data": {
    "result": {
      "connection": "brightsign"
    }
  }
}

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

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

Request Example

PUT /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:

{
  "connection": "tv"
}

Response Body

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

Response Example

{
  "data": {
    "result": {
      "success": true,
      "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 

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

Response Body

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

Response Example

{
  "data": {
    "result": {
      "output": "HDMI1"
    }
  }
}

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

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

Request Example

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

This is the example request body:

{
  "output": "HDMI2"
}

Response Body

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

Response Example

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

Request Example 

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.

Response Example

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

PUT /v1/display-control/volume/  

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

Request Example

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

This is the example request body:

{
  "volume": 100
}

Response Body

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

Response Example

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

Request Example 

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.

Response Example

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

Request Example

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

This is the example request body:

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

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

  • No labels