Skip to main content

Understanding states

The plugin notifies the status and success/error of an action via key images color codes and feedback icons after pressing a key.

For actions that are associated with a particular on or off state (e.g. stream, record, currrent scene), the key image is colored to live show such state in every target OBS instance of the action. That is, if the target is a single OBS instance, the key image will either have a bright background color (on) or a dark one (off), in the same style as any other Stream Deck plugin action with states. Otherwise, if the target is multiple the key image will be vertically divided in sections corresponding to each OBS instance. These sections will follow the same color-code as before: bright for on state, dark for off state. This way it can be easily checked that all instances are in the expected states. There is a third color-code for the state, shown as a pattern of gray vertical lines, that indicates that the corresponding OBS instance is disconnected, or in some cases that the action settings are invalid.

Examples:

States

(1) Intro scene active in OBS#1 | (2) Intro scene inactive in OBS#1 | (3) Gaming scene active in both OBS#1 and OBS#2 | (4) Gaming scene active in OBS#1 but inactive in OBS#2 | (5) Gaming scene active in OBS#1, and OBS#2 disconnected | (6) OBS#1 disconnected

For actions without states (e.g. trigger hotkey, raw/raw batch requests), the key image isn't updated. However, after successfully triggering an action by pressing the key, a checkmark icon overlay will be shown.

For all actions, if the action fails or success only partially, an alert triangle will be shown after pressing the key. Take into account that such alert will appear if:

  • The action is sent to a single OBS instance and it fails.
  • The action is sent to multiple OBS instances but the WS server of one of them is not connected/reachable. The action may have succeeded in other instances.
  • The action is sent to multiple OBS instances but failed in one of them. The action may have succeeded in other instances.

If you want to use a custom image and retain full state information, please use the advanced option for this inside actions configuration. Otherwise if you decide to substitute the default action images using the native UI, be aware that the action will only be set to on when it is on in every target instance of the action. That means that if for some reason one of the targets is disconnected, or the state in it is off, the internal Stream Deck state will be off and so will be your custom image choice.