Actions
Sources
15 actions in the Sources group. Each is its own JSON-RPC method, and also runs through action.run.
source.copy_settingsCopy a source's settings to another
Gives one source the settings of another of the same kind, as Copy settings and Paste settings do: two Auroras made to glow alike, a second capture card set up like the first, a title given another's font and colors. What makes each one itself stays its own (what an Aurora follows, which device or window a capture shows, a file, a title's words). One undo step.
Parameters
The source to copy from: its id or name. Give its id or name.
The source to paste onto, of the same kind: its id or name. Give its id or name.
Result
changedarray of stringalwaysThe settings that changed on it.
fromstring (uuid)alwaysThe source copied from.
keptarray of stringalwaysThe settings each source of its kind keeps its own (never copied).
tostring (uuid)alwaysThe source pasted onto.
Live state
{
"jsonrpc": "2.0",
"id": 1,
"method": "source.copy_settings",
"params": {
"from": "<source id or name>",
"to": "<source id or name>"
}
}In the SDKs
Task<SourceCopySettingsResult> SourceCopySettingsAsync(SourceCopySettingsParams parameters, CancellationToken cancellationToken = default)sourceCopySettings(params: SourceCopySettingsParams): Promise<SourceCopySettingsResult>async def source_copy_settings(self, *, from_: str, to: str) -> SourceCopySettingsResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"from": {
"description": "The source to copy from: its id or name. Give its id or name.",
"minLength": 1,
"type": "string"
},
"to": {
"description": "The source to paste onto, of the same kind: its id or name. Give its id or name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"from",
"to"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"changed": {
"description": "The settings that changed on it.",
"items": {
"type": "string"
},
"type": "array"
},
"from": {
"description": "The source copied from.",
"format": "uuid",
"type": "string"
},
"kept": {
"description": "The settings each source of its kind keeps its own (never copied).",
"items": {
"type": "string"
},
"type": "array"
},
"to": {
"description": "The source pasted onto.",
"format": "uuid",
"type": "string"
}
},
"required": [
"from",
"to",
"changed",
"kept"
],
"type": "object"
}
}source.record_separatelyRecord this source separately
Records a clean source feed beside the next program recording, when the encoder budget allows it. Options left out keep their settings; mode defaults to toggle. Audio defaults to none.
Parameters
The video source. Give its id or name.
Turn separate recording on, off or toggle it.
No audio, or this source's own audio.
Limit the source's size to the canvas, keeping its shape.
Result
audiostringalwayscap_canvasbooleanalwaysenabledbooleanalwayssourcestring (uuid)always
Live state
{
"jsonrpc": "2.0",
"id": 1,
"method": "source.record_separately",
"params": {
"source": "<source id or name>"
}
}In the SDKs
Task<SourceRecordSeparatelyResult> SourceRecordSeparatelyAsync(SourceRecordSeparatelyParams parameters, CancellationToken cancellationToken = default)sourceRecordSeparately(params: SourceRecordSeparatelyParams): Promise<SourceRecordSeparatelyResult>async def source_record_separately(self, *, source: str, audio: SourceRecordSeparatelyAudio | None = None, cap_canvas: bool | None = None, mode: SourceRecordSeparatelyMode | None = None) -> SourceRecordSeparatelyResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"audio": {
"description": "No audio, or this source's own audio.",
"enum": [
"none",
"source"
],
"type": "string"
},
"cap_canvas": {
"description": "Limit the source's size to the canvas, keeping its shape.",
"type": "boolean"
},
"mode": {
"description": "Turn separate recording on, off or toggle it.",
"enum": [
"on",
"off",
"toggle"
],
"type": "string"
},
"source": {
"description": "The video source. Give its id or name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"source"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"audio": {
"enum": [
"none",
"source"
],
"type": "string"
},
"cap_canvas": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"source": {
"format": "uuid",
"type": "string"
}
},
"required": [
"source",
"enabled",
"audio",
"cap_canvas"
],
"type": "object"
}
}source.setSet a source's setting
Sets one setting of a source: one Studio makes itself (an Aurora's follows, colors, palette, points, edges, intensity, softness, reach, drift or ease; a blur box's blur, strength, angle, block size, feather, corner radius, tint, brightness or opacity; catalog.list has them under source_settings) or a plugin's source (the settings its plugin made automatable, such as an avatar's held expression, camera or outfit; catalog.list has the loaded plugins' under plugin_settings). The source_settings topic lists every source's settings with their names, ranges and values now. A number can also move by a step (for dials); an on/off setting takes "toggle". Saved with the collection, like an Inspector edit. Give value or step.
KeyDialscope: manage
Parameters
The source: its id or name. Give its id or name.
The setting's key, such as softness, palette or expression_0_active.
The new value: true or false (or "toggle") for an on/off setting, a number, a choice's word, a color ("#rrggbb"), words, a list of colors ("#rrggbb"), or sources and scenes (a list, by name or id).
Move a number setting by this much (a dial's turn), within its range.
Result
settingstringalwayssourcestring (uuid)alwaysThe source's id.
valuenumber or boolean or string or arrayalwaysThe value it was set to; sources as a list of ids, a palette as its colors, a color as "#rrggbb".
Live state
sources.items[source].settings[setting] any
The setting's value now. From the sources topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "source.set",
"params": {
"source": "<source id or name>",
"setting": "<text>"
}
}In the SDKs
Task<SourceSetResult> SourceSetAsync(SourceSetParams parameters, CancellationToken cancellationToken = default)sourceSet(params: SourceSetParams): Promise<SourceSetResult>async def source_set(self, *, setting: str, source: str, step: float | None = None, value: Any | None = None) -> SourceSetResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"setting": {
"description": "The setting's key, such as softness, palette or expression_0_active.",
"maxLength": 64,
"type": "string"
},
"source": {
"description": "The source: its id or name. Give its id or name.",
"minLength": 1,
"type": "string"
},
"step": {
"description": "Move a number setting by this much (a dial's turn), within its range.",
"maximum": 10000.0,
"minimum": -10000.0,
"type": "number"
},
"value": {
"description": "The new value: true or false (or \"toggle\") for an on/off setting, a number, a choice's word, a color (\"#rrggbb\"), words, a list of colors (\"#rrggbb\"), or sources and scenes (a list, by name or id).",
"items": {
"type": "string"
},
"type": [
"number",
"boolean",
"string",
"array"
]
}
},
"required": [
"source",
"setting"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"setting": {
"type": "string"
},
"source": {
"description": "The source's id.",
"format": "uuid",
"type": "string"
},
"value": {
"description": "The value it was set to; sources as a list of ids, a palette as its colors, a color as \"#rrggbb\".",
"items": {
"type": "string"
},
"type": [
"number",
"boolean",
"string",
"array"
]
}
},
"required": [
"source",
"setting",
"value"
],
"type": "object"
}
}source.triggerTrigger a source's action
Fires one of a plugin source's actions, as its button in the Inspector does: an avatar's "Toggle expression", for one. The settings whose kind is trigger in the source_settings topic (catalog.list's plugin_settings has their schemas). Nothing is stored: there is nothing to save or undo.
Parameters
The plugin's source: its id or name. Give its id or name.
The trigger's key, such as expression_0_toggle.
Result
namestringalwaysThe trigger's name, as pickers show it.
settingstringalwayssourcestring (uuid)alwaysThe source's id.
Live state
{
"jsonrpc": "2.0",
"id": 1,
"method": "source.trigger",
"params": {
"source": "<source id or name>",
"setting": "<text>"
}
}In the SDKs
Task<SourceTriggerResult> SourceTriggerAsync(SourceTriggerParams parameters, CancellationToken cancellationToken = default)sourceTrigger(params: SourceTriggerParams): Promise<SourceTriggerResult>async def source_trigger(self, *, setting: str, source: str) -> SourceTriggerResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"setting": {
"description": "The trigger's key, such as expression_0_toggle.",
"maxLength": 64,
"type": "string"
},
"source": {
"description": "The plugin's source: its id or name. Give its id or name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"source",
"setting"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The trigger's name, as pickers show it.",
"type": "string"
},
"setting": {
"type": "string"
},
"source": {
"description": "The source's id.",
"format": "uuid",
"type": "string"
}
},
"required": [
"source",
"setting",
"name"
],
"type": "object"
}
}text.setSet text
Changes what a text source says.
Parameters
The text source. Give its id or name.
The new text.
Result
sourcestring (uuid)alwaysThe text source's id.
textstringalways
Live state
sources.items[source].text string
What the text source says now. From the sources topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "text.set",
"params": {
"source": "<text source id or name>",
"text": "<text>"
}
}In the SDKs
Task<TextSetResult> TextSetAsync(TextSetParams parameters, CancellationToken cancellationToken = default)textSet(params: TextSetParams): Promise<TextSetResult>async def text_set(self, *, source: str, text: str) -> TextSetResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"source": {
"description": "The text source. Give its id or name.",
"minLength": 1,
"type": "string"
},
"text": {
"description": "The new text.",
"maxLength": 10000,
"type": "string"
}
},
"required": [
"source",
"text"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"source": {
"description": "The text source's id.",
"format": "uuid",
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"source",
"text"
],
"type": "object"
}
}source.remove_from_all_scenesRemove a source from all scenes
Removes every layer of a source, on every scene and canvas (nested scenes and vertical layouts included); the source itself stays. Automations that used one of those layers are turned off. Needs "confirm": true; one undo puts it all back.
Keydestructivescope: manage
Parameters
The source. Give its id or name.
Must be true.
Result
automations_turned_offintegeralwaysAutomations turned off because they used it.
deletedbooleanalwaysTrue when the source itself was deleted too.
layers_removedintegeralwaysLayers removed, on every scene and canvas.
sourcestring (uuid)alwaysThe source's id.
Live state
{
"jsonrpc": "2.0",
"id": 1,
"method": "source.remove_from_all_scenes",
"params": {
"source": "<source id or name>",
"confirm": true
}
}In the SDKs
Task<SourceRemoveFromAllScenesResult> SourceRemoveFromAllScenesAsync(SourceRemoveFromAllScenesParams parameters, CancellationToken cancellationToken = default)sourceRemoveFromAllScenes(params: SourceRemoveFromAllScenesParams): Promise<SourceRemoveFromAllScenesResult>async def source_remove_from_all_scenes(self, *, confirm: bool, source: str) -> SourceRemoveFromAllScenesResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirm": {
"const": true,
"description": "Must be true.",
"type": "boolean"
},
"source": {
"description": "The source. Give its id or name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"source",
"confirm"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"automations_turned_off": {
"description": "Automations turned off because they used it.",
"type": "integer"
},
"deleted": {
"description": "True when the source itself was deleted too.",
"type": "boolean"
},
"layers_removed": {
"description": "Layers removed, on every scene and canvas.",
"type": "integer"
},
"source": {
"description": "The source's id.",
"format": "uuid",
"type": "string"
}
},
"required": [
"source",
"deleted",
"layers_removed",
"automations_turned_off"
],
"type": "object"
}
}source.delete_everywhereDelete a source everywhere
Deletes a source and every layer of it. Automations that used it are turned off, detectors stop watching it (one that watched only it is deleted), and Mirrors and settings that pointed at it point at nothing. Needs "confirm": true; one undo puts it all back.
Keydestructivescope: manage
Parameters
The source. Give its id or name.
Must be true.
Result
automations_turned_offintegeralwaysAutomations turned off because they used it.
deletedbooleanalwaysTrue when the source itself was deleted too.
layers_removedintegeralwaysLayers removed, on every scene and canvas.
sourcestring (uuid)alwaysThe source's id.
Live state
{
"jsonrpc": "2.0",
"id": 1,
"method": "source.delete_everywhere",
"params": {
"source": "<source id or name>",
"confirm": true
}
}In the SDKs
Task<SourceDeleteEverywhereResult> SourceDeleteEverywhereAsync(SourceDeleteEverywhereParams parameters, CancellationToken cancellationToken = default)sourceDeleteEverywhere(params: SourceDeleteEverywhereParams): Promise<SourceDeleteEverywhereResult>async def source_delete_everywhere(self, *, confirm: bool, source: str) -> SourceDeleteEverywhereResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirm": {
"const": true,
"description": "Must be true.",
"type": "boolean"
},
"source": {
"description": "The source. Give its id or name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"source",
"confirm"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"automations_turned_off": {
"description": "Automations turned off because they used it.",
"type": "integer"
},
"deleted": {
"description": "True when the source itself was deleted too.",
"type": "boolean"
},
"layers_removed": {
"description": "Layers removed, on every scene and canvas.",
"type": "integer"
},
"source": {
"description": "The source's id.",
"format": "uuid",
"type": "string"
}
},
"required": [
"source",
"deleted",
"layers_removed",
"automations_turned_off"
],
"type": "object"
}
}source.mergeMerge duplicate sources
Merges sources of the same kind into one (the keep source's settings win): every layer, automation, detector and Mirror that used one of them uses the keeper, the others are deleted, and their names keep working as names of the keeper. Needs "confirm": true; one undo puts it all back.
Keydestructivescope: manage
Parameters
The source to keep. Give its id or name.
The sources to merge into it, by id or name.
Must be true.
Result
keepstring (uuid)alwaysThe id of the source kept.
layers_repointedintegeralwaysLayers that now show the kept source.
mergedarray of string (uuid)alwaysThe ids of the sources merged into it (now deleted).
Live state
{
"jsonrpc": "2.0",
"id": 1,
"method": "source.merge",
"params": {
"keep": "<source id or name>",
"merge": [
"<text>"
],
"confirm": true
}
}In the SDKs
Task<SourceMergeResult> SourceMergeAsync(SourceMergeParams parameters, CancellationToken cancellationToken = default)sourceMerge(params: SourceMergeParams): Promise<SourceMergeResult>async def source_merge(self, *, confirm: bool, keep: str, merge: list[str]) -> SourceMergeResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"confirm": {
"const": true,
"description": "Must be true.",
"type": "boolean"
},
"keep": {
"description": "The source to keep. Give its id or name.",
"minLength": 1,
"type": "string"
},
"merge": {
"description": "The sources to merge into it, by id or name.",
"items": {
"type": "string"
},
"maxItems": 64,
"type": "array"
}
},
"required": [
"keep",
"merge",
"confirm"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"keep": {
"description": "The id of the source kept.",
"format": "uuid",
"type": "string"
},
"layers_repointed": {
"description": "Layers that now show the kept source.",
"type": "integer"
},
"merged": {
"description": "The ids of the sources merged into it (now deleted).",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"keep",
"merged",
"layers_repointed"
],
"type": "object"
}
}mirror.showPoint a Mirror
Chooses what a Mirror source shows: another source with a picture, or nothing.
Parameters
The Mirror source. Give its id or name.
What it shows; nothing when left out. Give its id or name.
Result
mirrorstring (uuid)alwaysThe Mirror's id.
showsstring (uuid)alwayscan be nullThe id of the source it shows now, or null for nothing.
Live state
sources.items[mirror].shows string
The id of the source the Mirror shows (null for nothing). From the sources topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "mirror.show",
"params": {
"mirror": "<source id or name>"
}
}In the SDKs
Task<MirrorShowResult> MirrorShowAsync(MirrorShowParams parameters, CancellationToken cancellationToken = default)mirrorShow(params: MirrorShowParams): Promise<MirrorShowResult>async def mirror_show(self, *, mirror: str, source: str | None = None) -> MirrorShowResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"mirror": {
"description": "The Mirror source. Give its id or name.",
"minLength": 1,
"type": "string"
},
"source": {
"description": "What it shows; nothing when left out. Give its id or name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"mirror"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"mirror": {
"description": "The Mirror's id.",
"format": "uuid",
"type": "string"
},
"shows": {
"description": "The id of the source it shows now, or null for nothing.",
"format": "uuid",
"type": [
"string",
"null"
]
}
},
"required": [
"mirror",
"shows"
],
"type": "object"
}
}capture.targetsWhat a capture can show
Lists what a display, window or game capture can be switched to now, as its Capture menu does: every display (name, size and where it sits, such as "DELL U2720Q · 2560×1440 · left"), the open windows, or for game capture "Whichever game is in front" and then the games and other windows. current is the one it shows now. Where the desktop's own dialog chooses (Linux on Wayland), a display or window capture lists only @choose, which opens that dialog again: no app may list what it offers.
Parameters
The display, window or game capture. Give its id or name.
Result
CaptureTargets
Who picks: list, from these targets; system, the desktop's own dialog (Linux on Wayland), so a display or window capture has only @choose.
currentstringalwayscan be nullThe id of the target it shows now, or null.
What it captures.
screens_onlybooleanalwaysThe desktop's dialog shares whole screens only.
sourcestring (uuid)alwaysThe capture's id.
targetsarray of CaptureTargetalwaysFields of
targetsclassstringoptionalcurrentbooleanalwaysThe one it shows now.
displaystringoptionalA display's own name.
exestringoptionalThe program's file name.
gamestringoptionalcan be nullWhy a window counts as a game (installed from a game library, captured before), or null.
Where the menu lists it.
heightintegeroptionalidstringalwaysWhat capture.set takes: a display's id, a window's saved form, @front or @choose.
missingbooleanoptionalChosen before but not connected or open now.
namestringalwaysAs the Capture menu shows it.
positionstringoptionalWhere a display sits among the others: left, right, middle, top, bottom, top left... (empty with one).
primarybooleanoptionaltitlestringoptionalA window's title.
widthintegeroptionalxintegeroptionalyintegeroptional
Live state
{
"jsonrpc": "2.0",
"id": 1,
"method": "capture.targets",
"params": {
"source": "<source id or name>"
}
}In the SDKs
Task<CaptureTargets> CaptureTargetsAsync(CaptureTargetsParams parameters, CancellationToken cancellationToken = default)captureTargets(params: CaptureTargetsParams): Promise<CaptureTargets>async def capture_targets(self, *, source: str) -> CaptureTargetsJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"source": {
"description": "The display, window or game capture. Give its id or name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"source"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"chooser": {
"description": "Who picks: list, from these targets; system, the desktop's own dialog (Linux on Wayland), so a display or window capture has only @choose.",
"enum": [
"list",
"system"
],
"title": "CaptureChooser",
"type": "string"
},
"current": {
"description": "The id of the target it shows now, or null.",
"type": [
"string",
"null"
]
},
"kind": {
"description": "What it captures.",
"enum": [
"display",
"window",
"game"
],
"title": "CaptureKind",
"type": "string"
},
"screens_only": {
"description": "The desktop's dialog shares whole screens only.",
"type": "boolean"
},
"source": {
"description": "The capture's id.",
"format": "uuid",
"type": "string"
},
"targets": {
"items": {
"additionalProperties": false,
"properties": {
"class": {
"type": "string"
},
"current": {
"description": "The one it shows now.",
"type": "boolean"
},
"display": {
"description": "A display's own name.",
"type": "string"
},
"exe": {
"description": "The program's file name.",
"type": "string"
},
"game": {
"description": "Why a window counts as a game (installed from a game library, captured before), or null.",
"type": [
"string",
"null"
]
},
"group": {
"description": "Where the menu lists it.",
"enum": [
"displays",
"front",
"games",
"windows",
"choose"
],
"title": "CaptureGroup",
"type": "string"
},
"height": {
"type": "integer"
},
"id": {
"description": "What capture.set takes: a display's id, a window's saved form, @front or @choose.",
"type": "string"
},
"missing": {
"description": "Chosen before but not connected or open now.",
"type": "boolean"
},
"name": {
"description": "As the Capture menu shows it.",
"type": "string"
},
"position": {
"description": "Where a display sits among the others: left, right, middle, top, bottom, top left... (empty with one).",
"type": "string"
},
"primary": {
"type": "boolean"
},
"title": {
"description": "A window's title.",
"type": "string"
},
"width": {
"type": "integer"
},
"x": {
"type": "integer"
},
"y": {
"type": "integer"
}
},
"required": [
"id",
"name",
"group",
"current"
],
"title": "CaptureTarget",
"type": "object"
},
"type": "array"
}
},
"required": [
"source",
"kind",
"chooser",
"screens_only",
"current",
"targets"
],
"title": "CaptureTargets",
"type": "object"
}
}capture.setSwitch what a capture shows
Switches a display, window or game capture to another target from capture.targets: a display's id, a window's id (its saved form, title:class:exe, which also finds a window that isn't open yet), @front for game capture's whichever game is in front, or @choose to open the desktop's own dialog again (Wayland). Saved like any edit; the capture keeps its place, crop and filters.
Parameters
The display, window or game capture. Give its id or name.
A target's id from capture.targets.
Result
namestringalwaysThe target, as the Capture menu shows it.
sourcestring (uuid)alwaysThe capture's id.
targetstringalwaysThe target it was switched to.
Live state
{
"jsonrpc": "2.0",
"id": 1,
"method": "capture.set",
"params": {
"source": "<source id or name>",
"target": "<text>"
}
}In the SDKs
Task<CaptureSetResult> CaptureSetAsync(CaptureSetParams parameters, CancellationToken cancellationToken = default)captureSet(params: CaptureSetParams): Promise<CaptureSetResult>async def capture_set(self, *, source: str, target: str) -> CaptureSetResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"source": {
"description": "The display, window or game capture. Give its id or name.",
"minLength": 1,
"type": "string"
},
"target": {
"description": "A target's id from capture.targets.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The target, as the Capture menu shows it.",
"type": "string"
},
"source": {
"description": "The capture's id.",
"format": "uuid",
"type": "string"
},
"target": {
"description": "The target it was switched to.",
"type": "string"
}
},
"required": [
"source",
"target",
"name"
],
"type": "object"
}
}media.controlMedia control
Plays, pauses, restarts, stops or seeks a media source (a video, a sound or a playlist), or moves a playlist to its next or previous item. With seek_ms and an action, it seeks first ("seek to 30 s and play"); with seek_ms alone, a paused source stays paused.
KeyDialscope: control
Parameters
The media source. Give its id or name.
What to do; toggle when neither this nor seek_ms is given.
Jump to this many milliseconds into the item playing.
Result
What was asked; null for a seek alone.
seek_msintegeralwayscan be nullWhere it was asked to seek to, if it was.
sourcestring (uuid)alwaysThe media source's id.
statusMediaStatusalwayscan be nullIts playback when asked (before the change, which follows in the media topic); null before it's been opened.
Fields of
statusat_msintegeralwaysWhen position_ms was true (Unix ms).
duration_msintegeralwayscan be nullerrorstringalwayscan be nullitemintegeralwaysitem_namestringalwaysitemsintegeralwayson_airbooleanalwaysposition_msintegeralwaysMilliseconds into the item at at_ms.
speednumberalwaysHow fast it plays (1 is as the file is): the position moves on this many ms a ms.
Live state
media.items[source].state string
idle, opening, playing, paused, stopped or ended. From the media topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "media.control",
"params": {
"source": "<media source id or name>"
}
}In the SDKs
Task<MediaControlResult> MediaControlAsync(MediaControlParams parameters, CancellationToken cancellationToken = default)mediaControl(params: MediaControlParams): Promise<MediaControlResult>async def media_control(self, *, source: str, action: MediaAction | None = None, seek_ms: int | None = None) -> MediaControlResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"action": {
"description": "What to do; toggle when neither this nor seek_ms is given.",
"enum": [
"play",
"pause",
"toggle",
"restart",
"stop",
"next",
"previous"
],
"type": "string"
},
"seek_ms": {
"description": "Jump to this many milliseconds into the item playing.",
"maximum": 86400000,
"minimum": 0,
"type": "integer"
},
"source": {
"description": "The media source. Give its id or name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"source"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"action": {
"description": "What was asked; null for a seek alone.",
"enum": [
"play",
"pause",
"toggle",
"restart",
"stop",
"next",
"previous",
null
],
"title": "MediaAction",
"type": [
"string",
"null"
]
},
"seek_ms": {
"description": "Where it was asked to seek to, if it was.",
"type": [
"integer",
"null"
]
},
"source": {
"description": "The media source's id.",
"format": "uuid",
"type": "string"
},
"status": {
"additionalProperties": false,
"description": "Its playback when asked (before the change, which follows in the media topic); null before it's been opened.",
"properties": {
"at_ms": {
"description": "When position_ms was true (Unix ms).",
"type": "integer"
},
"duration_ms": {
"type": [
"integer",
"null"
]
},
"error": {
"type": [
"string",
"null"
]
},
"item": {
"type": "integer"
},
"item_name": {
"type": "string"
},
"items": {
"type": "integer"
},
"on_air": {
"type": "boolean"
},
"position_ms": {
"description": "Milliseconds into the item at at_ms.",
"type": "integer"
},
"speed": {
"description": "How fast it plays (1 is as the file is): the position moves on this many ms a ms.",
"type": "number"
},
"state": {
"enum": [
"idle",
"opening",
"playing",
"paused",
"stopped",
"ended"
],
"title": "MediaPlayState",
"type": "string"
}
},
"required": [
"state",
"on_air",
"position_ms",
"at_ms",
"duration_ms",
"item",
"items",
"item_name",
"error",
"speed"
],
"title": "MediaStatus",
"type": [
"object",
"null"
]
}
},
"required": [
"source",
"action",
"seek_ms",
"status"
],
"type": "object"
}
}media.speedMedia speed
Sets how fast a media source plays, 0.25× to 4× (1 is as the file is), or moves it by a step (for dials). Its sound keeps its pitch; the picture, seeking and its end follow the speed. Saved with the source, like its Speed in the Inspector. Give speed or step.
KeyDialscope: control
Parameters
The media source. Give its id or name.
The speed: 0.25, 0.5, 0.75, 1, 1.25, 1.5, 2 or 4, or any other in between.
Move the speed by this much (a dial's turn), within 0.25 to 4.
Result
changedbooleanalwaysWhether the speed changed (false when it already played at it).
sourcestring (uuid)alwaysThe media source's id.
speednumberalwaysHow fast it plays now (1 is as the file is).
Live state
media.items[source].speed number
How fast it plays (1 is as the file is). From the media topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "media.speed",
"params": {
"source": "<media source id or name>"
}
}In the SDKs
Task<MediaSpeedResult> MediaSpeedAsync(MediaSpeedParams parameters, CancellationToken cancellationToken = default)mediaSpeed(params: MediaSpeedParams): Promise<MediaSpeedResult>async def media_speed(self, *, source: str, speed: float | None = None, step: float | None = None) -> MediaSpeedResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"source": {
"description": "The media source. Give its id or name.",
"minLength": 1,
"type": "string"
},
"speed": {
"description": "The speed: 0.25, 0.5, 0.75, 1, 1.25, 1.5, 2 or 4, or any other in between.",
"maximum": 4.0,
"minimum": 0.25,
"type": "number"
},
"step": {
"description": "Move the speed by this much (a dial's turn), within 0.25 to 4.",
"maximum": 4.0,
"minimum": -4.0,
"type": "number"
}
},
"required": [
"source"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"changed": {
"description": "Whether the speed changed (false when it already played at it).",
"type": "boolean"
},
"source": {
"description": "The media source's id.",
"format": "uuid",
"type": "string"
},
"speed": {
"description": "How fast it plays now (1 is as the file is).",
"type": "number"
}
},
"required": [
"source",
"speed",
"changed"
],
"type": "object"
}
}ndi.sendersNDI® senders
Lists the NDI senders on the network now: {senders: [{name, url, machine, label}]}. An NDI source shows one by its name (source.set with setting ndi_name).
Displayscope: control
Parameters
Result
sendersarray of objectalwaysNDI® senders on the network now.
Fields of
senderslabelstringalwaysmachinestringalwaysnamestringalwaysIts full name, "MACHINE (Name)": what an NDI source is set to.
urlstringalways
Live state
{
"jsonrpc": "2.0",
"id": 1,
"method": "ndi.senders"
}In the SDKs
Task<NdiSendersResult> NdiSendersAsync(CancellationToken cancellationToken = default)ndiSenders(): Promise<NdiSendersResult>async def ndi_senders(self) -> NdiSendersResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {},
"required": [],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"senders": {
"description": "NDI® senders on the network now.",
"items": {
"additionalProperties": false,
"properties": {
"label": {
"type": "string"
},
"machine": {
"type": "string"
},
"name": {
"description": "Its full name, \"MACHINE (Name)\": what an NDI source is set to.",
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"name",
"url",
"machine",
"label"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"senders"
],
"type": "object"
}
}source.ndi_sendSend a source over NDI®
Sends one source on its own as an NDI sender (OBS's NDI filter): its picture and sound, its picture, its sound (after its filters, before its fader), or nothing. Saved with the collection.
Parameters
The source: its id or name. Give its id or name.
off, video_audio, video or audio.
The sender's name; left out keeps its name, empty goes back to "Velum Studio - <source>".
Result
sourcestring (uuid)alwaysThe source's id.
Live state
{
"jsonrpc": "2.0",
"id": 1,
"method": "source.ndi_send",
"params": {
"source": "<source id or name>",
"send": "off"
}
}In the SDKs
Task<SourceNdiSendResult> SourceNdiSendAsync(SourceNdiSendParams parameters, CancellationToken cancellationToken = default)sourceNdiSend(params: SourceNdiSendParams): Promise<SourceNdiSendResult>async def source_ndi_send(self, *, send: NdiSend, source: str, name: str | None = None) -> SourceNdiSendResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"name": {
"description": "The sender's name; left out keeps its name, empty goes back to \"Velum Studio - <source>\".",
"maxLength": 256,
"type": "string"
},
"send": {
"description": "off, video_audio, video or audio.",
"enum": [
"off",
"video_audio",
"video",
"audio"
],
"type": "string"
},
"source": {
"description": "The source: its id or name. Give its id or name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"source",
"send"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"send": {
"enum": [
"off",
"video_audio",
"video",
"audio"
],
"title": "NdiSend",
"type": "string"
},
"source": {
"description": "The source's id.",
"format": "uuid",
"type": "string"
}
},
"required": [
"source",
"send"
],
"type": "object"
}
}
