Skip to content

Latest commit

 

History

History
260 lines (185 loc) · 8.83 KB

CHANGELOG.md

File metadata and controls

260 lines (185 loc) · 8.83 KB
Raw

Change Log

vNext

🚨 Breaking

  • Property inspector methods have been simplified.
    • PropertyInspectorMethodAttribute now supports a single eventName.
    • Parameters are now sent via the payload.parameters object.
    • Parameters are more intrinsic, see example below.
  • IHostedLifetime is now used for plugin lifetime management.
    • Consider changing any IHostLifetime to IHostedService or BackgroundService.
  • Removed IServiceCollection.AddStreamDeck in favour of IHostBuilder.RunStreamDeckPlugin and IHostBuilder.RunStreamDeckPluginAsync.

⭐ Added

  • Support for easily running plugins via a IHostBuilder.
    • IHostBuilder.RunStreamDeckPlugin().
    • IHostBuilder.RunStreamDeckPluginAsync(CancellationToken).

♻ Changed

  • The static helper class StreamDeckPlugin now uses Microsoft.Extensions.Hosting.HostBuilder.

🐞 Fixed

  • Connecting to the Stream Deck no longer blocks other registered IHostedService.
  • SetSettingsAsync(object, CancellationToken) correctly persists the __sharpDeckUUID property (hopefully one day Elgato adds better lifetime management, but until then, we do our best!) 🤞

📝 Property Inspector Example

Stream Deck actions can expose methods that are accessible from the property inspector. With the following method in our action...

[PropertyInspectorMethod("customLog")]
public void LogMessage(string message, int times)
    => ...

we can invoke the method from the property inspector by calling sendToPlugin with the payload:

{
    "event": "customLog",
    "parameters": {
        "customLog": "Hello world",
        "times": 13
    }
}

6.0.1

♻ Changed

  • Updated third-party library dependencies.

6.0.0

🚨 Breaking

  • Majority of StreamDeckPlugin deprecated in favour of host builders.
    • Provides basic run functionality; Run() or Run(CancellationToken).
  • StreamDeckAction.
    • Removed property EnablePropertyInspectorMethods; always considered true.
  • Removed InvalidStreamDeckActionTypeException in favour of NotSupportedException.
  • Moved IStreamDeckConnection to SharpDeck.Connectivity namespace.

⭐ Added

  • Added support for host builders via UseStreamDeck(Action<PluginContext> configurePlugin).
    • Namespace SharpDeck.Extensions.Hosting.
    • Example usage;
    new HostBuilder()
    .ConfigureServices(services =>
    {
        services.AddSingleton<MyService>();
    })
    .UseStreamDeck(pluginContext =>
    {
        /*
         * PluginContext allows access to the action registry, connection, and registration parameters.
         * e.g. the following can be used to register actions outside of the entry assembly.
         */
        pluginContext.Actions.AddAssembly(typeof(MyPlugin).Assembly);
    })
    .Start();
  • Added support for IServiceCollection registration via AddStreamDeckPlugin(Action<IStreamDeckPlugin>).
    • Namespace SharpDeck.Extensions.DependencyInjection.
  • Added support for long key presses.
    • Configurable via StreamDeckAction.LongKeyPressInterval
      • Default 500ms.
      • Disabled when TimeSpan.Zero.
  • StreamDeckAction.OnKeyPress(ActionEventArgs<KeyPayload>) invoked on:
    • Short-press.
    • -or- when key disappears (if not long-press).
  • StreamDeckAction.OnKeyLongPress(ActionEventArgs<KeyPayload>) invoked on:
    • Long-press.
  • Added logging support to all property inspector method invocations.
  • Added Stream Deck alert for actions when an exception is thrown whilst invoking a property inspector method.

♻ Changed

  • Removed manifest generation.
  • Removed McMaster.Extensions.CommandLineUtils dependency.
  • Updated third-party library dependencies.

🐞 Fixed

  • profile is now optional when calling IStreamDeckConnection.SwitchToProfileAsync.
  • Fixed missing payload information for deviceDidConnect.
  • Fixed missing payload information for titleParametersDidChange.

5.0.2

⭐ Added

  • New IStreamDeckConnection.GetGlobalSettingsAsync<T>() now returns the global settings!
  • New StreamDeckPlugin.OnRegistered(Func<IStreamDeckConnection>) delegate; called after the plugin is registered.
  • New StreamDeckPlugin.Run() method; used when using StreamDeckPlugin.Create.
  • StreamDeckActionAttribute now has a simplified constructor that accepts UUID.
  • Support for SDK 4.8
    • Added state parameter to setImage.
    • Added state parameter to setTitle.
  • Support for SDK 4.7
    • Added kESDSDKDeviceType_CorsairGKeys device type.
  • All new sample plugins.

5.0.1

🐞 Fixed

  • Fixed an issue with StreamDeckClient.Run() not blocking the main thread.

5.0.0

🚨 Breaking

  • Removed StreamDeckClient; replaced with IStreamDeckConnection.
  • Updated StreamDeckAction.StreamDeck to be IStreamDeckConnection.

⭐ Added

  • Greatly simplfied starting a plugin.
    • StreamDeckPlugin.Run()
    • StreamDeckPlugin.RunAsync()
  • Added basic unit tests.
  • Added GitHub workflows.
  • Added StreamDeckAction.OnInit virtual.

♻ Changed

  • Actions with StreamDeckAttribute are automatically registered.
  • Complete re-write of action caching.
  • Complete re-write of event routing.

🐞 Fixed

  • Fixed an issue with incorrect actions being invoked.

4.0.1/2

♻ Changed

  • Updated deployment to NuGet.

4.0.0

🚨 Breaking

  • Removed StreamDeckAction.Initialized event, please use StreamDeckAction.WillAppear
  • Removed StreamDeckAction<TSettings>.Settings to prevent misuse.

⭐ Added

  • Added automatic manifest generation!
  • Added support for initializing actions with their AppearancePayload.
  • Added action context when raising StreamDeckClient.Error (where possible).
  • Added support for FontFamilyType and FontStyleType.
  • Improved deadlock prevention for all WebSocket requests.

🐞 Fixed

  • Fixed DeviceType, PlatformType, and TitleAlignmentType.

3.0.0

🚨 Breaking

  • Relocated to SharpDeck.Events.StreamDeckAction to top level SharpDeck.StreamDeckAction.
  • Re-aligned namespaces of events (received) / messages (sent) to match Elgato SDK terminology.

⭐ Added

🐞 Fixed

  • Fixed JSON serialization casing inconsistencies when using JObject (specifically action settings).
  • Fixed openUrl event.

2.0.0

⭐ Added

  • PropertyInspectorMethodAttribute decorator for interacting with Property Inspector.
  • Added unit testing, including AppVeyor integration.

♻ Changed

  • Updated StreamDeckAction overrides to require a task.
  • Streamlined publishing to NuGet with npm package scripts.

🐞 Fixed

  • Fixed potential async/await issue within StreamDeckClient.

1.0.3

♻ Changed

  • Removed unnecessary parameters when calling SendToPropertyInspectorAsync.

🐞 Fixed

  • Fixed an issue with sendToPlugin event not triggering.

1.0.2

⭐ Added

  • Added missing event: sendToPlugin.

♻ Changded

  • StreamDeckClient.RegisterAction now supports a value factory.
  • Centralised all event related models to the SharpDeck.Events namespace.
  • Improved dependency injection capabilities.

1.0.1

⭐ Added