command 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
- ObsAuthorizeCommand
- Generate a refresh token used to authenticate the command line API requests
- ObsBroadcastCustomEventCommand
- Broadcasts a CustomEvent to all WebSocket clients. Receivers are clients which are identified and subscribed.
- ObsBrowserEventCommand
- Helper method to send a VendorRequest specifically to the 'obs-browser' plugin.
- ObsCallVendorRequestCommand
- Call a request registered to a vendor.
- ObsConfigCommand
- Config Requests
- ObsCreateInputCommand
- Creates a new input, adding it as a scene item to the specified scene.
- ObsGeneralCommand
- General Requests
- ObsGetCurrentProgramSceneCommand
- ObsGetGroupListCommand
- ObsGetHotkeyListCommand
- Gets an array of all hotkey names in OBS
- ObsGetInputDefaultSettingsCommand
- Gets the default settings for an input kind.
- ObsGetInputKindListCommand
- Gets an array of all available input kinds in OBS.
- ObsGetInputListCommand
- Gets an array of all inputs in OBS.
- ObsGetInputMuteCommand
- Gets the mute status of an input.
- ObsGetInputSettingsCommand
- Gets the settings of an input.
- ObsGetMonitorListCommand
- Gets a list of connected monitors and information about them.
- ObsGetRecordDirectoryCommand
- Gets the current directory that the record output is set to.
- ObsGetSceneItemListCommand
- Gets a list of all scene items in a scene.
- ObsGetSceneItemLockedCommand
- Gets the lock state of a scene item.
- ObsGetScenesListCommand
- ObsGetSourceActiveCommand
- Gets the active and show state of a source.
- ObsGetSourceScreenshotCommand
- Gets a Base64-encoded screenshot of a source.
- ObsGetSpecialInputsCommand
- Gets the names of all special inputs.
- ObsGetStatsCommand
- Gets statistics about OBS, obs-websocket, and the current session.
- ObsGetStreamServiceSettingsCommand
- Gets the current stream service settings (stream destination).
- ObsGetStreamStatusCommand
- Gets the status of the stream output.
- ObsGetStudioModeEnabledCommand
- Gets whether studio is enabled.
- ObsGetVersionCommand
- Gets data about the current plugin and RPC version.
- ObsGetVideoSettingsCommand
- Gets the current video settings.
- ObsHelperCommand
- ObsInputsCommand
- Config Requests
- ObSleepCommand
- Sleeps for a time duration or number of frames. Only available in request batches with types SERIAL_REALTIME or SERIAL_FRAME.
- ObsListenCommand
- Listen fir OBS events
- ObsRemoveInputCommand
- Removes an existing input.
- ObsSaveSourceScreenshotCommand
- Saves a screenshot of a source to the filesystem.
- ObsSceneItemsCommand
- SceneItem Requests
- ObsScenesCommand
- Scenes Requests
- ObsSendCommand
- Listen fir OBS events
- ObsSendStreamCaptionCommand
- Sends CEA-608 caption text over the stream output.
- ObsSetInputMuteCommand
- Sets the mute status of an input.
- ObsSetInputNameCommand
- Sets the name of an input (rename).
- ObsSetInputSettingsCommand
- Sets the settings of an input.
- ObsSetSceneItemLockedCommand
- Sets the lock state of a scene item.
- ObsSetStreamServiceSettingsCommand
- Sets the current video settings.
- ObsSetStudioModeEnabledCommand
- Enables or disables studio mode
- ObsSetVideoSettingsCommand
- Sets the current video settings.
- ObsSourcesCommand
- Sources Requests
- ObsStartStreamCommand
- Starts the stream output.
- ObsStopStreamCommand
- Stops the stream output.
- ObsStreamCommand
- ObsToggleInputMuteCommand
- Toggles the mute status of an input.
- ObsToggleStreamCommand
- Toggles the status of the stream output.
- ObsTriggerHotkeyByKeySequenceCommand
- Triggers a hotkey using a sequence of keys.
- ObsTriggerHotkeyByNameCommand
-
Triggers a hotkey using its name. See
ObsGetHotkeyListCommand. - ObsUiCommand
- UI Requests
- ObsVersionCommand
- Generate a refresh token used to authenticate the command line API requests