StreamDeck.Net 0.2.0

StreamDeck.NET

A .NET Core wrapper for the Elgato StreamDeck SDK

NOTE: This project is still in the early stages of development.

StreamDeck.Net provides an events based .NET Core wrapper around the Elgato Stream Deck

Table of Contents

• Sample Program
• Install
• Thanks

Sample program

Below shows how StreamDeck.NET can be used to create a simple counter action. It uses natemcmaster's excellent CommandLineUtils for parsing command line arguments.

namespace Counter
{
    public class Program
    {
        [Option(Description = "The port the Elgato StreamDeck software is listening on", ShortName = "port")]
        public string Port { get; set; }

        [Option(Description = "The Unique Identifier used to reference the plugin", ShortName = "pluginUUID")]
        public string PluginUuid { get; set; }

        [Option(Description = "Event type used to register the plugin", ShortName = "registerEvent")]
        public string RegisterEvent { get; set; }

        [Option(Description = "String of JSON containing appliaction and device information", ShortName = "info")]
        public string Info { get; set; }

        public static Task<int> Main(string[] args) => CommandLineApplication.ExecuteAsync<Program>(args);


        private async Task OnExecuteAsync()
        {
            var cancellationTokenSource = new CancellationTokenSource();
            var streamDeck = new StreamDeckClient(Port, PluginUuid, RegisterEvent, Info);
            streamDeck.KeyDownEventAsync += UpdateCounter;
            await streamDeck.RunAsync(cancellationTokenSource.Token);
        }

        private static int _counter;

        private static async Task UpdateCounter(StreamDeckClient client, StreamDeckEventPayload args)
        {
            _counter++;
            await client.SetTitle(args.Context, _counter.ToString());
        }
    }
}

Install

dotnet add package StreamDeck.Net

For ease of debuugging you can set your plugins local publish profiles to point to the StreamDeck softwares plugin folder. Then you can just re-run the software and attach to process to step through your code.

Thanks

A special thanks to Jeffrey T. Fritz (@csharpfritz) whose stream inspired this project. The code he implemented in StreamDeck_First was initially used as the base for this project before undergoing heavy refactoring.