Developer
Log in

Actions

Audio

8 actions in the Audio group. Each is its own JSON-RPC method, and also runs through action.run.

audio.muteMute

Mutes, unmutes or toggles a source's sound.

Keyscope: control

Parameters

  • inputaudio_inputrequired

    The source with sound. Give its id or name.

    Choices in audio

  • modechoiceoptional

    Mute, unmute, or toggle.

    One of mute unmute toggle · Default "toggle"

Result

  • inputstring (uuid)always

    The source's id.

  • mutedbooleanalways

Live state

audio.items[input].muted bool

On while muted. From the audio topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "audio.mute",
  "params": {
    "input": "<source id or name>"
  }
}

In the SDKs

C#
Task<AudioMuteResult> AudioMuteAsync(AudioMuteParams parameters, CancellationToken cancellationToken = default)
TypeScript
audioMute(params: AudioMuteParams): Promise<AudioMuteResult>
Python
async def audio_mute(self, *, input: str, mode: AudioMuteMode | None = None) -> AudioMuteResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "input": {
        "description": "The source with sound. Give its id or name.",
        "minLength": 1,
        "type": "string"
      },
      "mode": {
        "default": "toggle",
        "description": "Mute, unmute, or toggle.",
        "enum": [
          "mute",
          "unmute",
          "toggle"
        ],
        "type": "string"
      }
    },
    "required": [
      "input"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "input": {
        "description": "The source's id.",
        "format": "uuid",
        "type": "string"
      },
      "muted": {
        "type": "boolean"
      }
    },
    "required": [
      "input",
      "muted"
    ],
    "type": "object"
  }
}

audio.volumeVolume

Sets a source's volume in dB or on the mixer's 0 to 100 fader scale, or moves it by a step in dB (for dials). Give exactly one of db, percent or step_db.

DialKeyscope: control

Parameters

  • inputaudio_inputrequired

    The source with sound. Give its id or name.

    Choices in audio

  • dbnumberoptional

    The volume in dB (0 = as it comes in).

    -100 to 26 dB

  • percentnumberoptional

    The fader position, 0 (silent) to 100 (0 dB), on the mixer's own scale.

    0 to 100 %

  • step_dbnumberoptional

    Move the volume by this many dB (a dial's turn).

    -30 to 30 dB

Result

  • inputstring (uuid)always

    The source's id.

  • volume_dbnumberalwayscan be null

    The volume in dB; null is silent.

  • volume_percentnumberalways

    The fader position, 0 to 100.

Live state

audio.items[input].volume_db number

The volume in dB (null = silent). From the audio topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "audio.volume",
  "params": {
    "input": "<source id or name>"
  }
}

In the SDKs

C#
Task<AudioVolumeResult> AudioVolumeAsync(AudioVolumeParams parameters, CancellationToken cancellationToken = default)
TypeScript
audioVolume(params: AudioVolumeParams): Promise<AudioVolumeResult>
Python
async def audio_volume(self, *, input: str, db: float | None = None, percent: float | None = None, step_db: float | None = None) -> AudioVolumeResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "db": {
        "description": "The volume in dB (0 = as it comes in).",
        "maximum": 26.0,
        "minimum": -100.0,
        "type": "number"
      },
      "input": {
        "description": "The source with sound. Give its id or name.",
        "minLength": 1,
        "type": "string"
      },
      "percent": {
        "description": "The fader position, 0 (silent) to 100 (0 dB), on the mixer's own scale.",
        "maximum": 100.0,
        "minimum": 0.0,
        "type": "number"
      },
      "step_db": {
        "description": "Move the volume by this many dB (a dial's turn).",
        "maximum": 30.0,
        "minimum": -30.0,
        "type": "number"
      }
    },
    "required": [
      "input"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "input": {
        "description": "The source's id.",
        "format": "uuid",
        "type": "string"
      },
      "volume_db": {
        "description": "The volume in dB; null is silent.",
        "type": [
          "number",
          "null"
        ]
      },
      "volume_percent": {
        "description": "The fader position, 0 to 100.",
        "type": "number"
      }
    },
    "required": [
      "input",
      "volume_db",
      "volume_percent"
    ],
    "type": "object"
  }
}

audio.monitorMonitor

Chooses whether you hear a source in your headphones: off, headphones only, or headphones and stream.

Keyscope: control

Parameters

  • inputaudio_inputrequired

    The source with sound. Give its id or name.

    Choices in audio

  • modechoiceoptional

    Toggle switches between off and headphones and stream.

    One of off monitor_only monitor_and_output toggle · Default "toggle"

