streamdecksharp's Introduction

StreamDeckSharp

StreamDeckSharp is a simple (unofficial) .NET interface for the Stream Deck (https://www.elgato.com/de/gaming/stream-deck). This project is not related to Elgato Systems GmbH in any way.

Quickstart (TL;DR)

At the moment only Windows is supported (tested with 10, should also work with 7 and 8)

Add StreamDeckSharp reference (via nuget or download latest release)
Add a using directive for StreamDeckSharp: using StreamDeckSharp;

I want to...	Code (C#)
create a device reference	`var deck = StreamDeck.FromHID();`
set the brightness	`deck.SetBrightness(50);`
create bitmap for key	`var bitmap = StreamDeckKeyBitmap.FromFile("icon.png")`
set key image	`deck.SetKeyBitmap(keyId,bitmap)`
clear key image	`deck.ClearKey(keyId)`
process key events	`deck.KeyPressed += KeyHandler;`

Make sure to dispose the device reference correctly (use using whenever possible)

Examples

If you want to see some examples take a look at the example projects in the repo.
Here is a short example called "Austria". Copy the code and start hacking ;-)

using StreamDeckSharp;

namespace StreamDeckSharp.Examples.Austria
{
    class Program
    {
        static void Main(string[] args)
        {
            //Create some color we use later to draw the flag of austria
            var red = StreamDeckKeyBitmap.FromRGBColor(237, 41, 57);
            var white = StreamDeckKeyBitmap.FromRGBColor(255, 255, 255);
            var rowColors = new StreamDeckKeyBitmap[] { red, white, red };

            //Open the Stream Deck device
            using (var deck = StreamDeck.FromHID())
            {
                deck.SetBrightness(100);

                //Send the bitmap informaton to the device
                for (int i = 0; i < deck.NumberOfKeys; i++)
                    deck.SetKeyBitmap(i, rowColors[i / 5]);
            }
        }
    }
}