OBS WebSocket icon

OBS WebSocket

Control OBS Studio via WebSocket

Audio → Toggle Mute

AI-generated

Summary

Toggle the mute state of a specified audio source in OBS Studio via WebSocket.

Inputs

  • Audio Source Name (required) — Specify the exact name of the audio source in OBS to toggle mute for (e.g., "Desktop Audio", "Mic/Aux")

Output shape

a single JSON object indicating success and the new mute state of the audio source

Returns an object containing success status, a message, the audio source name, and the current muted state (true if muted, false otherwise). If an error occurs and continueOnFail is enabled, the output will contain an error message.

Examples

Example 1: Toggle mute on 'Mic/Aux' audio source

Set resource to 'Audio', operation to 'Toggle Mute', and Audio Source Name to 'Mic/Aux'.

Discussion