Result

  • inputstring (uuid)always

    The source's id.

  • monitorMonitorMode (string)always

    One of "off" "monitor_only" "monitor_and_output"

Live state

audio.items[input].monitor string

off, monitor_only or monitor_and_output. From the audio topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "audio.monitor",
  "params": {
    "input": "<source id or name>"
  }
}

In the SDKs

C#
Task<AudioMonitorResult> AudioMonitorAsync(AudioMonitorParams parameters, CancellationToken cancellationToken = default)
TypeScript
audioMonitor(params: AudioMonitorParams): Promise<AudioMonitorResult>
Python
async def audio_monitor(self, *, input: str, mode: AudioMonitorMode | None = None) -> AudioMonitorResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "input": {
        "description": "The source with sound. Give its id or name.",
        "minLength": 1,
        "type": "string"
      },
      "mode": {
        "default": "toggle",
        "description": "Toggle switches between off and headphones and stream.",
        "enum": [
          "off",
          "monitor_only",
          "monitor_and_output",
          "toggle"
        ],
        "type": "string"
      }
    },
    "required": [
      "input"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "input": {
        "description": "The source's id.",
        "format": "uuid",
        "type": "string"
      },
      "monitor": {
        "enum": [
          "off",
          "monitor_only",
          "monitor_and_output"
        ],
        "title": "MonitorMode",
        "type": "string"
      }
    },
    "required": [
      "input",
      "monitor"
    ],
    "type": "object"
  }
}

audio.monitor_whenMonitor when

Chooses when you hear a monitored source in your headphones: as Studio's Settings › Audio › Headphones play only what's on air says, always, or only while it's on air (fading with the transition, so the headphones play what viewers hear).

Keyscope: control

Parameters

  • inputaudio_inputrequired

    The source with sound. Give its id or name.

    Choices in audio

  • whenchoicerequired

    setting follows Studio's Audio setting; always is heard on air or not; on_air only while a scene on the program has it.

    One of setting always on_air

Result

  • inputstring (uuid)always

    The source's id.

  • whenMonitorWhen (string)always

    One of "setting" "always" "on_air"

Live state

audio.items[input].monitor_when string

setting, always or on_air. From the audio topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "audio.monitor_when",
  "params": {
    "input": "<source id or name>",
    "when": "setting"
  }
}

In the SDKs

C#
Task<AudioMonitorWhenResult> AudioMonitorWhenAsync(AudioMonitorWhenParams parameters, CancellationToken cancellationToken = default)
TypeScript
audioMonitorWhen(params: AudioMonitorWhenParams): Promise<AudioMonitorWhenResult>
Python
async def audio_monitor_when(self, *, input: str, when: MonitorWhen) -> AudioMonitorWhenResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "input": {
        "description": "The source with sound. Give its id or name.",
        "minLength": 1,
        "type": "string"
      },
      "when": {
        "description": "setting follows Studio's Audio setting; always is heard on air or not; on_air only while a scene on the program has it.",
        "enum": [
          "setting",
          "always",
          "on_air"
        ],
        "type": "string"
      }
    },
    "required": [
      "input",
      "when"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "input": {
        "description": "The source's id.",
        "format": "uuid",
        "type": "string"
      },
      "when": {
        "enum": [
          "setting",
          "always",
          "on_air"
        ],
        "title": "MonitorWhen",
        "type": "string"
      }
    },
    "required": [
      "input",
      "when"
    ],
    "type": "object"
  }
}

audio.monitor_busMonitor bus

Chooses where a monitor bus plays on this computer and its volume. Omitted settings keep their values.

KeyDialscope: control

Parameters

  • busintegeroptional

    Monitor bus 1 to 4; bus 1 when omitted.

    1 to 4

  • devicetextoptional

    Output device id; an empty string follows the system default.

    Up to 4096 characters

  • volumenumberoptional

    Linear volume, 0 to 1.

    0 to 1

  • enabledbooloptional

    Whether this bus can play.

Result

  • busintegeralways
  • devicestringalwayscan be null
  • enabledbooleanalways
  • volumenumberalways

Live state

This action has no live state.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "audio.monitor_bus"
}

In the SDKs

