initial support for protocol version 5

[yusefnapora]

Hi! I hit #61 and noticed that the goobs library just released an update with protocol v5 compatibility. I figured I'd hack a little bit and try to get things building with the new version.

This PR seems to work, but there are a few things that I just commented out since I couldn't figure out the "new world" way of doing things:

• I disabled the label command, since I couldn't find anything similar to the Freetype2 stuff in the current version
• recordingStatus no longer prints the filename being recorded to, since that doesn't seem to be in the new API response
• virtualCameraStatus no longer prints the timecode for the same reason

I left TODO comments to mark the unfinished bits. I may not have time to polish this up to a state where it can be merged, so feel free to use as inspiration, push new commits and / or close the PR. Since this is a breaking change it probably deserves a version bump & some kind of warning to people with old versions of obs-websocket.

Cheers :)

[andreykaipov]

Hello! The text label stuff is under the Inputs category now.

func UpdateText(source, text string) error {
	if _, err := client.Inputs.SetInputSettings(&inputs.SetInputSettingsParams{
		InputName:     source,
		InputSettings: map[string]interface{}{"text": text},
	}); err != nil {
		return err
	}
	
	return nil
}

There's no dedicated properties struct for input settings anymore, since all the inputs share the same request now, so we have to use a map[string]interface{} here. The bright side is updating input settings is now a patch by default (see the Overlay field), so no need to grab the existing settings and copy them to the new one anymore.

Technically the above is all that's needed, but it might be good to check if it's actually a text input we're updating. Otherwise the request will work just fine but won't do anything (e.g. setting text on a media input).

	resp, err := client.Inputs.GetInputSettings(&inputs.GetInputSettingsParams{
		InputName: source,
	})
	if err != nil {
		return err
	}

        // check if text_ft2_source_v2 or text_gdiplus_v2
	kind := resp.InputKind
	if !strings.HasPrefix(kind, "text_") {
		return fmt.Errorf("input %s is of %s", source, kind)
	}

[muesli]

Nice work, @yusefnapora!

I'll have to see if it makes sense to reorganize a few of the commands to better match the protocol, or if we rather stick with the old organization of cli commands.

[matzegebbe]

Thank you very much! With this I can now use OBS-CLI with OBS28 again. This also gave me the idea a --version support, which protocol is supported then just.

[SwooshyCueb]

I tested this last night, and was unable to manipulate sceneitems (sources) inside groups.
This is something that is possible with current obs-cli with v4 websockets.

[v3eil]

Update soon?

[muesli]

There are still a few issues where the new v5 API doesn't support old functionality, which makes me hesitant to update. I was hoping this would resolve itself before the next obs-cli update, so I don't have to introduce breaking behavior.

[v3eil]

There are still a few issues where the new v5 API doesn't support old functionality, which makes me hesitant to update. I was hoping this would resolve itself before the next obs-cli update, so I don't have to introduce breaking behavior.

Okay. Keep up the good work!

[coolaj86]

Could we get an alpha pre-release?

[muesli]

Could we get an alpha pre-release?

Since there are still a few unimplemented commands (labels, e.g.), I'm not sure the current state warrants a pre-release. You can always build this yourself with a simple go build or go install.

[grigio]

I started obs-cmd with a minimal obs-websocket 5 support
https://github.com/grigio/obs-cmd

[Co3co]

Was this abandoned?