Hyperion
    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
          • setEffect
          • setImage
          • clear
          • clearAll
          • selectSource
        • Output Controls
          • adjustColors
          • setLedMapping
          • setVideomode
        • Subscription Controls
          • liveImageStream
          • liveLedColorStream
        • Operational Controls
          • setComponentState
          • setInstanceState
          • switchInstance
          • setSystemState
          • setSubscriptions
      • Configuration
        • createInstance
        • deleteInstance
        • renameInstance
        • getConfiguration
        • updateConfiguration
        • restoreConfiguration
        • getSchemas

    Components & Priorities

    Components/IDs explained#

    Each component has a unique id. Not all of them can be enabled/disabled -- some of them, such as effect and color, are used to determine the source type when examining the priority list.
    ComponentIDComponentEnable/DisableComment
    ALLHyperionYesEnable or disable all components. Recovers/saves last state of all other components
    SMOOTHINGSmoothingYesSmoothing component
    BLACKBORDERBlackborder detectorYesBlack bar detection component
    FORWARDERJSON & Flat-/Protcol buffers forwarderYesJSON/Proto forwarder component
    BOBLIGHTSERVERBoblight serverYesBoblight server component
    GRABBERPlatform captureYesPlatform Capture component
    V4LUSB capture deviceYesUSB capture device component
    LEDDEVICELed deviceYesLed device component start/stops output of the configured led device
    COLORSolid colorNoAll colors that has been set belongs to this component
    EFFECTEffectNoAll effects belongs to this component
    IMAGESolid ImageNoAll single/solid images belongs to this. NOT for streaming
    FLATBUFSERVERFlatbuffers ServerNoAll image stream sources from flatbuffer server
    PROTOSERVERProtobuffer ServerNoAll image stream sources from Protobuffer server

    Priority Guidelines#

    Please adhere to the following priority guidelines to avoid user confusion and ensure
    the best user experience possible:
    The user expects that an effect or color should be higher in priority (lower in value)
    than capturing, as colors/effects are usually run intermittently.
    TypePriority/RangeRecommendedComment
    Boot Effect/Color0-Blocked
    Web Configuration1-
    Remote/API Control2-9950Set effect/color/single image
    Image Streaming100-199150For image streams (Flatbuffer/Protobuffer)
    Boblight201-
    USB Capture240-
    Platform Capture250-
    Background Effect/Color254-
    Reserved255-
    Previous
    Connect to Hyperion
    Next
    API Authentication - Introduction
    Built with