obs_websocket library Null safety
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
- BaseEvent
- A class that represents an event emitted by the ObsWebSocket the a
- BaseResponse
- response to the low-level ObsWebSocket.command
- ObsWebSocket
- RecordingStateEvent
- A class that represents a group of events emitted by ObsWebSocket. These are RecordingState.recordingStarting, RecordingState.recordingStarted, RecordingState.recordingStopping, RecordingState.recordingStopped, RecordingState.recordingPaused and RecordingState.recordingResumed. The type attribute returns the RecordingState. Note: In some cases recordingFilename is not provided in this event because this information is not available at the time this event is emitted.
- SceneItemEvent
- A class that represents a group of events emitted by ObsWebSocket. These are SceneItemChange.sceneItemAdded, SceneItemChange.sceneItemRemoved, SceneItemChange.sceneItemSelected and SceneItemChange.sceneItemDeselected. The type attribute returns the SceneItemChange.
- SceneItemStateEvent
- A class that represents a group of events emitted by ObsWebSocket. These are SceneItemState.sceneItemVisibilityChanged and SceneItemState.sceneItemLockChanged. The type attribute returns the SceneItemState.
- StreamSetting
- Represents an OBS StreamSetting
- StreamStateEvent
- A class that represents a group of events emitted by ObsWebSocket. These are StreamState.streamStarting, StreamState.streamStarted, StreamState.streamStopping and StreamState.streamStopped. The type attribute returns the StreamState.
- StreamStatusEvent
- Emitted every 2 seconds when stream is active.
- TakeSourceScreenshot
- At least embedPictureFormat or saveToFilePath must be specified. [...]
- TakeSourceScreenshotResponse
Enums
- RecordingState
- Enumerated states
- SceneItemChange
- Enumerated states
- SceneItemState
- Enumerated states
- StreamState
- Enumerated states