Bump OBS websocket protocol to 5.4.0 (#134)

Co-authored-by: cathy-cloud[bot] <154095190+cathy-cloud[bot]@users.noreply.github.com>

Author: cathy-cloud[bot]

README.md

@@ -5,8 +5,8 @@
 [![Build Status][build-img]][build-url]
 [![Go Report][goreport-img]][goreport-url]
 
-[protocol-img]: https://img.shields.io/badge/obs--websocket-v5.3.5-blue?logo=obs-studio&style=flat-square
-[protocol-url]: https://github.com/obsproject/obs-websocket/blob/5.3.5/docs/generated/protocol.md
+[protocol-img]: https://img.shields.io/badge/obs--websocket-v5.4.0-blue?logo=obs-studio&style=flat-square
+[protocol-url]: https://github.com/obsproject/obs-websocket/blob/5.4.0/docs/generated/protocol.md
 [doc-img]: https://img.shields.io/badge/pkg.go.dev-reference-blue?logo=go&logoColor=white&style=flat-square
 [doc-url]: https://pkg.go.dev/github.com/andreykaipov/goobs
 [build-img]: https://img.shields.io/github/actions/workflow/status/andreykaipov/goobs/ci.yml?logo=github&style=flat-square&branch=main
@@ -66,9 +66,9 @@ The corresponding output:
 [//]: # (snippet-2-begin)
 ```console
 ❯ go run _examples/basic/main.go
-OBS Studio version: 30.0.1
-Server protocol version: 5.3.4
-Client protocol version: 5.3.5
-Client library version: 1.1.5
+OBS Studio version: 30.0.2
+Server protocol version: 5.4.0
+Client protocol version: 5.4.0
+Client library version: 1.2.0
 ```
 [//]: # (snippet-2-end)

api/events/xx_generated.filters.sourcefiltersettingschanged.go

@@ -0,0 +1,19 @@
+// This file has been automatically generated. Don't edit it.
+
+package events
+
+/*
+Represents the event body for the SourceFilterSettingsChanged event.
+
+An source filter's settings have changed (been updated).
+*/
+type SourceFilterSettingsChanged struct {
+	// Name of the filter
+	FilterName string `json:"filterName,omitempty"`
+
+	// New settings object of the filter
+	FilterSettings map[string]any `json:"filterSettings,omitempty"`
+
+	// Name of the source the filter is on
+	SourceName string `json:"sourceName,omitempty"`
+}

api/events/xx_generated.inputs.inputactivestatechanged.go

@@ -13,6 +13,9 @@ type InputActiveStateChanged struct {
 	// Name of the input
 	InputName string `json:"inputName,omitempty"`
 
+	// UUID of the input
+	InputUuid string `json:"inputUuid,omitempty"`
+
 	// Whether the input is active
 	VideoActive bool `json:"videoActive,omitempty"`
 }

api/events/xx_generated.inputs.inputaudiobalancechanged.go

@@ -11,6 +11,9 @@ type InputAudioBalanceChanged struct {
 	// New audio balance value of the input
 	InputAudioBalance float64 `json:"inputAudioBalance,omitempty"`
 
-	// Name of the affected input
+	// Name of the input
 	InputName string `json:"inputName,omitempty"`
+
+	// UUID of the input
+	InputUuid string `json:"inputUuid,omitempty"`
 }

api/events/xx_generated.inputs.inputaudiomonitortypechanged.go

@@ -17,6 +17,9 @@ type InputAudioMonitorTypeChanged struct {
 	// Name of the input
 	InputName string `json:"inputName,omitempty"`
 
+	// UUID of the input
+	InputUuid string `json:"inputUuid,omitempty"`
+
 	// New monitor type of the input
 	MonitorType string `json:"monitorType,omitempty"`
 }

api/events/xx_generated.inputs.inputaudiosyncoffsetchanged.go

@@ -13,4 +13,7 @@ type InputAudioSyncOffsetChanged struct {
 
 	// Name of the input
 	InputName string `json:"inputName,omitempty"`
+
+	// UUID of the input
+	InputUuid string `json:"inputUuid,omitempty"`
 }

api/events/xx_generated.inputs.inputaudiotrackschanged.go

@@ -15,4 +15,7 @@ type InputAudioTracksChanged struct {
 
 	// Name of the input
 	InputName string `json:"inputName,omitempty"`
+
+	// UUID of the input
+	InputUuid string `json:"inputUuid,omitempty"`
 }

api/events/xx_generated.inputs.inputcreated.go

@@ -20,6 +20,9 @@ type InputCreated struct {
 	// The settings configured to the input when it was created
 	InputSettings map[string]any `json:"inputSettings,omitempty"`
 
+	// UUID of the input
+	InputUuid string `json:"inputUuid,omitempty"`
+
 	// The unversioned kind of input (aka no `_v2` stuff)
 	UnversionedInputKind string `json:"unversionedInputKind,omitempty"`
 }

api/events/xx_generated.inputs.inputmutestatechanged.go

@@ -13,4 +13,7 @@ type InputMuteStateChanged struct {
 
 	// Name of the input
 	InputName string `json:"inputName,omitempty"`
+
+	// UUID of the input
+	InputUuid string `json:"inputUuid,omitempty"`
 }

api/events/xx_generated.inputs.inputnamechanged.go

@@ -11,6 +11,9 @@ type InputNameChanged struct {
 	// New name of the input
 	InputName string `json:"inputName,omitempty"`
 
+	// UUID of the input
+	InputUuid string `json:"inputUuid,omitempty"`
+
 	// Old name of the input
 	OldInputName string `json:"oldInputName,omitempty"`
 }

api/events/xx_generated.inputs.inputremoved.go

@@ -10,4 +10,7 @@ An input has been removed.
 type InputRemoved struct {
 	// Name of the input
 	InputName string `json:"inputName,omitempty"`
+
+	// UUID of the input
+	InputUuid string `json:"inputUuid,omitempty"`
 }

api/events/xx_generated.inputs.inputsettingschanged.go

@@ -0,0 +1,21 @@
+// This file has been automatically generated. Don't edit it.
+
+package events
+
+/*
+Represents the event body for the InputSettingsChanged event.
+
+An input's settings have changed (been updated).
+
+Note: On some inputs, changing values in the properties dialog will cause an immediate update. Pressing the "Cancel" button will revert the settings, resulting in another event being fired.
+*/
+type InputSettingsChanged struct {
+	// Name of the input
+	InputName string `json:"inputName,omitempty"`
+
+	// New settings object of the input
+	InputSettings map[string]any `json:"inputSettings,omitempty"`
+
+	// UUID of the input
+	InputUuid string `json:"inputUuid,omitempty"`
+}

api/events/xx_generated.inputs.inputshowstatechanged.go

@@ -13,6 +13,9 @@ type InputShowStateChanged struct {
 	// Name of the input
 	InputName string `json:"inputName,omitempty"`
 
+	// UUID of the input
+	InputUuid string `json:"inputUuid,omitempty"`
+
 	// Whether the input is showing
 	VideoShowing bool `json:"videoShowing,omitempty"`
 }

api/events/xx_generated.inputs.inputvolumechanged.go

@@ -11,6 +11,9 @@ type InputVolumeChanged struct {
 	// Name of the input
 	InputName string `json:"inputName,omitempty"`
 
+	// UUID of the input
+	InputUuid string `json:"inputUuid,omitempty"`
+
 	// New volume level in dB
 	InputVolumeDb float64 `json:"inputVolumeDb,omitempty"`
 

api/events/xx_generated.mediainputs.mediainputactiontriggered.go

@@ -11,6 +11,9 @@ type MediaInputActionTriggered struct {
 	// Name of the input
 	InputName string `json:"inputName,omitempty"`
 
+	// UUID of the input
+	InputUuid string `json:"inputUuid,omitempty"`
+
 	// Action performed on the input. See `ObsMediaInputAction` enum
 	MediaAction string `json:"mediaAction,omitempty"`
 }

api/events/xx_generated.mediainputs.mediainputplaybackended.go

@@ -10,4 +10,7 @@ A media input has finished playing.
 type MediaInputPlaybackEnded struct {
 	// Name of the input
 	InputName string `json:"inputName,omitempty"`
+
+	// UUID of the input
+	InputUuid string `json:"inputUuid,omitempty"`
 }

api/events/xx_generated.mediainputs.mediainputplaybackstarted.go

@@ -10,4 +10,7 @@ A media input has started playing.
 type MediaInputPlaybackStarted struct {
 	// Name of the input
 	InputName string `json:"inputName,omitempty"`
+
+	// UUID of the input
+	InputUuid string `json:"inputUuid,omitempty"`
 }

api/events/xx_generated.sceneitems.sceneitemcreated.go

@@ -17,6 +17,12 @@ type SceneItemCreated struct {
 	// Name of the scene the item was added to
 	SceneName string `json:"sceneName,omitempty"`
 
+	// UUID of the scene the item was added to
+	SceneUuid string `json:"sceneUuid,omitempty"`
+
 	// Name of the underlying source (input/scene)
 	SourceName string `json:"sourceName,omitempty"`
+
+	// UUID of the underlying source (input/scene)
+	SourceUuid string `json:"sourceUuid,omitempty"`
 }

api/events/xx_generated.sceneitems.sceneitemenablestatechanged.go

@@ -16,4 +16,7 @@ type SceneItemEnableStateChanged struct {
 
 	// Name of the scene the item is in
 	SceneName string `json:"sceneName,omitempty"`
+
+	// UUID of the scene the item is in
+	SceneUuid string `json:"sceneUuid,omitempty"`
 }

api/events/xx_generated.sceneitems.sceneitemlistreindexed.go

@@ -15,4 +15,7 @@ type SceneItemListReindexed struct {
 
 	// Name of the scene
 	SceneName string `json:"sceneName,omitempty"`
+
+	// UUID of the scene
+	SceneUuid string `json:"sceneUuid,omitempty"`
 }

api/events/xx_generated.sceneitems.sceneitemlockstatechanged.go

@@ -16,4 +16,7 @@ type SceneItemLockStateChanged struct {
 
 	// Name of the scene the item is in
 	SceneName string `json:"sceneName,omitempty"`
+
+	// UUID of the scene the item is in
+	SceneUuid string `json:"sceneUuid,omitempty"`
 }

api/events/xx_generated.sceneitems.sceneitemremoved.go

@@ -16,6 +16,12 @@ type SceneItemRemoved struct {
 	// Name of the scene the item was removed from
 	SceneName string `json:"sceneName,omitempty"`
 
+	// UUID of the scene the item was removed from
+	SceneUuid string `json:"sceneUuid,omitempty"`
+
 	// Name of the underlying source (input/scene)
 	SourceName string `json:"sourceName,omitempty"`
+
+	// UUID of the underlying source (input/scene)
+	SourceUuid string `json:"sourceUuid,omitempty"`
 }

api/events/xx_generated.sceneitems.sceneitemselected.go

@@ -13,4 +13,7 @@ type SceneItemSelected struct {
 
 	// Name of the scene the item is in
 	SceneName string `json:"sceneName,omitempty"`
+
+	// UUID of the scene the item is in
+	SceneUuid string `json:"sceneUuid,omitempty"`
 }

api/events/xx_generated.sceneitems.sceneitemtransformchanged.go

@@ -18,4 +18,7 @@ type SceneItemTransformChanged struct {
 
 	// The name of the scene the item is in
 	SceneName string `json:"sceneName,omitempty"`
+
+	// The UUID of the scene the item is in
+	SceneUuid string `json:"sceneUuid,omitempty"`
 }

api/events/xx_generated.scenes.currentpreviewscenechanged.go

@@ -10,4 +10,7 @@ The current preview scene has changed.
 type CurrentPreviewSceneChanged struct {
 	// Name of the scene that was switched to
 	SceneName string `json:"sceneName,omitempty"`
+
+	// UUID of the scene that was switched to
+	SceneUuid string `json:"sceneUuid,omitempty"`
 }

api/events/xx_generated.scenes.currentprogramscenechanged.go

@@ -10,4 +10,7 @@ The current program scene has changed.
 type CurrentProgramSceneChanged struct {
 	// Name of the scene that was switched to
 	SceneName string `json:"sceneName,omitempty"`
+
+	// UUID of the scene that was switched to
+	SceneUuid string `json:"sceneUuid,omitempty"`
 }

api/events/xx_generated.scenes.scenecreated.go

@@ -13,4 +13,7 @@ type SceneCreated struct {
 
 	// Name of the new scene
 	SceneName string `json:"sceneName,omitempty"`
+
+	// UUID of the new scene
+	SceneUuid string `json:"sceneUuid,omitempty"`
 }

api/events/xx_generated.scenes.scenenamechanged.go

@@ -13,4 +13,7 @@ type SceneNameChanged struct {
 
 	// New name of the scene
 	SceneName string `json:"sceneName,omitempty"`
+
+	// UUID of the scene
+	SceneUuid string `json:"sceneUuid,omitempty"`
 }

api/events/xx_generated.scenes.sceneremoved.go

@@ -13,4 +13,7 @@ type SceneRemoved struct {
 
 	// Name of the removed scene
 	SceneName string `json:"sceneName,omitempty"`
+
+	// UUID of the removed scene
+	SceneUuid string `json:"sceneUuid,omitempty"`
 }

api/events/xx_generated.transitions.currentscenetransitionchanged.go

@@ -10,4 +10,7 @@ The current scene transition has changed.
 type CurrentSceneTransitionChanged struct {
 	// Name of the new transition
 	TransitionName string `json:"transitionName,omitempty"`
+
+	// UUID of the new transition
+	TransitionUuid string `json:"transitionUuid,omitempty"`
 }

api/events/xx_generated.transitions.scenetransitionended.go

@@ -12,4 +12,7 @@ Note: Does not appear to trigger when the transition is interrupted by the user.
 type SceneTransitionEnded struct {
 	// Scene transition name
 	TransitionName string `json:"transitionName,omitempty"`
+
+	// Scene transition UUID
+	TransitionUuid string `json:"transitionUuid,omitempty"`
 }

api/events/xx_generated.transitions.scenetransitionstarted.go

@@ -10,4 +10,7 @@ A scene transition has started.
 type SceneTransitionStarted struct {
 	// Scene transition name
 	TransitionName string `json:"transitionName,omitempty"`
+
+	// Scene transition UUID
+	TransitionUuid string `json:"transitionUuid,omitempty"`
 }

api/events/xx_generated.transitions.scenetransitionvideoended.go

@@ -15,4 +15,7 @@ Note: Appears to be called by every transition, regardless of relevance.
 type SceneTransitionVideoEnded struct {
 	// Scene transition name
 	TransitionName string `json:"transitionName,omitempty"`
+
+	// Scene transition UUID
+	TransitionUuid string `json:"transitionUuid,omitempty"`
 }

api/events/zz_generated.events.go

@@ -24,6 +24,8 @@ func GetType(name string) any {
 		return &SourceFilterRemoved{}
 	case "SourceFilterNameChanged":
 		return &SourceFilterNameChanged{}
+	case "SourceFilterSettingsChanged":
+		return &SourceFilterSettingsChanged{}
 	case "SourceFilterEnableStateChanged":
 		return &SourceFilterEnableStateChanged{}
 	case "ExitStarted":
@@ -34,6 +36,8 @@ func GetType(name string) any {
 		return &InputRemoved{}
 	case "InputNameChanged":
 		return &InputNameChanged{}
+	case "InputSettingsChanged":
+		return &InputSettingsChanged{}
 	case "InputActiveStateChanged":
 		return &InputActiveStateChanged{}
 	case "InputShowStateChanged":

api/requests/filters/xx_generated.createsourcefilter.go

@@ -15,6 +15,9 @@ type CreateSourceFilterParams struct {
 
 	// Name of the source to add the filter to
 	SourceName *string `json:"sourceName,omitempty"`
+
+	// UUID of the source to add the filter to
+	SourceUuid *string `json:"sourceUuid,omitempty"`
 }
 
 func NewCreateSourceFilterParams() *CreateSourceFilterParams {
@@ -36,6 +39,10 @@ func (o *CreateSourceFilterParams) WithSourceName(x string) *CreateSourceFilterP
 	o.SourceName = &x
 	return o
 }
+func (o *CreateSourceFilterParams) WithSourceUuid(x string) *CreateSourceFilterParams {
+	o.SourceUuid = &x
+	return o
+}
 
 // Returns the associated request.
 func (o *CreateSourceFilterParams) GetRequestName() string {

api/requests/filters/xx_generated.getsourcefilter.go

@@ -9,6 +9,9 @@ type GetSourceFilterParams struct {
 
 	// Name of the source
 	SourceName *string `json:"sourceName,omitempty"`
+
+	// UUID of the source
+	SourceUuid *string `json:"sourceUuid,omitempty"`
 }
 
 func NewGetSourceFilterParams() *GetSourceFilterParams {
@@ -22,6 +25,10 @@ func (o *GetSourceFilterParams) WithSourceName(x string) *GetSourceFilterParams
 	o.SourceName = &x
 	return o
 }
+func (o *GetSourceFilterParams) WithSourceUuid(x string) *GetSourceFilterParams {
+	o.SourceUuid = &x
+	return o
+}
 
 // Returns the associated request.
 func (o *GetSourceFilterParams) GetRequestName() string {