OBS WebSocket

Control OBS Studio via WebSocket

Actions58

Streaming Actions
Recording Actions
Virtual Camera Actions
Scene Actions
Source Actions
Audio Actions
Filter Actions
Transition Actions
Media Actions
Text Source Actions
- Set Text
- Get Text
Hotkey Actions
- Trigger Hotkey
- List Hotkeys
Profile Actions
Screenshot Actions
- Take Screenshot
- Save Screenshot
General Actions

Filter → Toggle Filter

AI-generated

Summary

Toggle the enabled state of a specified filter on a given source in OBS Studio via WebSocket.

Inputs

Source Name (required) — The name of the source to which the filter is applied.
Filter Name (required) — The name of the filter to toggle on or off.

Output shape

a single JSON object containing the operation result with fields: success (boolean), message (string), sourceName (string), filterName (string), and enabled (boolean) indicating the filter's new state.

If an error occurs during the toggle operation, the node throws a NodeOperationError or returns an error object if 'Continue on Fail' is enabled. The output is paired with the input item.

Examples

Example 1: Toggle a filter named 'Chroma Key' on source 'Camera 1'

Set 'Source Name' to 'Camera 1' and 'Filter Name' to 'Chroma Key' for the 'Toggle Filter' operation in the 'Filter' resource.

OBS WebSocketInstall