C#
Task<AudioMonitorBusResult> AudioMonitorBusAsync(CancellationToken cancellationToken = default)
Python
async def audio_monitor_bus(self, *, bus: int | None = None, device: str | None = None, enabled: bool | None = None, volume: float | None = None) -> AudioMonitorBusResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "bus": {
        "description": "Monitor bus 1 to 4; bus 1 when omitted.",
        "maximum": 4,
        "minimum": 1,
        "type": "integer"
      },
      "device": {
        "description": "Output device id; an empty string follows the system default.",
        "maxLength": 4096,
        "type": "string"
      },
      "enabled": {
        "description": "Whether this bus can play.",
        "type": "boolean"
      },
      "volume": {
        "description": "Linear volume, 0 to 1.",
        "maximum": 1.0,
        "minimum": 0.0,
        "type": "number"
      }
    },
    "required": [],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "bus": {
        "type": "integer"
      },
      "device": {
        "type": [
          "string",
          "null"
        ]
      },
      "enabled": {
        "type": "boolean"
      },
      "volume": {
        "type": "number"
      }
    },
    "required": [
      "bus",
      "device",
      "volume",
      "enabled"
    ],
    "type": "object"
  }
}

audio.monitor_sendMonitor send

Sets how much of a source is heard on one monitor bus, after its volume and mute.

KeyDialscope: control

Parameters

  • inputaudio_inputrequired

    The source with sound. Give its id or name.

    Choices in audio

  • busintegeroptional

    Monitor bus 1 to 4; bus 1 when omitted.

    1 to 4

  • levelnumberoptional

    Linear send level, 0 to 1; omitted to read it.

    0 to 1

Result

  • busintegeralways
  • inputstring (uuid)always
  • levelnumberalways

Live state

audio.items[input].monitor_sends any

Linear sends to buses 1 to 4. From the audio topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "audio.monitor_send",
  "params": {
    "input": "<source id or name>"
  }
}

In the SDKs

C#
Task<AudioMonitorSendResult> AudioMonitorSendAsync(AudioMonitorSendParams parameters, CancellationToken cancellationToken = default)
TypeScript
audioMonitorSend(params: AudioMonitorSendParams): Promise<AudioMonitorSendResult>
Python
async def audio_monitor_send(self, *, input: str, bus: int | None = None, level: float | None = None) -> AudioMonitorSendResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "bus": {
        "description": "Monitor bus 1 to 4; bus 1 when omitted.",
        "maximum": 4,
        "minimum": 1,
        "type": "integer"
      },
      "input": {
        "description": "The source with sound. Give its id or name.",
        "minLength": 1,
        "type": "string"
      },
      "level": {
        "description": "Linear send level, 0 to 1; omitted to read it.",
        "maximum": 1.0,
        "minimum": 0.0,
        "type": "number"
      }
    },
    "required": [
      "input"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "bus": {
        "type": "integer"
      },
      "input": {
        "format": "uuid",
        "type": "string"
      },
      "level": {
        "type": "number"
      }
    },
    "required": [
      "input",
      "bus",
      "level"
    ],
    "type": "object"
  }
}

audio.app_volumeApp volume in Windows

Sets how loud an application is for you: Windows' own volume for it (its Volume Mixer slider), on every process and output of the app. Not what viewers hear (that's the source's fader, audio.volume). Windows applies this volume before Velum captures the app, so the source's sound follows it unless the source ignores the app's Windows volume (its setting in the Inspector); a muted app, or one at 0, is silent there either way. Give input or executable, and percent, step or mode (none of them only reads it). Windows only.

DialKeyscope: control

