OBS WebSocket icon

OBS WebSocket

Control OBS Studio via WebSocket

Audio → Get Volume

AI-generated

Summary

Get the current volume level of a specified audio source in OBS Studio via its name.

Inputs

  • Audio Source Name (required) — The exact name of the audio source (e.g., "Desktop Audio", "Mic/Aux") to retrieve volume information from.

Output shape

a single JSON object containing the audio source name, volume as a percentage (0-100), volume in decibels, and volume multiplier.

The volume percent is rounded to the nearest whole number. The operation requires a valid connection to OBS WebSocket. Errors will be returned if the audio source is not found or the connection fails.

Examples

Example 1: Retrieve the volume level of the desktop audio source.

Set 'Audio Source Name' to 'Desktop Audio' and select the 'Get Volume' operation under the 'Audio' resource.

Discussion