Hyperion
  1. Input Controls
Hyperion
  • JSON-RPC API Introduction
  • JSON-API Commands Overview
  • Connect to Hyperion
  • Components & Priorities
  • Hyperion API
    • Authorization
      • API Authentication - Introduction
      • createToken
      • renameToken
      • deleteToken
      • getTokenlist
      • tokenRequired
      • adminRequired
      • newPasswordRequired
      • requestToken
      • newPassword
      • answerRequest
      • getPendingTokenRequests
      • login
      • logout
    • Information
      • getSystemInformation
      • getSubscriptionInformation
      • getServerInformation
      • getImageSnapshot
      • getLedsSnapshot
    • Controls
      • Input Controls
        • setColor
          POST
        • setEffect
          POST
        • setImage
          POST
        • clear
          POST
        • clearAll
          POST
        • selectSource
          POST
      • Output Controls
        • adjustColors
        • setLedMapping
        • setVideomode
      • Subscription Controls
        • liveImageStream
        • liveLedColorStream
      • Operational Controls
        • setComponentState
        • setInstanceState
        • switchInstance
        • setSystemState
        • setSubscriptions
    • Configuration
      • createInstance
      • deleteInstance
      • renameInstance
      • getConfiguration
      • updateConfiguration
      • restoreConfiguration
      • getSchemas
  1. Input Controls

setImage

Testing Env
https://{{host}}:8092
Testing Env
https://{{host}}:8092
POST
/json-rpc/input/image
WebsocketHTTP/S
Set a single image. Supports all Qt image formats, including png/jpg/gif.
For best practices on using priorites, see Components & Priorities.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://localhost:8092/json-rpc/input/image' \
--header 'Content-Type: application/json' \
--data-raw '{
    "command": "image",
    "imagedata": "VGhpcyBpcyBubyBpbWFnZSEgOik=",
    "name": "Name of Image",
    "format": "auto",
    "priority": 50,
    "duration": 5000,
    "origin": "My Fancy App"
}'
Response Response Example
{
    "command": "image",
    "success": true,
    "tan": 139
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
command
enum<string> 
required
The type of command to execute.
Allowed value:
image
instance
array[integer]
optional
List of instance indices (0-254) to which the command applies. An empty array applies a command to all instances.
priority
integer 
required
The priority of this input (1-253). Lower values override higher ones.
>= 1<= 253
origin
string 
optional
Origin string (4-20 characters), e.g., the application name.
>= 4 characters<= 20 characters
duration
integer 
optional
Duration in milliseconds to keep this input. Use -1 for indefinite duration.
>= -1
Example:
-1
imagedata
string 
required
Base64-encoded image string.
imagewidth
integer 
optional
Width of the image in pixels.
>= 0
imageheight
integer 
optional
Height of the image in pixels.
>= 0
format
enum<string> 
optional
Image format, via "auto" the format will be evaluated
Allowed value:
auto
scale
integer 
optional
Resize percentage of the image (25–2000).
>= 25<= 2000
name
string 
optional
Optional name for the image input.
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
Previous
setEffect
Next
clear
Built with