Guide

Sub-Actions

The following sub-actions are available in Streamer.bot for interacting directly with Stream Deck.

Set Title

Set the title of a Stream Deck button.

This sub-action will not work correctly if you have manually set the title in the Stream Deck software.

Button ID

  • Type: String
  • Description: The ID of the button to modify. Accepts variables.

Title

  • Type: String
  • Description: Assign the given value as the new title of the button. Accepts variables.
C# Methods
// Set Title C# Methods
void StreamDeckSetTitle(string buttonId, string title);
void StreamDeckSetTitle(string buttonId, string title, int state);

Set Background

Set the background image of a Stream Deck button.

This sub-action will not work correctly if you have manually set the icon in the Stream Deck software.

Button ID

  • Type: String
  • Description: The ID of the button to modify. Accepts variables.

Image

  • Type: String
  • Description: Supports any of the formats shown below
C:\Users\John\Pictures\image.png

Color

  • Type: String
  • Description: Set the background color of the given button. When used in addition to the image field, the image will be placed on top of the chosen background color.

State

  • Type: Number
  • Default: 0
  • Description: (Optional) Change the background on a specific button state
C# Methods
// Set Background C# Methods
void StreamDeckSetBackgroundColor(string buttonId, string color);
void StreamDeckSetBackgroundColor(string buttonId, string color, int state);
void StreamDeckSetBackgroundUrl(string buttonId, string imageUrl);
void StreamDeckSetBackgroundUrl(string buttonId, string imageUrl, string color);
void StreamDeckSetBackgroundUrl(string buttonId, string imageUrl, int state);
void StreamDeckSetBackgroundUrl(string buttonId, string imageUrl, string color, int state);
void StreamDeckSetBackgroundLocal(string buttonId, string imageFile);
void StreamDeckSetBackgroundLocal(string buttonId, string imageFile, string color);
void StreamDeckSetBackgroundLocal(string buttonId, string imageFile, int state);
void StreamDeckSetBackgroundLocal(string buttonId, string imageFile, string color, int state);

Set State

Set the current state of a Stream Deck button with multiple states.

For example, the Action Switch can be set to 0 or 1.

Button ID

  • Type: String
  • Description: The ID of the button to modify. Accepts variables.

State

  • Type: Number
  • Default: 0
  • Description: Zero-indexed number of the button state to switch to.
C# Methods
// Set State C# Methods
void StreamDeckSetState(string buttonId, int state);

Toggle State

Toggle the state of a Stream Deck button between 0 and 1. Useful for the Action Switch key.

Button ID

  • Type: String
  • Description: The ID of the button to modify. Accepts variables.
C# Methods
// Toggle State C# Methods
void StreamDeckToggleState(string buttonId);

Set Value

Set the current value of a Status Indicator button, or a Stream Deck + indicator.

Button ID

  • Type: String
  • Description: The ID of the button to modify

Value

  • Type: Number | String
  • Description: The new value for your selected indicator. Accepts variables.
Most indicators will only accept numeric values, one exception being the Text type supported by the Status Indicator button.
C# Methods
// Set Value C# Method
void StreamDeckSetValue(string buttonId, string value);

Special Values

  • Reset Sparkline: You can reset a Sparkline chart by sending an empty value
  • Increment: You can increment a numeric value by passing +=[value], e.g. +=1
  • Decrement: You can decrement a numeric value by passing -=[value], e.g. -=1
  • Multiply: You can multiply a numeric value by passing *=[value], e.g. *=1
  • Divide: You can divide a numeric value by passing /=[value], e.g. /=1

Show OK

Show a temporary OK icon/status on a Stream Deck button or indicator.

Button ID

  • Type: String
  • Description: The ID of the button to show the notification on. Accepts variables.
C# Methods
// Show OK C# Method
void StreamDeckShowOk(string buttonId);

Show Alert

Show a temporary Alert icon/status on a Stream Deck button or indicator.

Button ID

  • Type: String
  • Description: The ID of the button to show the notification on. Accepts variables.
C# Methods
// Show Alert C# Method
void StreamDeckShowAlert(string buttonId);

Dials

Overview of all dials / indicators available for Streamer.bot on your Elgato Stream Deck +

Live Viewers Chart

Transform a Stream Deck button into a realtime viewer count display with the Streamer.bot Status Indicator!