Parameters

  • inputaudio_inputoptional

    An application-audio source (such as [AUDIO] Discord App): the app it captures. Give its id or name.

    Choices in audio

  • executabletextoptional

    Or the app's executable, such as Discord.exe (a full path's file name is used).

    Up to 260 characters

  • percentnumberoptional

    Windows' volume for the app, 0 to 100, as its Volume Mixer shows it.

    0 to 100 %

  • stepnumberoptional

    Move it by this much (a dial's turn), within 0 to 100.

    -100 to 100 %

  • modechoiceoptional

    Windows' mute for the app: mute, unmute or toggle. Muting it there silences what Velum captures too.

    One of mute unmute toggle

Result

  • executablestringalways

    The app's executable file name, such as Discord.exe.

  • inputstring (uuid)alwayscan be null

    The application-audio source's id; null when the app was named by executable.

  • mutedbooleanalways

    Windows' mute for the app now.

  • outputsarray of stringalways

    The outputs it plays on, the default one first.

  • processesintegeralways

    Its running processes with a session.

  • sessionsintegeralways

    The app's audio sessions on this computer's outputs (each took the change).

  • stream_keeps_levelbooleanalwayscan be null

    Whether the source keeps capturing the app at its full level whatever this volume; false when what viewers hear follows it; null when no source was named.

  • volume_percentnumberalways

    Windows' volume for the app now, 0 to 100 as its Volume Mixer shows it.

    0 to 100

Live state

app_volume.items[input].volume_percent number

Windows' volume for the source's app, 0 to 100 (null when there's none to read). From the app_volume topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "audio.app_volume"
}

In the SDKs

C#
Task<AudioAppVolumeResult> AudioAppVolumeAsync(CancellationToken cancellationToken = default)
Python
async def audio_app_volume(self, *, executable: str | None = None, input: str | None = None, mode: AudioAppVolumeMode | None = None, percent: float | None = None, step: float | None = None) -> AudioAppVolumeResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "executable": {
        "description": "Or the app's executable, such as Discord.exe (a full path's file name is used).",
        "maxLength": 260,
        "type": "string"
      },
      "input": {
        "description": "An application-audio source (such as [AUDIO] Discord App): the app it captures. Give its id or name.",
        "minLength": 1,
        "type": "string"
      },
      "mode": {
        "description": "Windows' mute for the app: mute, unmute or toggle. Muting it there silences what Velum captures too.",
        "enum": [
          "mute",
          "unmute",
          "toggle"
        ],
        "type": "string"
      },
      "percent": {
        "description": "Windows' volume for the app, 0 to 100, as its Volume Mixer shows it.",
        "maximum": 100.0,
        "minimum": 0.0,
        "type": "number"
      },
      "step": {
        "description": "Move it by this much (a dial's turn), within 0 to 100.",
        "maximum": 100.0,
        "minimum": -100.0,
        "type": "number"
      }
    },
    "required": [],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "executable": {
        "description": "The app's executable file name, such as Discord.exe.",
        "type": "string"
      },
      "input": {
        "description": "The application-audio source's id; null when the app was named by executable.",
        "format": "uuid",
        "type": [
          "string",
          "null"
        ]
      },
      "muted": {
        "description": "Windows' mute for the app now.",
        "type": "boolean"
      },
      "outputs": {
        "description": "The outputs it plays on, the default one first.",
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "processes": {
        "description": "Its running processes with a session.",
        "type": "integer"
      },
      "sessions": {
        "description": "The app's audio sessions on this computer's outputs (each took the change).",
        "type": "integer"
      },
      "stream_keeps_level": {
        "description": "Whether the source keeps capturing the app at its full level whatever this volume; false when what viewers hear follows it; null when no source was named.",
        "type": [
          "boolean",
          "null"
        ]
      },
      "volume_percent": {
        "description": "Windows' volume for the app now, 0 to 100 as its Volume Mixer shows it.",
        "maximum": 100,
        "minimum": 0,
        "type": "number"
      }
    },
    "required": [
      "input",
      "executable",
      "volume_percent",
      "muted",
      "sessions",
      "processes",
      "outputs",
      "stream_keeps_level"
    ],
    "type": "object"
  }
}

audio.trackAudio track

Puts a source's sound on one of Studio's six tracks, takes it off, or toggles it. Recordings record the tracks chosen in Studio's recording settings.

Keyscope: control

Parameters

  • inputaudio_inputrequired

    The source with sound. Give its id or name.

    Choices in audio

  • trackintegerrequired

    The track, 1 to 6.

    1 to 6

  • modechoiceoptional

    On, off, or toggle.

    One of on off toggle · Default "toggle"

Result

  • inputstring (uuid)always

    The source's id.

  • onbooleanalways

    On the track now.

  • trackintegeralways

    1 to 6.

Live state

audio.items[input].tracks[track] bool

On while the source is on this track. From the audio topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "audio.track",
  "params": {
    "input": "<source id or name>",
    "track": 1
  }
}

In the SDKs

C#
Task<AudioTrackResult> AudioTrackAsync(AudioTrackParams parameters, CancellationToken cancellationToken = default)
TypeScript
audioTrack(params: AudioTrackParams): Promise<AudioTrackResult>
Python
async def audio_track(self, *, input: str, track: int, mode: AudioTrackMode | None = None) -> AudioTrackResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "input": {
        "description": "The source with sound. Give its id or name.",
        "minLength": 1,
        "type": "string"
      },
      "mode": {
        "default": "toggle",
        "description": "On, off, or toggle.",
        "enum": [
          "on",
          "off",
          "toggle"
        ],
        "type": "string"
      },
      "track": {
        "description": "The track, 1 to 6.",
        "maximum": 6,
        "minimum": 1,
        "type": "integer"
      }
    },
    "required": [
      "input",
      "track"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "input": {
        "description": "The source's id.",
        "format": "uuid",
        "type": "string"
      },
      "on": {
        "description": "On the track now.",
        "type": "boolean"
      },
      "track": {
        "description": "1 to 6.",
        "type": "integer"
      }
    },
    "required": [
      "input",
      "track",
      "on"
    ],
    "type": "object"
  }
}

to open · ↑ ↓ to move · Esc to close