obs-websocket v5.0.0 API Changes

[tt2468]

Any changes to the API will be posted here, for client developers to know about. Previously posted in our Discord via #v5-updates.

[tt2468]

• ReplayBufferSaved has been added to the list of planned events.

[tt2468]

• InputActiveStateChanged and InputShowStateChanged have been added as items to the EventSubscription enum.
• SceneListReindexed is back renamed to SceneListChanged, as the core event functionality (the list being reindexed) is unavailable.

[tt2468]

• obsWebsocketVersion has been changed to obsWebSocketVersion in the Hello message.

[tt2468]

• All requests starting with Delete have been renamed to use the term Remove in order to match the Events API

[tt2468]

• The new isGroup parameter has been added to:
  • The SceneCreated and SceneRemoved events
  • scenes.* of the GetSceneList request
  • scenes.* of the SceneListChanged event
• The new unversionedInputKind has been added to:
  • The InputCreated event
  • inputs.* of the GetInputList request
• The new unversioned has been added to GetInputKindList
• kinds has been renamed to inputKinds in the GetInputKindList response data

[tt2468]

• The inputKind parameter has been removed from SetInputSettings
• inputSettings has been renamed to defaultInputSettings in the GetInputDefaultSettings response data

[tt2468]

• GetInputActive has been removed from the API

[tt2468]

• Added RequestStatus::StreamServiceCreationFailed

[tt2468]

• sceneIndex has been removed from GetSceneList due to a technical limitation in OBS.
• The SetSceneIndex request has been removed.

[tt2468]

• The [X]etGlobalPersistentData and [X]etProfilePersistentData requests have been merged, with a new realm field being required.
  • There are two realms: OBS_WEBSOCKET_DATA_REALM_GLOBAL and OBS_WEBSOCKET_DATA_REALM_PROFILE
• DataRealmNotFound has been added to the RequestStatus enum

[tt2468]

• Added these items to the RequestStatus enum:
  • SceneCollectionAlreadyExists
  • NotEnoughSceneCollections
  • ProfileAlreadyExists
  • NotEnoughProfiles
  • NotEnoughScenes

[tt2468]

• We have done major changes to the base protocol. These changes are very good to have, and we decided it would be best to just go ahead and make them, while the plugin's protocol is still somewhat moldable. IF YOU HAVE WRITTEN ANY CODE FOR V5 UP UNTIL THIS POINT, IT WILL REQUIRE CHANGING IN ORDER FOR IT TO WORK.

You can download the latest CI artifacts from here

You can see a diff of the protocol changes here

[tt2468]

• The Content-Type header has been replaced with the Sec-WebSocket-Protocol standard. Selecting a subprotocol is not required. Subprotocols are:
  • obswebsocket.json
  • obswebsocket.msgpack
• As a part of switching away from Content-Type, WebSocketCloseCode::InvalidContentType has been removed.
• The format for QR codes has been changed to obsws[s]://[host]:[port]/[password]
  • Example: obswss://us-west1-a.proxy.obs-websocket.io:42069/supersecure

[tt2468]

• ignoreNonFatalRequestChecks has been removed from the Identify op

[tt2468]

• New types of request batches have been added. See this commit description: a8d27ed

[tt2468]

• As of docs: Overhaul documentation #863:
  • The ObsWebSocketRequestBatchExecutionType enum is now RequestBatchExecutionType and uses number values in the protocol instead of strings.
  • WebSocketCloseCode::InvalidDataKeyValue has been moved up, going from value 4011 to 4005, shifting others around.
  • The terms parameter and key have been standardized in most locations, including enumerations and docs. They are replaced with the term field.
  • The RequestStatus enum has been slightly shuffled to bring OutputNotPaused below OutputPaused.
  • The EventSubscription enum has been shuffled, and values changed to allow for future expansion of the enum.

This PR will add documentation, finally providing an official mechanism to track API changes.