Video Settings

The video settings API allows external video preferences to be retrieved and set.

Retrieve video settings

URL/api/<auth_token>/video
MethodGET
Version1.0

Description

Retrieves the current video settings of the device.

Path arguments

Name Type Description Required
auth_token string The authentication token used to authenticate the request. Required

Response

Returns a Video Settings Object containing the video settings.

Change video settings

URL/api/<auth_token>/video
MethodPUT
Version1.0

Description

Changes the current video settings on the device.

Path arguments

Name Type Description Required
auth_token string The authentication token used to authenticate the request. Required

Body

Send a valid Video Settings Object containing the video settings you would like to change. This means you do not have to send the entirety of options, only ones you wish to alter.

Response

Returns an object with a success/error property indicating if the updates were set.

Download gradient

URL/api/<auth_token>/video/gradient/<gradient_style>
MethodGET
Version1.0

Description

Changes the current video settings on the device.

Path arguments

Name Type Description Required
auth_token string The authentication token used to authenticate the request. Required
gradient_style string The gradient style to retrieve. This can be either "Fade" or "current" to return the current gradient style. Required

Query arguments

Name Type Description Required
color string The color of the image to return in hexadecimal form. If omitted, the current overlay color setting is used or black otherwise. Required

esponse

Returns a PNG image of the gradient that is applied over the background color and media.