feat(codegen): refresh protocol from OBS WebSocket master

Regenerates all source files against the latest protocol.json, which
adds Canvas lifecycle events (CanvasCreated, CanvasNameChanged,
CanvasRemoved), a GetCanvasList response type, and optional canvasUuid
filtering on scene-scoped requests. Updates ObsWebSocketClient.Helper
to pass the new required GetSceneListRequestData argument.

Author: Agash

ObsWebSocket.Core/Generated/Client/ObsWebSocketClient.Events.g.cs

@@ -13,6 +13,60 @@ namespace ObsWebSocket.Core;
 public sealed partial class ObsWebSocketClient
 {
 
+    /// <summary>
+    /// Occurs when the <c>CanvasCreated</c> event is received from the OBS WebSocket server.
+    /// </summary>
+    /// <remarks>
+    ///  A new canvas has been created.
+    /// <para>Requires the <c>Canvases</c> subscription.</para>
+    /// <para>Category: canvases | Complexity: 2</para>
+    /// <para>RPC Version: 1 | Initial Version: 5.7.0</para>
+    /// </remarks>
+    public event EventHandler<ObsWebSocket.Core.Events.Generated.CanvasCreatedEventArgs>? CanvasCreated;
+
+    /// <summary>Invokes the <see cref="CanvasCreated"/> event handler safely.</summary>
+    /// <param name="e">The <see cref="ObsWebSocket.Core.Events.Generated.CanvasCreatedEventArgs"/> containing event data.</param>
+    private void OnCanvasCreated(ObsWebSocket.Core.Events.Generated.CanvasCreatedEventArgs e)
+    {
+        CanvasCreated?.Invoke(this, e);
+    }
+
+    /// <summary>
+    /// Occurs when the <c>CanvasRemoved</c> event is received from the OBS WebSocket server.
+    /// </summary>
+    /// <remarks>
+    ///  A canvas has been removed.
+    /// <para>Requires the <c>Canvases</c> subscription.</para>
+    /// <para>Category: canvases | Complexity: 2</para>
+    /// <para>RPC Version: 1 | Initial Version: 5.7.0</para>
+    /// </remarks>
+    public event EventHandler<ObsWebSocket.Core.Events.Generated.CanvasRemovedEventArgs>? CanvasRemoved;
+
+    /// <summary>Invokes the <see cref="CanvasRemoved"/> event handler safely.</summary>
+    /// <param name="e">The <see cref="ObsWebSocket.Core.Events.Generated.CanvasRemovedEventArgs"/> containing event data.</param>
+    private void OnCanvasRemoved(ObsWebSocket.Core.Events.Generated.CanvasRemovedEventArgs e)
+    {
+        CanvasRemoved?.Invoke(this, e);
+    }
+
+    /// <summary>
+    /// Occurs when the <c>CanvasNameChanged</c> event is received from the OBS WebSocket server.
+    /// </summary>
+    /// <remarks>
+    ///  The name of a canvas has changed.
+    /// <para>Requires the <c>Canvases</c> subscription.</para>
+    /// <para>Category: canvases | Complexity: 2</para>
+    /// <para>RPC Version: 1 | Initial Version: 5.7.0</para>
+    /// </remarks>
+    public event EventHandler<ObsWebSocket.Core.Events.Generated.CanvasNameChangedEventArgs>? CanvasNameChanged;
+
+    /// <summary>Invokes the <see cref="CanvasNameChanged"/> event handler safely.</summary>
+    /// <param name="e">The <see cref="ObsWebSocket.Core.Events.Generated.CanvasNameChangedEventArgs"/> containing event data.</param>
+    private void OnCanvasNameChanged(ObsWebSocket.Core.Events.Generated.CanvasNameChangedEventArgs e)
+    {
+        CanvasNameChanged?.Invoke(this, e);
+    }
+
     /// <summary>
     /// Occurs when the <c>CurrentSceneCollectionChanging</c> event is received from the OBS WebSocket server.
     /// </summary>

ObsWebSocket.Core/Generated/Client/ObsWebSocketClient.Extensions.g.cs

@@ -19,6 +19,25 @@ namespace ObsWebSocket.Core;
 /// </summary>
 public static partial class ObsWebSocketClientExtensions
 {
+    /// <summary>
+    /// Gets an array of canvases in OBS.
+    /// </summary>
+    /// <param name="client">The <see cref="ObsWebSocketClient"/> instance.</param>
+    /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
+    /// <returns>A task representing the asynchronous operation. Yields the <see cref="ObsWebSocket.Core.Protocol.Responses.GetCanvasListResponseData"/> response data, or <c>null</c> if the successful response does not contain data.</returns>
+    /// <remarks>
+    /// <para>OBS WebSocket Protocol Category: canvases</para>
+    /// <para>Complexity Rating: 3/5</para>
+    /// <para>RPC Version: 1 | Initial OBS WebSocket Version: 5.7.0</para>
+    /// Generated from obs-websocket protocol definition.</remarks>
+    /// <exception cref="ObsWebSocketException">Thrown if the request fails on the OBS side.</exception>
+    /// <exception cref="InvalidOperationException">Thrown if the client is not connected.</exception>
+    /// <exception cref="OperationCanceledException">Thrown if cancelled.</exception>
+    public static async Task<ObsWebSocket.Core.Protocol.Responses.GetCanvasListResponseData?> GetCanvasListAsync(this ObsWebSocketClient client, CancellationToken cancellationToken = default)
+    {
+        return await client.CallAsync<ObsWebSocket.Core.Protocol.Responses.GetCanvasListResponseData>("GetCanvasList", null, cancellationToken: cancellationToken).ConfigureAwait(false);
+    }
+
     /// <summary>
     /// Gets the value of a &quot;slot&quot; from the selected persistent data realm.
     /// </summary>
@@ -2318,9 +2337,10 @@ public static async Task SetSceneItemBlendModeAsync(this ObsWebSocketClient clie
     }
 
     /// <summary>
-    /// Gets an array of all scenes in OBS.
+    /// Gets an array of scenes in OBS.
     /// </summary>
     /// <param name="client">The <see cref="ObsWebSocketClient"/> instance.</param>
+    /// <param name="requestData">The data required for the request (<see cref="ObsWebSocket.Core.Protocol.Requests.GetSceneListRequestData"/>).</param>
     /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
     /// <returns>A task representing the asynchronous operation. Yields the <see cref="ObsWebSocket.Core.Protocol.Responses.GetSceneListResponseData"/> response data, or <c>null</c> if the successful response does not contain data.</returns>
     /// <remarks>
@@ -2331,9 +2351,9 @@ public static async Task SetSceneItemBlendModeAsync(this ObsWebSocketClient clie
     /// <exception cref="ObsWebSocketException">Thrown if the request fails on the OBS side.</exception>
     /// <exception cref="InvalidOperationException">Thrown if the client is not connected.</exception>
     /// <exception cref="OperationCanceledException">Thrown if cancelled.</exception>
-    public static async Task<ObsWebSocket.Core.Protocol.Responses.GetSceneListResponseData?> GetSceneListAsync(this ObsWebSocketClient client, CancellationToken cancellationToken = default)
+    public static async Task<ObsWebSocket.Core.Protocol.Responses.GetSceneListResponseData?> GetSceneListAsync(this ObsWebSocketClient client, ObsWebSocket.Core.Protocol.Requests.GetSceneListRequestData requestData, CancellationToken cancellationToken = default)
     {
-        return await client.CallAsync<ObsWebSocket.Core.Protocol.Responses.GetSceneListResponseData>("GetSceneList", null, cancellationToken: cancellationToken).ConfigureAwait(false);
+        return await client.CallAsync<ObsWebSocket.Core.Protocol.Responses.GetSceneListResponseData>("GetSceneList", requestData, cancellationToken: cancellationToken).ConfigureAwait(false);
     }
 
     /// <summary>
@@ -2360,7 +2380,9 @@ public static async Task SetSceneItemBlendModeAsync(this ObsWebSocketClient clie
     /// <summary>
     /// Gets the current program scene.
     /// 
-    /// Note: This request is slated to have the `currentProgram`-prefixed fields removed from in an upcoming RPC version.
+    /// Note 1: This request is slated to have the `currentProgram`-prefixed fields removed from in an upcoming RPC version.
+    /// 
+    /// Note 2: Canvases do not have any concept of a program or preview scene, so this request does not support canvases.
     /// </summary>
     /// <param name="client">The <see cref="ObsWebSocketClient"/> instance.</param>
     /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>

ObsWebSocket.Core/Generated/Client/ObsWebSocketClient.WaitForEvent.g.cs

@@ -62,6 +62,69 @@ public static partial class ObsWebSocketClientHelpers
             // This switch is generated based on known events with data from protocol.json
             switch (typeof(TEventArgs))
             {
+                case Type t when t == typeof(ObsWebSocket.Core.Events.Generated.CanvasCreatedEventArgs):
+                {
+                    EventHandler<ObsWebSocket.Core.Events.Generated.CanvasCreatedEventArgs> specificHandler = (sender, e) =>
+                    {
+                        try
+                        {
+                            if (predicate((TEventArgs)(object)e))
+                            {
+                                tcs.TrySetResult((TEventArgs?)(object?)e);
+                            }
+                        }
+                        catch (Exception ex)
+                        {
+                            // Catch exceptions from user predicate and fail the task
+                            tcs.TrySetException(ex);
+                        }
+                    };
+                    client.CanvasCreated += specificHandler;
+                    unsubscribeAction = () => client.CanvasCreated -= specificHandler;
+                    break;
+                }
+                case Type t when t == typeof(ObsWebSocket.Core.Events.Generated.CanvasRemovedEventArgs):
+                {
+                    EventHandler<ObsWebSocket.Core.Events.Generated.CanvasRemovedEventArgs> specificHandler = (sender, e) =>
+                    {
+                        try
+                        {
+                            if (predicate((TEventArgs)(object)e))
+                            {
+                                tcs.TrySetResult((TEventArgs?)(object?)e);
+                            }
+                        }
+                        catch (Exception ex)
+                        {
+                            // Catch exceptions from user predicate and fail the task
+                            tcs.TrySetException(ex);
+                        }
+                    };
+                    client.CanvasRemoved += specificHandler;
+                    unsubscribeAction = () => client.CanvasRemoved -= specificHandler;
+                    break;
+                }
+                case Type t when t == typeof(ObsWebSocket.Core.Events.Generated.CanvasNameChangedEventArgs):
+                {
+                    EventHandler<ObsWebSocket.Core.Events.Generated.CanvasNameChangedEventArgs> specificHandler = (sender, e) =>
+                    {
+                        try
+                        {
+                            if (predicate((TEventArgs)(object)e))
+                            {
+                                tcs.TrySetResult((TEventArgs?)(object?)e);
+                            }
+                        }
+                        catch (Exception ex)
+                        {
+                            // Catch exceptions from user predicate and fail the task
+                            tcs.TrySetException(ex);
+                        }
+                    };
+                    client.CanvasNameChanged += specificHandler;
+                    unsubscribeAction = () => client.CanvasNameChanged -= specificHandler;
+                    break;
+                }
                 case Type t when t == typeof(ObsWebSocket.Core.Events.Generated.CurrentSceneCollectionChangingEventArgs):
                 {
                     EventHandler<ObsWebSocket.Core.Events.Generated.CurrentSceneCollectionChangingEventArgs> specificHandler = (sender, e) =>

ObsWebSocket.Core/Generated/Events/Generated/CanvasCreatedEventArgs.g.cs

@@ -0,0 +1,20 @@
+// <auto-generated/>
+#nullable enable
+
+using ObsWebSocket.Core.Protocol.Events;
+using ObsWebSocket.Core.Events;
+
+namespace ObsWebSocket.Core.Events.Generated;
+
+/// <summary>
+/// Provides event data for the &lt;c&gt;CanvasCreated&lt;/c&gt; event.
+/// </summary>
+/// <remarks>
+///  A new canvas has been created.
+/// <para>Requires Subscription: Canvases | Complexity: 2</para>
+/// <para>RPC Version: 1 | Initial Version: 5.7.0</para>
+/// Generated from obs-websocket protocol definition.</remarks>
+/// <param name="payload">The strongly-typed data payload (<see cref="CanvasCreatedPayload"/>) for this event.</param>
+public sealed partial class CanvasCreatedEventArgs(CanvasCreatedPayload payload) : ObsEventEventArgs<ObsWebSocket.Core.Protocol.Events.CanvasCreatedPayload>(payload)
+{
+}

ObsWebSocket.Core/Generated/Events/Generated/CanvasNameChangedEventArgs.g.cs

@@ -0,0 +1,20 @@
+// <auto-generated/>
+#nullable enable
+
+using ObsWebSocket.Core.Protocol.Events;
+using ObsWebSocket.Core.Events;
+
+namespace ObsWebSocket.Core.Events.Generated;
+
+/// <summary>
+/// Provides event data for the &lt;c&gt;CanvasNameChanged&lt;/c&gt; event.
+/// </summary>
+/// <remarks>
+///  The name of a canvas has changed.
+/// <para>Requires Subscription: Canvases | Complexity: 2</para>
+/// <para>RPC Version: 1 | Initial Version: 5.7.0</para>
+/// Generated from obs-websocket protocol definition.</remarks>
+/// <param name="payload">The strongly-typed data payload (<see cref="CanvasNameChangedPayload"/>) for this event.</param>
+public sealed partial class CanvasNameChangedEventArgs(CanvasNameChangedPayload payload) : ObsEventEventArgs<ObsWebSocket.Core.Protocol.Events.CanvasNameChangedPayload>(payload)
+{
+}

ObsWebSocket.Core/Generated/Events/Generated/CanvasRemovedEventArgs.g.cs

@@ -0,0 +1,20 @@
+// <auto-generated/>
+#nullable enable
+
+using ObsWebSocket.Core.Protocol.Events;
+using ObsWebSocket.Core.Events;
+
+namespace ObsWebSocket.Core.Events.Generated;
+
+/// <summary>
+/// Provides event data for the &lt;c&gt;CanvasRemoved&lt;/c&gt; event.
+/// </summary>
+/// <remarks>
+///  A canvas has been removed.
+/// <para>Requires Subscription: Canvases | Complexity: 2</para>
+/// <para>RPC Version: 1 | Initial Version: 5.7.0</para>
+/// Generated from obs-websocket protocol definition.</remarks>
+/// <param name="payload">The strongly-typed data payload (<see cref="CanvasRemovedPayload"/>) for this event.</param>
+public sealed partial class CanvasRemovedEventArgs(CanvasRemovedPayload payload) : ObsEventEventArgs<ObsWebSocket.Core.Protocol.Events.CanvasRemovedPayload>(payload)
+{
+}

ObsWebSocket.Core/Generated/Protocol/Events/CanvasCreated.EventPayload.g.cs

@@ -0,0 +1,57 @@
+// <auto-generated/>
+#nullable enable
+
+using System;
+using System.Collections.Generic;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using System.Diagnostics.CodeAnalysis;
+using MessagePack;
+using ObsWebSocket.Core.Protocol.Common;
+using ObsWebSocket.Core.Protocol.Common.NestedTypes;
+
+namespace ObsWebSocket.Core.Protocol.Events;
+
+/// <summary>
+/// Data payload for the CanvasCreated event.
+/// </summary>
+/// <remarks>
+///  A new canvas has been created.
+/// <para>Requires Subscription: Canvases | Complexity: 2</para>
+/// <para>RPC Version: 1 | Initial Version: 5.7.0</para>
+/// Generated from obs-websocket protocol definition.</remarks>
+#pragma warning disable CS8618
+[MessagePackObject]
+public sealed partial record CanvasCreatedPayload
+{
+    /// <summary>
+    /// Name of the new canvas
+    /// </summary>
+    [JsonPropertyName("canvasName")]
+    [Key("canvasName")]
+    public string? CanvasName { get; init; }
+
+    /// <summary>
+    /// UUID of the new canvas
+    /// </summary>
+    [JsonPropertyName("canvasUuid")]
+    [Key("canvasUuid")]
+    public string? CanvasUuid { get; init; }
+
+    /// <summary>Initializes a new instance for deserialization via <see cref="JsonConstructorAttribute"/>.</summary>
+    [JsonConstructor]
+    public CanvasCreatedPayload() { }
+
+    /// <summary>
+    /// Initializes a new instance with all properties specified.
+    /// <para>Parameters are ordered with required properties first, then optional properties (with defaults). Follows protocol definition order where possible.</para>
+    /// </summary>
+    public CanvasCreatedPayload(string? canvasName = null, string? canvasUuid = null)
+    {
+        this.CanvasName = canvasName;
+        this.CanvasUuid = canvasUuid;
+    }
+
+}
+#pragma warning restore CS8618
+

ObsWebSocket.Core/Generated/Protocol/Events/CanvasNameChanged.EventPayload.g.cs

@@ -0,0 +1,65 @@
+// <auto-generated/>
+#nullable enable
+
+using System;
+using System.Collections.Generic;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using System.Diagnostics.CodeAnalysis;
+using MessagePack;
+using ObsWebSocket.Core.Protocol.Common;
+using ObsWebSocket.Core.Protocol.Common.NestedTypes;
+
+namespace ObsWebSocket.Core.Protocol.Events;
+
+/// <summary>
+/// Data payload for the CanvasNameChanged event.
+/// </summary>
+/// <remarks>
+///  The name of a canvas has changed.
+/// <para>Requires Subscription: Canvases | Complexity: 2</para>
+/// <para>RPC Version: 1 | Initial Version: 5.7.0</para>
+/// Generated from obs-websocket protocol definition.</remarks>
+#pragma warning disable CS8618
+[MessagePackObject]
+public sealed partial record CanvasNameChangedPayload
+{
+    /// <summary>
+    /// New name of the canvas
+    /// </summary>
+    [JsonPropertyName("canvasName")]
+    [Key("canvasName")]
+    public string? CanvasName { get; init; }
+
+    /// <summary>
+    /// UUID of the canvas
+    /// </summary>
+    [JsonPropertyName("canvasUuid")]
+    [Key("canvasUuid")]
+    public string? CanvasUuid { get; init; }
+
+    /// <summary>
+    /// Old name of the canvas
+    /// </summary>
+    [JsonPropertyName("oldCanvasName")]
+    [Key("oldCanvasName")]
+    public string? OldCanvasName { get; init; }
+
+    /// <summary>Initializes a new instance for deserialization via <see cref="JsonConstructorAttribute"/>.</summary>
+    [JsonConstructor]
+    public CanvasNameChangedPayload() { }
+
+    /// <summary>
+    /// Initializes a new instance with all properties specified.
+    /// <para>Parameters are ordered with required properties first, then optional properties (with defaults). Follows protocol definition order where possible.</para>
+    /// </summary>
+    public CanvasNameChangedPayload(string? canvasUuid = null, string? oldCanvasName = null, string? canvasName = null)
+    {
+        this.CanvasUuid = canvasUuid;
+        this.OldCanvasName = oldCanvasName;
+        this.CanvasName = canvasName;
+    }
+
+}
+#pragma warning restore CS8618
+