obs_websocket library
Messages are exchanged between the client and the server as JSON objects. The protocol is based on the original OBS Remote protocol created by Bill Hamilton, with new commands specific to OBS Studio.
Classes
- Authentication
- BooleanResponse
-
Maps to a boolean response form the websocket.
bool?fields are added to the class for each Response type needed. - CallVendorRequestResponse
- A vendor is a unique name registered by a third-party plugin or script, which allows for custom requests and events to be added to obs-websocket. If a plugin or script implements vendor requests or events, documentation is expected to be provided with them.
- Event
- EventOpcode
- ExitStarted
- Hello
- HelloOpcode
- Identified
- Identify
- IdentifyOpcode
- Input
- InputKindResponse
- IntegerResponse
-
Maps to a integer response form the websocket.
int?fields are added to the class for each Response type needed. - KeyModifiers
- Monitor
- MonitorListResponse
- ObsWebSocket
- Opcode
- ProfileListResponse
- ProfileParameterResponse
- Gets the current directory that the record output is set to.
- RecordDirectoryResponse
- RecordStateChanged
- The state of the record output has changed.
- RecordStatusResponse
- ReIdentify
- ReIdentifyOpcode
- Request
- RequestBatch
- RequestBatchOpcode
- RequestBatchResponse
- RequestBatchResponseOpcode
- RequestData
- A vendor is a unique name registered by a third-party plugin or script, which allows for custom requests and events to be added to obs-websocket. If a plugin or script implements vendor requests or events, documentation is expected to be provided with them.
- RequestOpcode
- RequestResponse
- RequestResponseOpcode
- Scene
- SceneCollectionListResponse
- SceneItem
- SceneItemDetail
- SceneItemEnableStateChanged
- A scene item's enable state has changed.
- SceneItemListResponse
- SceneItemSelected
- A scene item has been selected in the Ui.
- SceneListResponse
- SceneSceneTransitionOverrideResponse
- SourceActiveResponse
- videoActive Whether the source is showing in Program videoShowing Whether the source is showing in the UI (Preview, Projector, Properties)
- SourceScreenshot
- SourceScreenshotResponse
- imageData Base64-encoded screenshot
- StatsResponse
- StreamServiceSettingsResponse
- StreamStateChanged
- The state of the stream output has changed.
- StreamStatusResponse
- StringListResponse
- StringResponse
-
Maps to a string response form the websocket.
string?fields are added to the class for each Response type needed. - StudioModeStateChanged
- Studio mode has been enabled or disabled.
- Transform
- VendorEvent
- VersionResponse
- VideoSettings
- VideoSettingsResponse