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.
Parameters
The source with sound. Give its id or name.
Mute, unmute, or toggle.
Result
inputstring (uuid)alwaysThe source's id.
mutedbooleanalways
Live state
audio.items[input].muted bool
On while muted. From the audio topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "audio.mute",
"params": {
"input": "<source id or name>"
}
}In the SDKs
Task<AudioMuteResult> AudioMuteAsync(AudioMuteParams parameters, CancellationToken cancellationToken = default)audioMute(params: AudioMuteParams): Promise<AudioMuteResult>async def audio_mute(self, *, input: str, mode: AudioMuteMode | None = None) -> AudioMuteResultJSON Schema
{
"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
The source with sound. Give its id or name.
The volume in dB (0 = as it comes in).
The fader position, 0 (silent) to 100 (0 dB), on the mixer's own scale.
Move the volume by this many dB (a dial's turn).
Result
inputstring (uuid)alwaysThe source's id.
volume_dbnumberalwayscan be nullThe volume in dB; null is silent.
volume_percentnumberalwaysThe 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.
{
"jsonrpc": "2.0",
"id": 1,
"method": "audio.volume",
"params": {
"input": "<source id or name>"
}
}In the SDKs
Task<AudioVolumeResult> AudioVolumeAsync(AudioVolumeParams parameters, CancellationToken cancellationToken = default)audioVolume(params: AudioVolumeParams): Promise<AudioVolumeResult>async def audio_volume(self, *, input: str, db: float | None = None, percent: float | None = None, step_db: float | None = None) -> AudioVolumeResultJSON Schema
{
"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.
Parameters
The source with sound. Give its id or name.
Toggle switches between off and headphones and stream.
Result
inputstring (uuid)alwaysThe source's id.
Live state
audio.items[input].monitor string
off, monitor_only or monitor_and_output. From the audio topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "audio.monitor",
"params": {
"input": "<source id or name>"
}
}In the SDKs
Task<AudioMonitorResult> AudioMonitorAsync(AudioMonitorParams parameters, CancellationToken cancellationToken = default)audioMonitor(params: AudioMonitorParams): Promise<AudioMonitorResult>async def audio_monitor(self, *, input: str, mode: AudioMonitorMode | None = None) -> AudioMonitorResultJSON Schema
{
"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).
Parameters
The source with sound. Give its id or name.
setting follows Studio's Audio setting; always is heard on air or not; on_air only while a scene on the program has it.
Result
inputstring (uuid)alwaysThe source's id.
Live state
audio.items[input].monitor_when string
setting, always or on_air. From the audio topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "audio.monitor_when",
"params": {
"input": "<source id or name>",
"when": "setting"
}
}In the SDKs
Task<AudioMonitorWhenResult> AudioMonitorWhenAsync(AudioMonitorWhenParams parameters, CancellationToken cancellationToken = default)audioMonitorWhen(params: AudioMonitorWhenParams): Promise<AudioMonitorWhenResult>async def audio_monitor_when(self, *, input: str, when: MonitorWhen) -> AudioMonitorWhenResultJSON Schema
{
"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
Monitor bus 1 to 4; bus 1 when omitted.
Output device id; an empty string follows the system default.
Linear volume, 0 to 1.
Whether this bus can play.
Result
busintegeralwaysdevicestringalwayscan be nullenabledbooleanalwaysvolumenumberalways
Live state
{
"jsonrpc": "2.0",
"id": 1,
"method": "audio.monitor_bus"
}In the SDKs
Task<AudioMonitorBusResult> AudioMonitorBusAsync(CancellationToken cancellationToken = default)async def audio_monitor_bus(self, *, bus: int | None = None, device: str | None = None, enabled: bool | None = None, volume: float | None = None) -> AudioMonitorBusResultJSON Schema
{
"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
The source with sound. Give its id or name.
Monitor bus 1 to 4; bus 1 when omitted.
Linear send level, 0 to 1; omitted to read it.
Result
busintegeralwaysinputstring (uuid)alwayslevelnumberalways
Live state
audio.items[input].monitor_sends any
Linear sends to buses 1 to 4. From the audio topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "audio.monitor_send",
"params": {
"input": "<source id or name>"
}
}In the SDKs
Task<AudioMonitorSendResult> AudioMonitorSendAsync(AudioMonitorSendParams parameters, CancellationToken cancellationToken = default)audioMonitorSend(params: AudioMonitorSendParams): Promise<AudioMonitorSendResult>async def audio_monitor_send(self, *, input: str, bus: int | None = None, level: float | None = None) -> AudioMonitorSendResultJSON Schema
{
"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
An application-audio source (such as [AUDIO] Discord App): the app it captures. Give its id or name.
Or the app's executable, such as Discord.exe (a full path's file name is used).
Windows' volume for the app, 0 to 100, as its Volume Mixer shows it.
Move it by this much (a dial's turn), within 0 to 100.
Windows' mute for the app: mute, unmute or toggle. Muting it there silences what Velum captures too.
Result
executablestringalwaysThe app's executable file name, such as Discord.exe.
inputstring (uuid)alwayscan be nullThe application-audio source's id; null when the app was named by executable.
mutedbooleanalwaysWindows' mute for the app now.
outputsarray of stringalwaysThe outputs it plays on, the default one first.
processesintegeralwaysIts running processes with a session.
sessionsintegeralwaysThe app's audio sessions on this computer's outputs (each took the change).
stream_keeps_levelbooleanalwayscan be nullWhether 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_percentnumberalwaysWindows' volume for the app now, 0 to 100 as its Volume Mixer shows it.
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.
{
"jsonrpc": "2.0",
"id": 1,
"method": "audio.app_volume"
}In the SDKs
Task<AudioAppVolumeResult> AudioAppVolumeAsync(CancellationToken cancellationToken = default)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) -> AudioAppVolumeResultJSON Schema
{
"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.
Parameters
The source with sound. Give its id or name.
The track, 1 to 6.
On, off, or toggle.
Result
inputstring (uuid)alwaysThe source's id.
onbooleanalwaysOn the track now.
trackintegeralways1 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.
{
"jsonrpc": "2.0",
"id": 1,
"method": "audio.track",
"params": {
"input": "<source id or name>",
"track": 1
}
}In the SDKs
Task<AudioTrackResult> AudioTrackAsync(AudioTrackParams parameters, CancellationToken cancellationToken = default)audioTrack(params: AudioTrackParams): Promise<AudioTrackResult>async def audio_track(self, *, input: str, track: int, mode: AudioTrackMode | None = None) -> AudioTrackResultJSON Schema
{
"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"
}
}
