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

AuthRequiredResponse
response to the ObsWebSocket.getAuthRequired command
BaseEvent
A class that represents an event emitted by the ObsWebSocket the a
BaseResponse
response to the low-level ObsWebSocket.command
CurrentProfileResponse
response to the ObsWebSocket.getCurrentScene command
MediaSourcesListResponse
MediaStateResponse
response to the ObsWebSocket.getMediaState command
ObsGeneralCommand
ObsGetAudioActiveSourcesCommand
Get the audio's active status of a specified source.
ObsGetAuthRequiredCommand
Tells the client if authentication is required. If so, returns authentication parameters challenge and salt (see "Authentication" for more information).
ObsGetMediaSourcesListSourcesCommand
List the media state of all media sources (vlc and media source)
ObsGetSourceActiveSourcesCommand
Get the source's active status of a specified source (if it is showing in the final mix).
ObsGetSourcesListSourcesCommand
List all sources available in the running OBS instance
ObsGetStreamingStatusStreamingCommand
Get current streaming and recording status.
ObsGetStreamSettingsStreamingCommand
Get the current streaming server settings.
ObsHelperCommand
ObsRefreshBrowserSourceSourcesCommand
Refreshes the specified browser source.
ObsSaveStreamSettingsStreamingCommand
Save the current streaming server settings to disk.
ObsSetStreamSettingsStreamingCommand
Sets one or more attributes of the current streaming server settings. Any options not passed will remain unchanged. Returns the updated settings in response. If 'type' is different than the current streaming service type, all settings are required. Returns the full settings of the stream (the same as GetStreamSettings).
ObsSourcesCommand
ObsStartStopStreamingStreamingCommand
Toggle streaming on or off (depending on the current stream state).
ObsStartStreamingStreamingCommand
Start streaming. Will return an error if streaming is not active.
ObsStopStreamingStreamingCommand
Stop streaming. Will return an error if streaming is not active.
ObsStreamingCommand
ObsTakeSourceScreenshotSourcesCommand
At least embedPictureFormat or saveToFilePath must be specified. [...]
ObsUtil
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.
Scene
Represents an OBS Scene
SceneItem
Represents an OBS SceneItem
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.
SceneItemListResponse
SceneItemProperty
Represents an OBS SceneItemProperty
SceneItemPropertyResponse
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.
SceneListResponse
Source
SourcesListResponse
StreamSetting
Represents an OBS StreamSetting
StreamSettings
StreamSettingsResponse
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.
StreamStatusResponse
StudioModeStatus
TakeSourceScreenshot
At least embedPictureFormat or saveToFilePath must be specified. [...]
TakeSourceScreenshotResponse

Enums

RecordingState
Enumerated states
SceneItemChange
Enumerated states
SceneItemState
Enumerated states
StreamState
Enumerated states