v1.0.0

🚨 Breaking Changes

• reduce exposed fields on clients (#92) @andreykaipov
• generated code makeover (#81) @andreykaipov

💻 Protocol Updates

• Bump OBS websocket protocol to 5.2.3 (#91) @cathy-cloud
• Bump OBS websocket protocol to 5.2.2 (#88) @cathy-cloud
• Bump OBS websocket protocol to 5.2.1 (#86) @cathy-cloud
• Bump OBS websocket protocol to 5.2.0 (#84) @cathy-cloud

🚀 Features

• add option to enable profiling (#57) @andreykaipov

🐛 Bug Fixes

• fix: use SceneItemBasic for event.SceneItemListReindexed (#89) @andreykaipov
• don't expose ResponseCommon struct from Responses (#85) @andreykaipov
• client: handle disconnections better (#80) @andreykaipov
• Use time.NewTimer() instead of time.After() (#56) @afriza

🔧 Maintenance

• improve obs-websocket protocol version releaser workflow thing (#99) @andreykaipov
• misc. code cleanup (#93) @andreykaipov
• docs: add another example and a dev walkthrough guide (#90) @andreykaipov
• auto merge bot PRs (#87) @andreykaipov
• adds examples and documentation (#83) @andreykaipov
• more misc CI improvements (#76) @andreykaipov
• fix auto pr generation for next protocol version (#75) @andreykaipov
• fix generation for current protocol (#73) @andreykaipov
• have dependabot check for workflows + fix auto protocol version (#67) @andreykaipov
• add a workflow to create prs for the next v5 version (#66) @andreykaipov
• give me all your updates Dependabot (#63) @andreykaipov

🤖 Dependencies

• Bump tibdex/github-app-token from 1 to 2 (#82) @dependabot
• Bump github.com/gorilla/websocket from 1.5.0 to 1.5.1 (#64) @dependabot
• Bump github.com/stretchr/testify from 1.7.0 to 1.8.4 (#65) @dependabot
• Bump actions/checkout from 3 to 4 (#68) @dependabot
• Bump docker/login-action from 2 to 3 (#69) @dependabot
• Bump magnetikonline/action-golang-cache from 3 to 4 (#70) @dependabot
• Bump docker/setup-buildx-action from 2 to 3 (#71) @dependabot
• Bump docker/build-push-action from 3 to 5 (#72) @dependabot

v0.12.1 for obs websocket v5.1.0

Release v0.12.1 contains several CI improvements but also PR #54 that fixes concurrent writes to the OBS websocket server. 🎉

What's Changed

• Redo Docker image for testing obs by @andreykaipov in #44
• Image workflows by @andreykaipov in #45
• fix image retention policy by @andreykaipov in #46
• fix flaky test in ci by @andreykaipov in #47
• Bump gopkg.in/yaml.v3 from 3.0.0-20200313102051-9f266ea9e77c to 3.0.0 in /internal by @dependabot in #51
• Bump gopkg.in/yaml.v3 from 3.0.0-20200313102051-9f266ea9e77c to 3.0.0 by @dependabot in #50
• fix multi-goroutine request error by @ImmortalD in #54

New Contributors

• @dependabot made their first contribution in #51
• @ImmortalD made their first contribution in #54

Full Changelog: v0.12.0...v0.12.1

v0.12.0 for obs websocket v5.1.0

What's Changed

• obs websocket v5.1.0 by @andreykaipov in #43

Full Changelog: v0.11.0...v0.12.0

v0.11.0 for obs-websocket v5.0.2

What's Changed

• ci by @andreykaipov in #35
• client: error out when connecting to an obs-websocket v4.x instance by @andreykaipov in #37
• client: error out when authentication failed by @afriza in #38
• client: don't panic if server is not running by @afriza in #39
• client: close protocol version check connection by @afriza in #40
• obs websocket v5.0.2 by @andreykaipov in #41

New Contributors

• @afriza made their first contribution in #38

Full Changelog: v0.10.0...v0.11.0

v0.10.0 for obs-websocket v5.0.1

This new release doesn't change much apart from housekeeping things. The v5.0.1 protocol didn't change anything either.

I don't imagine many people immediately jumped onto the v0.9.0 release in any case.

The only significant API change is simplified import paths for MediaInputs and SceneInputs, changing the following:

import (
	mediainputs "github.com/andreykaipov/goobs/api/requests/media_inputs"
	sceneitems "github.com/andreykaipov/goobs/api/requests/scene_items"
)

to

import (
	"github.com/andreykaipov/goobs/api/requests/mediainputs"
	"github.com/andreykaipov/goobs/api/requests/sceneitems"
)

The motivation for this was to have gopls recognize when we use mediainputs or sceneitems in our code. It seems like it has trouble auto-importing when the directory name doesn't match the package exactly.

---

Full Changelog: v0.9.0...v0.10.0

v0.9.0 for obs-websocket v5.0.0

What's Changed

It's the v5.0.0 release corresponding to https://github.com/obsproject/obs-websocket/releases/tag/5.0.0.

There are unfortunately way too many changes to list. Due to the nature of the upstream protocol changing, the API has also changed, namely many requests and the field names in request bodies.

Full Changelog: v0.8.0...v0.9.0

---

New Contributors

• @lnqs made their first contribution in #31 for fixing a panic on a connection close. Never tagged a release with this change it seems!

v0.8.1 for obs-websocket v4.x

This is the last supported release for obs-websocket v4.x!

The only difference from v0.8.0 for obs-websocket v4.9.1 is the following bugfix:

• Fix panic on connection close by @lnqs in #31

v0.8.0 for obs-websocket v4.9.1

What's Changed

• Add configurable underlying dialer and request header options. (#25)

  • New client options: WithDialer(x *websocket.Dialer) and WithRequestHeader(x http.Header).

• Improve error handling and general client enhancements. (#24)

  • The client errors out if it doesn't receive a response from the server after a certain timeout; configurable via the new WithResponseTimeout(x time.Duration) option. (8d28d35)
  • Don't panic on unrecognized messages in the OBS eventing loop, e.g. when used against a server version like v5. (8ac3b76)
  • Broadcast events from OBS are now maintained in order, i.e. the oldest events are now purged if they haven't yet already been consumed, to make room for the latest. (87fc692)
  • Gracefully handle the rare case of an eventing issue happening before authentication occurs, e.g. our event loop failed parsing a raw message from the server for whatever reason. (f5a9289)

• Remove the vendor directory because this isn't big enterprise. (#26)

• Use three-valued boolean values (*bools) in request bodies. (#29 #30)

  • Otherwise, there's no way to tell the difference between a false value and an unset value for things. See #27 for issue context.

Full Changelog: v0.7.0...v0.8.0

v0.7.1 because i borked the goproxy somehow

Can't seem to use v0.7.0 🤦

go: github.com/andreykaipov/goobs@v0.7.0: verifying go.mod: github.com/andreykaipov/goobs@v0.7.0/go.mod: reading https://sum.golang.org/lookup/github.com/andreykaipov/goobs@v0.7.0: 410 Gone
        server response: not found: github.com/andreykaipov/goobs@v0.7.0: invalid version: unknown revision v0.7.0

v0.7.0 for obs-websocket v4.9.1

new feature:

• configurable debug logging, see new options WithDebug(bool) and WithLogger(requests.Logger) (#20)

maintenance things:

• CI stuff and e2e tests (#17, #18)
• documentation stuff (#19, #21)