Set Background

Modify the background image of a Stream Deck key or dial
Preview
Preview

Parameters

Button IDrequired
Text
  • If you give multiple buttons the same ID, all will be modified simultaneously
  • You can utilize %variables% here to dynamically modify certain buttons
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 used in addition to the image field, the image will be placed on top of the selected color.
State
Number
default:0
  • By default, all sub-actions will modify the first button state, 0
  • For example, to modify the 2nd state of an Action Switch, set State to 1

C# Usage

public void StreamDeckSetBackgroundColor(string buttonId, string color, int state)
public void StreamDeckSetBackgroundColor(string buttonId, string color)
public void StreamDeckSetBackgroundUrl(string buttonId, string imageUrl, string color, int state)
public void StreamDeckSetBackgroundUrl(string buttonId, string imageUrl, int state)
public void StreamDeckSetBackgroundUrl(string buttonId, string imageUrl, string color)
public void StreamDeckSetBackgroundUrl(string buttonId, string imageUrl)
public void StreamDeckSetBackgroundLocal(string buttonId, string imageFile, string color, int state)
public void StreamDeckSetBackgroundLocal(string buttonId, string imageFile, int state)
public void StreamDeckSetBackgroundLocal(string buttonId, string imageFile, string color)
public void StreamDeckSetBackgroundLocal(string buttonId, string imageFile)