GET /v1/time/
Retrieves the date and time as configured on the player. The date/time value is formatted as "yyyy-mm-dd hh:mm:ss <timezone>"
.
Request Example
GET /api/v1/time/ HTTP/1.1 Host: {{playerIP}} Authorization: {{DigestAuth}}
Response Example
{ "route": "/v1/time", "method": "GET", "data": { "result": { "time": "2018-10-18 14:34:34 PDT", "timezone_mins": null, "timezone_name": "America/Los_Angeles", "timezone_abbr": "PDT", "year": 2018, "month": 10, "date": 18, "hour": 14, "minute": 34, "second": 34, "millisecond": 569 } } }
PUT /v1/time/
Sets the time on the player.
Request Body
date
string: The recommended format is: "YYYY-MM-DD
"time
string: The recommended format is: "HH:mm
"applyTimezone
bool: This value decides if the date and time passed is in UTC or not (the default is false).
Request Example
PUT /api/v1/time/ HTTP/1.1 Host: {{playerIP}} Authorization: {{DigestAuth}} Content-Type: application/json Content-Length: 117
This is the example request body:
{ "data": { "time": "22:00:00", "date": "2023-11-07", "applyTimezone": true } }
Response Example
{ "data": { "result": true } }
GET /v1/video-mode/
Returns the current video mode of the player
Request Example
GET /api/v1/video-mode/ HTTP/1.1 Host: {{playerIP}} Authorization: {{DigestAuth}}
Response Body
width
int: The screen widthheight
int: The screen heightframes
int: The frame ratescan
string: The scan method of the video signal, which can be either progressive ("p") or interlaced ("i")name
string: The full name of the video mode (a full list of modes can be found here)isAutoMode
bool: A flag indicating whether the video mode was set using auto modemode
mode{ }: A Mode object that gives additional information about the video output. This object can contain the following properties:preferred
bool: A flag indicating whether the video mode is the preferred modeoverscan
bool: A flag indicating whether the video output is using an overscan setting or notmodeName
string: The full name of the video mode (a full list of modes can be found here)interlaced
bool: A flag indicating whether the video output is interlaced (true
) or progressive (false
)width
int: The width of the video outputheight
int: The height of the video outputgraphicsPlaneWidth
int: The width of the graphics planegraphicsPlaneHeight
int: The height of the graphics planefrequency
int: The frame rate of the video outputdropFrame
bool: A flag indicating whether the video timecode utilizes drop framescolorSpace
string: The color space of the video signal ("rgb", "yuv420", or "yuv422")colorDepth
string: The color depth of the video signal ("8bit", "10bit", or "12bit")
Response Example
{ "route": "/v1/video-mode", "method": "GET", "data": { "result": { "isAutoMode": false, "name": "640x480x60p", "width": "640", "height": "480", "frames": "60", "scan": "p", "mode": { "colorDepth": "8bit", "colorSpace": "rgb", "dropFrame": false, "frequency": 60, "graphicsPlaneHeight": 480, "graphicsPlaneWidth": 640, "height": 480, "interlaced": false, "modeName": "640x480x60p", "overscan": false, "preferred": false, "width": 640 } } } }