liveImageStream - Hyperion

Request a live image stream (if the current source priority supports it, otherwise here may be no response).
You will receive "ledcolors-imagestream-update" messages with a base64 encoded image.

curl --location -g --request POST 'https://localhost:8092/json-rpc/updates/images' \ --header 'Content-Type: application/json' \ --data-raw '{ "command": "ledcolors", "subcommand": "imagestream-start", "tan": 4711 }'

Request

Body Params application/json

command

enum<string>

required

The type of command to execute.vvvv

Allowed value:

ledcolors

subcommand

enum<string>

required

Sub-Command to be executed

Allowed values:

imagestream-startimagestream-stop

Example:

imagestream-start

tan

integer

optional

Transaction number for tracking requests and responses.

>= 0

Example:

4711

Examples

Responses

🟢200Success

application/json

Body

command

string

required

The command executed

subcommand

string

optional

The sub-command executed

success

boolean

required

Result, if the request excuted successfully

info

object

optional

Information requested

Additional properties

integer | number | string | boolean

optional

error

string

optional

Reason why a request did not execute successfully

errorData

array [object {1}]

optional

Detailed error explaination

description

string

optional

tan

integer

required

Request's transaction number