Keys

Action

The Action button allows you to assign Streamer.bot actions to your Stream Deck keys.

Configuration

Button ID

• The auto-generated ID for this button.
• Used for targeting this button in Streamer.bot sub-actions

Background

• Change the background color and/or image for this button.
• This field can be overridden by the Set Background sub-action.

Instance

• Select the Streamer.bot instance to connect this button to.

Interaction

• Select the Stream Deck interaction type to connect to a Streamer.bot action
  • Key-Down: Execute an action immediately when the key is pressed
  • Key-Down (Long Press): Execute an action when the key is held for ~800ms
  • Key-Up: Execute an action when the key is released

Action

• Select the Streamer.bot action to execute for the selected Interaction

Arguments

• The following arguments will be automatically sent to your Streamer.bot action:
  • %sdButtonId%: The ID of the button which executed the action
• Add any additional custom arguments to pass to your Streamer.bot action

Action Switch

The Action Switch allows you to easily create a toggle switch hooked up to Streamer.bot actions.

A separate action, with customizable arguments, can be assigned to each state change, Toggle On or Toggle Off.

By utilizing the internal Stream Deck state system, you can easily customize your button's visual appearance for each state.

Configuration

Button ID

• The auto-generated ID for this button.
• Used for targeting this button in Streamer.bot sub-actions

Background

• Change the background color and/or image for this button.
• This field can be overridden by the Set Background sub-action.

Instance

• Select the Streamer.bot instance to connect this button to.

Toggle On/Off

• Toggle On: Execute an action when this key is moved into the On state
• Toggle Off: Execute an action when this key is moved into the Off state

Action

• Select the Streamer.bot action to execute for the selected toggle state.

Arguments

• The following arguments will be automatically sent to your Streamer.bot action:
  • %sdButtonId%: The ID of the button which executed the action
  • %state%: The new state being toggled. 0 or 1
• Add any additional custom arguments to pass to your Streamer.bot action

Status Indicator

The Status Indicator button allows you to display realtime data on your Stream Deck keys, updated from your Streamer.bot instance.

To update the value, you can use the Set Value sub-action available in Streamer.bot.

Configuration

Button ID

• The auto-generated ID for this button.
• Used for targeting this button in Streamer.bot sub-actions

Background

• Change the background color and/or image for this button.
• This field can be overridden by the Set Background sub-action.

Instance

• Select the Streamer.bot instance to connect this button to.

Interaction

• Select the Stream Deck interaction type to connect to a Streamer.bot action
  • Key-Down: Execute an action immediately when the key is pressed
  • Key-Down (Long Press): Execute an action when the key is held for ~800ms
  • Key-Up: Execute an action when the key is released

Action

• Select the Streamer.bot action to execute for the selected Interaction

Arguments

• The following arguments will be automatically sent to your Streamer.bot action:
  • %sdButtonId%: The ID of the button which executed the action
  • %value%: The current value of the Status indicator
• Add any additional custom arguments to pass to your Streamer.bot action

Indicator Settings

Type

• Select the layout / display type for this indicator button.
  • Sparkline Chart: Generate a sparkline chart from historical values
  • Value: Display numeric values, supporting custom backgrounds.
  • Text: Display any value as text, supporting custom backgrounds.

Current Value

• The current value of the Status Indicator
• Can be modified with the Set Value sub-action
• Numeric values will be parsed & formatted according to your Number Locale option in Global Settings

Chart Steps

• The number of historical values to use when generating sparkline charts

Text Color

• The color of the value text displayed on the indicator