toggle_mute
Mute or unmute a specific audio input in OBS Studio to control audio sources during streaming or recording.
Instructions
Toggle mute on an audio input.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| input_name | Yes | Name of the audio input (from list_audio_inputs). |
Implementation Reference
- obs-mcp-server.js:499-505 (handler)The handler implementation for the toggle_mute tool, which calls ToggleInputMute on the OBS client and returns the new muted state.
case "toggle_mute": { await obs.call("ToggleInputMute", { inputName: args.input_name }); const { inputMuted } = await obs.call("GetInputMute", { inputName: args.input_name, }); return ok({ input: args.input_name, muted: inputMuted }); } - obs-mcp-server.js:162-175 (registration)The definition and registration of the toggle_mute tool within the tool declaration array.
{ name: "toggle_mute", description: "Toggle mute on an audio input.", inputSchema: { type: "object", properties: { input_name: { type: "string", description: "Name of the audio input (from list_audio_inputs).", }, }, required: ["input_name"], }, },