Versions Compared
| Version | Old Version 2 | New Version 3 |
|---|---|---|
| Changes made by | ||
| Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Comment:
Added examples
GET /v1/video/:connector/output/:device/
Retrieves information about the specified video output.
Segments
connector: The current value is alwayshdmidevice: This value is0for single-output Series 5 players and all Series 4 and older players. The value can be0-3for the XC4055, which has multiple outputs, and0or1for the XC2055 and XT2145.
Request Example
The example request parameters and headers are set as follows:
:connectoris set tohdmi:deviceis set to0
GET /v1/video/:connector/output/:device/
Retrieves information about the specified video output.
Segments
connector: The current value is alwayshdmidevice: This value is0for single-output Series 5 players and all Series 4 and older players. The value can be0-3for the XC4055, which has multiple outputs, and0or1for the XC2055 and XT2145.
Request Example
The example request parameters and headers are set as follows:
:connectoris set tohdmi:deviceis set to0
| Code Block |
|---|
GET /api/v1/video/hdmi/output/0/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json |
Response Body
resolutionsresolutions[ ]: An array of information about the graphics, output, video resolution. Returns result values for height and width.edid_identity: Parses the above string in a JSON format for readability. Requires an HDMI output connected to the player and a display.edidstring: Returns the EDID read string of the display connected to the player. If power save is on, zeroes will be returnedstatus:audioBitsPerSampleintaudioChannelCountintaudioFormatstringaudioSampleRateinteotfstringoutputPoweredbooloutputPresentboolunstablebool
modes: List of all available video modes on the player.activeMode: Information about the active video mode on the playerbestModestring: The best video mode for the player. The HDMI connector must be attached because it gets details from EDID result.configuredMode: The configured video mode on the player. This can be different thanactiveMode.powerSaveStatusbool: This value indicates the power save status of the display connected to the player.
Response Example
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
Endpoints:
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
GET /v1/video/:connector/output/:device/edid/
Returns the EDID information from a compatible monitor/television connected to the video output.
Segments
connector: The current value is alwayshdmidevice: This value is0for single-output Series 5 players and all Series 4 and older players. The value can be0-3for the XC4055, which has multiple outputs, and0or1for the XC2055 and XT2145.
Request Example
The example request parameters and headers are set as follows:
:connectoris set tohdmi:deviceis set to0
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.
Segments
connector: The current value is alwayshdmidevice: This value is0for single-output Series 5 players and all Series 4 and older players. The value can be0-3for the XC4055, which has multiple outputs, and0or1for the XC2055 and XT2145.
Request Example
The example request parameters and headers are set as follows:
:connectoris set tohdmi:deviceis set to0
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.
Segments
connector: The current value is alwayshdmidevice: This value is0for single-output Series 5 players and all Series 4 and older players. The value can be0-3for the XC4055, which has multiple outputs, and0or1for the XC2055 and XT2145.
Request Example
The example request parameters and headers are set as follows:
:connectoris set tohdmi:deviceis set to0
http://192.168.4.43/api/v1/video/hdmi/output/0/power-save/
Request Body
enabledbool: 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.
Segments
connector: The current value is alwayshdmidevice: This value is0for single-output Series 5 players and all Series 4 and older players. The value can be0-3for the XC4055, which has multiple outputs, and0or1for the XC2055 and XT2145.
Request Example
The example request parameters and headers are set as follows:
:connectoris set tohdmi:deviceis set to0
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.
Segments
connector: The current value is alwayshdmidevice: This value is0for single-output Series 5 players and all Series 4 and older players. The value can be0-3for the XC4055, which has multiple outputs, and0or1for the XC2055 and XT2145.
http://192.168.4.43/api/v1/video/hdmi/output/0/mode/
Example
| Code Block |
|---|
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
modeNamestring: See Supported Video Modes for a list of the possible valid strings for your device
Example
| Code Block |
|---|
PUT /api/v1/video/hdmi/output/0/mode/{"modeName": "1920x1080x50p"} |