Set Background

Modify the background image of a Stream Deck key or dial

Set Background Dialog
Set Background Dialog

Parameters

Button ID
Text

The ID of the Stream Deck button or dial to modify.

If you give multiple buttons the same ID, all will be modified simultaneously
You can utilize %variable% syntax to dynamically modify buttons with argument values
Image
Text

Image path or data used to update the background image of a Stream Deck button

Supports any of the formats shown below:

C:\Users\John\Pictures\image.png
Color
Text

Set the background color of the given button.

When color is configured in addition to the image field, the image will be placed on top of the selected background color.
State
Number
Default:
0

Optionally select a specific button state to modify

For example, to modify the 2nd state of an Action Switch, set State to 1

C# Usage

public void StreamDeckSetBackgroundColor(string buttonId, string color)
Read more in API > C# > Methods > Elgato > Stream Deck > Set Background Color
public void StreamDeckSetBackgroundLocal(string buttonId, string imageFile)
Read more in API > C# > Methods > Elgato > Stream Deck > Set Background Local
public void StreamDeckSetBackgroundUrl(string buttonId, string imageUrl)
Read more in API > C# > Methods > Elgato > Stream Deck > Set Background Url