- Created by BrightSign TechDocs, last modified on Feb 22, 2024
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 10 Next »
Remote Snapshot Tab
POST /v1/snapshot/
Captures a snapshot of the currently played content on the player
Video Tab
Note that :connector supports only HDMI® and that :device
is the numeric index of the output, which is currently only 0.
GET /v1/video/:connector/output/:device/
Retrieves information about the specified video output.
An example of :connector is “hdmi” (without the quotes), and an example of :device is “0”, for example: http://192.168.4.43/api/v1/video/hdmi/output/0/
GET /v1/video/:connector/output/:device/edid/
Returns the EDID information from a compatible monitor/television connected to the video output.
An example of :connector is “hdmi” (without the quotes), and an example of :device is “0”, for example: http://192.168.4.43/api/v1/video/hdmi/output/0/edid/
GET /v1/video/:connector/output/:device/power-save/
Retrieves the power status of the monitor connected to the player.
An example of :connector is “hdmi” (without the quotes), and an example of :device is “0”, for example: http://192.168.4.43/api/v1/video/hdmi/output/0/power-save/
PUT /v1/video/:connector/output/:device/power-save/
Enables or disables power-save mode on the monitor connected to the player.
Request Body
enabled
bool: Whether the power-save mode on the monitor is enabled or disabled
GET /v1/video/:connector/output/:device/modes/
Returns a list of all available video modes on the specified video output.
An example of :connector is “hdmi” (without the quotes), and an example of :device is “0”, for example: http://192.168.4.43/api/v1/video/hdmi/output/0/modes/
GET /v1/video/:connector/output/:device/mode/
Retrieves the current video mode on the specified video output.
An example of :connector is “hdmi” (without the quotes), and an example of :device is “0”, for example: http://192.168.4.43/api/v1/video/hdmi/output/0/mode/
Example
GET /api/v1/video/hdmi/output/0/mode
PUT /v1/video/:connector/output/:device/mode/
Changes the video mode on the player. You should first send a GET request to find the body parameters of this API, but only the parameter below is required (all others are optional):
Request Body
modeName
string: See Supported Video Modes for a list of the possible valid strings for your device
Example
PUT /api/v1/video/hdmi/output/0/mode/{"modeName": "1920x1080x50p"}
Advanced Tab
GET /v1/system/supervisor/logging/
Returns the current logging level on the player. The default value is INFO.
PUT /v1/system/supervisor/logging/
Sets the logging level on the player.
Request Body
level
int: The integer values correspond to the logging levels: TRACE (3), INFO (2), WARN (1), ERROR (0)
Registry Tab
GET /v1/registry/
Returns the entire registry dump. The hidden registry sections are not returned in this response.
Request Example
The example request parameters and headers are set as follows:
GET /api/v1/registry/ HTTP/1.1 Host: {{player_ip_address}} Authorization: Bearer {{UserAccessToken}} Accept: application/json
Response Body
success
bool: If the operation is successfulvalue
object: The keys are the names of the registry sections. These are some examples:brightscript
string: The BrightScript key-value pairsnetworking
string: The networking key-value pairs
GET /v1/registry/:section/:key/
Returns a particular key value for a specified section and key.
Segment Values
section
string: The name of the registry sectionkey
string: The name of the registry key
Request Example
The example request parameters and headers are set as follows:
section
is set tohtml
key
is set touse-brightsign-media-player
GET /api/v1/registry/html/use-brightsign-media-player/ HTTP/1.1 Host: {{player_ip_address}} Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json
PUT /v1/registry/:section/:key/
Creates registry values. Do a GET first to see which keys are available.
Applications rely on the values they have set in the registry. Please be mindful of what you type to avoid putting the player in an unstable state.
Segment Values
section
string: The name of the registry section (for example, "html" or "networking")key
string: The name of the registry key
Request Example
The example request parameters and headers are set as follows:
section
is set tohtml
key
is set touse-brightsign-media-player
PUT /api/v1/registry/html/use-brightsign-media-player/ HTTP/1.1 Host: {{local_ip_address}} Authorization: Bearer {{UserAccessToken}} Accept: application/json Content-Type: application/json Content-Length: 33
This is the example request body:
{ "value": "0" }
DELETE /v1/registry/:section/:key/
Remove the specified registry values.
Applications rely on the values they have set in the registry. Please be mindful of what you type to avoid putting the player in an unstable state.
Segment Values
section
string: The name of the registry section (for example, "html" or "networking")key
string: The name of the registry key
Request Example
The example request parameters and headers are set as follows:
section
is set tohtml
key
is set touse-brightsign-media-player
DELETE /api/v1/registry/html/use-brightsign-media-player/ HTTP/1.1 Host: {{player_ip_address}} Authorization: Bearer {{UserAccessToken}} Accept: application/json
DELETE /v1/registry/:section/
Deletes an entire registry section
Request Example
The example request parameters and headers are set as follows:
section
is set totest_section
DELETE /api/v1/registry/test_section/ HTTP/1.1 Host: {{player_ip_address}} Authorization: Bearer {{UserAccessToken}} Accept: application/json
GET /v1/registry/recovery_url/
Retrieves the recovery URL stored in the player registry
Request Example
recovery_url
is the recovery URL in the player registry
GET /api/v1/registry/recovery_url/ HTTP/1.1 Host: {{player_ip_address}} Authorization: Bearer {{UserAccessToken}} Accept: application/json
Response Body
success
bool: A flag indicating whether the request was successfully readvalue
string: The recovery URL
PUT /v1/registry/recovery_url/
Updates the recovery URL in the player’s registry.
Request Body
url
string: The value of the recovery URL
Request Example
The example request parameters and headers are set as follows:
url
is set towww.google.com
PUT /api/v1/registry/recovery_url/ HTTP/1.1 Host: {{player_ip_address}} Authorization: Bearer {{UserAccessToken}} Accept: application/json Content-Type: application/json Content-Length: 37
Request Body
{ "url": "www.google.com" }
Endpoints:
- No labels