Set Background
Modify the background image of a Stream Deck key or dial
Set Background Dialog
Explore the full Stream Deck Plugin Documentation
Parameters
ElgatoStreamDeckButtonId
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
https://api.iconify.design/mdi:alert.svg?color=%236312b5
data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxZW0iIGhlaWdodD0iMWVtIiB2aWV3Qm94PSIwIDAgMjQgMjQiPjxwYXRoIGQ9Ik0xMyAxNGgtMlY5aDJtMCA5aC0ydi0yaDJNMSAyMWgyMkwxMiAyTDEgMjF6IiBmaWxsPSIjNjMxMmI1Ii8+PC9zdmc+
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24"><path d="M13 14h-2V9h2m0 9h-2v-2h2M1 21h22L12 2L1 21z" fill="#6312b5"/></svg>
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.
ElgatoStreamDeckButtonState
C# Usage
public void StreamDeckSetBackgroundColor(string buttonId, string color)
CPH.StreamDeckSetBackgroundColor(buttonId, color);
public void StreamDeckSetBackgroundUrl(string buttonId, string imageUrl)
CPH.StreamDeckSetBackgroundUrl(buttonId, imageUrl);
public void StreamDeckSetBackgroundLocal(string buttonId, string imageFile)
CPH.StreamDeckSetBackgroundLocal(buttonId, imageFile);