Typed access to free-form protocol fields - #47
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Every field the protocol declares as free-form now has typed access, in both directions.
Reading: generated
The generator emits a pair of typed readers for each free-form field on an event payload or response. That is 17 fields, among them the settings carried by
InputCreated,InputSettingsChanged,SourceFilterCreatedandSourceFilterSettingsChanged, persistent data, vendor responses, and custom and vendor event data.One overload is for library-registered types, the other takes your
JsonTypeInfo. A reader returns null when OBS sent nothing and throwsObsWebSocketSerializationExceptionon a different shape. A test fails if any free-form property is missing its readers.Writing: helpers
Config.GetPersistentDataAsync<T>/SetPersistentDataAsync<T>General.CallVendorRequestAsync<TRequest, TResponse>General.BroadcastCustomEventAsync<T>Fixed
JsonExceptionescape when serialization failed, although their docs promiseObsWebSocketException. Every settings setter now throwsObsWebSocketSerializationException.Checked, not changed
OBS treats a null
slotValueas missing, so a persistent data slot cannot be cleared, only overwritten.SetPersistentDataAsyncdocuments this.