Actions
VELoQ
12 actions in the VELoQ group. Each is its own JSON-RPC method, and also runs through action.run.
veloq.visibilityWhat viewers get
Chooses where a source's sound goes for Velora viewers over VELoQ: public (viewers get a slider and can adjust it; in the VOD), public_drop_vod (a slider, left out of the VOD: music), hidden_keep_vod or hidden_drop_vod (heard with no slider of its own, in the VOD or not), or not_sent (never leaves Studio). toggle_vod keeps it where it is and flips it in or out of the VOD. Changes that move it to another track apply the next time you go live; a VOD flip on its own slider applies at once.
Parameters
The source with sound. Give its id or name.
Where it goes, or toggle_vod.
Result
inputstring (uuid)alwaysThe source's id.
Live state
audio.items[input].visibility string
public, public_drop_vod, hidden_keep_vod, hidden_drop_vod or not_sent. From the audio topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "veloq.visibility",
"params": {
"input": "<source id or name>",
"visibility": "public"
}
}In the SDKs
Task<VeloqVisibilityResult> VeloqVisibilityAsync(VeloqVisibilityParams parameters, CancellationToken cancellationToken = default)veloqVisibility(params: VeloqVisibilityParams): Promise<VeloqVisibilityResult>async def veloq_visibility(self, *, input: str, visibility: VeloqVisibilityVisibility) -> VeloqVisibilityResultJSON 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"
},
"visibility": {
"description": "Where it goes, or toggle_vod.",
"enum": [
"public",
"public_drop_vod",
"hidden_keep_vod",
"hidden_drop_vod",
"not_sent",
"toggle_vod"
],
"type": "string"
}
},
"required": [
"input",
"visibility"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"input": {
"description": "The source's id.",
"format": "uuid",
"type": "string"
},
"visibility": {
"enum": [
"public",
"public_drop_vod",
"hidden_keep_vod",
"hidden_drop_vod",
"not_sent"
],
"title": "VeloqVisibility",
"type": "string"
}
},
"required": [
"input",
"visibility"
],
"type": "object"
}
}veloq.viewer_startWhere viewers start
Sets where Velora viewers' slider for a source starts (its own slider over VELoQ), and whether it starts muted. Each viewer can still change it. Give volume_percent, muted, or both.
DialKeyscope: manage
Parameters
The source with sound. Give its id or name.
Where the slider starts, 0 to 100 (100 = full).
Whether it starts muted.
Result
inputstring (uuid)alwaysThe source's id.
mutedbooleanalwaysIt starts muted.
volume_percentnumberalwaysWhere viewers' slider starts, 0 to 100.
Live state
audio.items[input].viewer_volume number
Where the viewers' slider starts, 0 to 1. From the audio topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "veloq.viewer_start",
"params": {
"input": "<source id or name>"
}
}In the SDKs
Task<VeloqViewerStartResult> VeloqViewerStartAsync(VeloqViewerStartParams parameters, CancellationToken cancellationToken = default)veloqViewerStart(params: VeloqViewerStartParams): Promise<VeloqViewerStartResult>async def veloq_viewer_start(self, *, input: str, muted: bool | None = None, volume_percent: float | None = None) -> VeloqViewerStartResultJSON 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"
},
"muted": {
"description": "Whether it starts muted.",
"type": "boolean"
},
"volume_percent": {
"description": "Where the slider starts, 0 to 100 (100 = full).",
"maximum": 100.0,
"minimum": 0.0,
"type": "number"
}
},
"required": [
"input"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"input": {
"description": "The source's id.",
"format": "uuid",
"type": "string"
},
"muted": {
"description": "It starts muted.",
"type": "boolean"
},
"volume_percent": {
"description": "Where viewers' slider starts, 0 to 100.",
"type": "number"
}
},
"required": [
"input",
"volume_percent",
"muted"
],
"type": "object"
}
}veloq.stemEditor+ stem
Turns on, off or toggles recording a source as its own Editor+ stem when it's mixed with others (a send, the Stingers track, Other). Viewers never hear stems.
Parameters
The source with sound. Give its id or name.
On, off, or toggle.
Result
inputstring (uuid)alwaysThe source's id.
stembooleanalways
Live state
audio.items[input].stem bool
On while it's recorded as its own stem. From the audio topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "veloq.stem",
"params": {
"input": "<source id or name>"
}
}In the SDKs
Task<VeloqStemResult> VeloqStemAsync(VeloqStemParams parameters, CancellationToken cancellationToken = default)veloqStem(params: VeloqStemParams): Promise<VeloqStemResult>async def veloq_stem(self, *, input: str, mode: VeloqStemMode | None = None) -> VeloqStemResultJSON 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"
}
},
"required": [
"input"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"input": {
"description": "The source's id.",
"format": "uuid",
"type": "string"
},
"stem": {
"type": "boolean"
}
},
"required": [
"input",
"stem"
],
"type": "object"
}
}veloq.groupPut in a folder or send
Puts a source in an audio folder (it keeps its own slider, shown under the folder's name) or a send (one slider for all its sources), or takes it out when group is left out.
Parameters
The source with sound. Give its id or name.
The folder or send; none when left out. Give its id or name.
Result
groupstring (uuid)alwayscan be nullThe folder or send it's in now (null for none).
inputstring (uuid)alwaysThe source's id.
Live state
audio.items[input].group string
The id of the folder or send it's in (null for none). From the audio topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "veloq.group",
"params": {
"input": "<source id or name>"
}
}In the SDKs
Task<VeloqGroupResult> VeloqGroupAsync(VeloqGroupParams parameters, CancellationToken cancellationToken = default)veloqGroup(params: VeloqGroupParams): Promise<VeloqGroupResult>async def veloq_group(self, *, input: str, group: str | None = None) -> VeloqGroupResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"group": {
"description": "The folder or send; none when left out. Give its id or name.",
"minLength": 1,
"type": "string"
},
"input": {
"description": "The source with sound. Give its id or name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"input"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"group": {
"description": "The folder or send it's in now (null for none).",
"format": "uuid",
"type": [
"string",
"null"
]
},
"input": {
"description": "The source's id.",
"format": "uuid",
"type": "string"
}
},
"required": [
"input",
"group"
],
"type": "object"
}
}veloq.slider_orderWho gets a slider first
Sets a source's place in who gets the 8 viewer sliders first (1 first; 0 = automatic: microphones and devices, then capture and game, then overlays, then media files).
Parameters
The source with sound. Give its id or name.
1 for first; 0 for automatic.
Result
inputstring (uuid)alwaysThe source's id.
orderintegeralwaysIts place now (0 = automatic).
Live state
audio.items[input].slider_order number
Its place (0 = automatic). From the audio topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "veloq.slider_order",
"params": {
"input": "<source id or name>",
"order": 0
}
}In the SDKs
Task<VeloqSliderOrderResult> VeloqSliderOrderAsync(VeloqSliderOrderParams parameters, CancellationToken cancellationToken = default)veloqSliderOrder(params: VeloqSliderOrderParams): Promise<VeloqSliderOrderResult>async def veloq_slider_order(self, *, input: str, order: int) -> VeloqSliderOrderResultJSON 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"
},
"order": {
"description": "1 for first; 0 for automatic.",
"maximum": 999,
"minimum": 0,
"type": "integer"
}
},
"required": [
"input",
"order"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"input": {
"description": "The source's id.",
"format": "uuid",
"type": "string"
},
"order": {
"description": "Its place now (0 = automatic).",
"type": "integer"
}
},
"required": [
"input",
"order"
],
"type": "object"
}
}veloq.transitionsStinger sounds for viewers
Chooses where every stinger's sound goes for Velora viewers over VELoQ (the Transitions channel): hidden_keep_vod by default (heard in the Stingers track, in the VOD).
Parameters
Where stinger sounds go.
Result
has_stingerbooleanalwaysThe collection has a stinger now (without one this waits for one).
Live state
veloq.transitions string
Where stinger sounds go. From the veloq topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "veloq.transitions",
"params": {
"visibility": "public"
}
}In the SDKs
Task<VeloqTransitionsResult> VeloqTransitionsAsync(VeloqTransitionsParams parameters, CancellationToken cancellationToken = default)veloqTransitions(params: VeloqTransitionsParams): Promise<VeloqTransitionsResult>async def veloq_transitions(self, *, visibility: VeloqVisibility) -> VeloqTransitionsResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"visibility": {
"description": "Where stinger sounds go.",
"enum": [
"public",
"public_drop_vod",
"hidden_keep_vod",
"hidden_drop_vod",
"not_sent"
],
"type": "string"
}
},
"required": [
"visibility"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"has_stinger": {
"description": "The collection has a stinger now (without one this waits for one).",
"type": "boolean"
},
"visibility": {
"enum": [
"public",
"public_drop_vod",
"hidden_keep_vod",
"hidden_drop_vod",
"not_sent"
],
"title": "VeloqVisibility",
"type": "string"
}
},
"required": [
"visibility",
"has_stinger"
],
"type": "object"
}
}veloq.smart_defaultsSmart defaults
Gives sources their smart first choice for Velora viewers: microphones, calls, game and alerts get a slider; music gets a slider but stays out of the VOD; stingers and media files are heard with no slider. With folders, also sorts them into Voice, Game, Music and Alerts folders (made when missing). One source, or every source with sound.
Parameters
One source; every source with sound when left out. Give its id or name.
Also sort them into folders.
Result
changedintegeralwaysChoices and folders changed.
folders_madeintegeralwaysFolders made.
Live state
{
"jsonrpc": "2.0",
"id": 1,
"method": "veloq.smart_defaults"
}In the SDKs
Task<VeloqSmartDefaultsResult> VeloqSmartDefaultsAsync(CancellationToken cancellationToken = default)async def veloq_smart_defaults(self, *, folders: bool | None = None, input: str | None = None) -> VeloqSmartDefaultsResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"folders": {
"default": false,
"description": "Also sort them into folders.",
"type": "boolean"
},
"input": {
"description": "One source; every source with sound when left out. Give its id or name.",
"minLength": 1,
"type": "string"
}
},
"required": [],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"changed": {
"description": "Choices and folders changed.",
"type": "integer"
},
"folders_made": {
"description": "Folders made.",
"type": "integer"
}
},
"required": [
"changed",
"folders_made"
],
"type": "object"
}
}veloq.create_groupNew audio folder or send
Makes an audio folder (its sources keep their own sliders, shown together under its name) or a send (one slider for all its sources).
Parameters
Its name, as viewers see it.
folder or send.
A send's slider: in the VOD (public) or not (public_drop_vod).
Result
groupstring (uuid)alwaysThe folder's or send's id.
namestringalways
Live state
{
"jsonrpc": "2.0",
"id": 1,
"method": "veloq.create_group",
"params": {
"name": "<text>"
}
}In the SDKs
Task<VeloqCreateGroupResult> VeloqCreateGroupAsync(VeloqCreateGroupParams parameters, CancellationToken cancellationToken = default)veloqCreateGroup(params: VeloqCreateGroupParams): Promise<VeloqCreateGroupResult>async def veloq_create_group(self, *, name: str, kind: AudioGroupKind | None = None, send_visibility: VeloqCreateGroupSendVisibility | None = None) -> VeloqCreateGroupResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"kind": {
"default": "folder",
"description": "folder or send.",
"enum": [
"folder",
"send"
],
"type": "string"
},
"name": {
"description": "Its name, as viewers see it.",
"maxLength": 64,
"type": "string"
},
"send_visibility": {
"default": "public",
"description": "A send's slider: in the VOD (public) or not (public_drop_vod).",
"enum": [
"public",
"public_drop_vod"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"group": {
"description": "The folder's or send's id.",
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"group",
"name"
],
"type": "object"
}
}veloq.update_groupChange an audio folder or send
Renames an audio folder or send, makes a folder a send or a send a folder, or sets whether a send is in the VOD. Give any of name, kind and send_visibility.
Parameters
The folder or send. Give its id or name.
Its new name.
folder or send.
A send's slider: in the VOD (public) or not (public_drop_vod).
Result
groupstring (uuid)alwaysThe folder's or send's id.
namestringalways
Live state
audio_groups.items[group].name string
Its name. From the audio_groups topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "veloq.update_group",
"params": {
"group": "<folder or send id or name>"
}
}In the SDKs
Task<VeloqUpdateGroupResult> VeloqUpdateGroupAsync(VeloqUpdateGroupParams parameters, CancellationToken cancellationToken = default)veloqUpdateGroup(params: VeloqUpdateGroupParams): Promise<VeloqUpdateGroupResult>async def veloq_update_group(self, *, group: str, kind: AudioGroupKind | None = None, name: str | None = None, send_visibility: VeloqUpdateGroupSendVisibility | None = None) -> VeloqUpdateGroupResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"group": {
"description": "The folder or send. Give its id or name.",
"minLength": 1,
"type": "string"
},
"kind": {
"description": "folder or send.",
"enum": [
"folder",
"send"
],
"type": "string"
},
"name": {
"description": "Its new name.",
"maxLength": 64,
"type": "string"
},
"send_visibility": {
"description": "A send's slider: in the VOD (public) or not (public_drop_vod).",
"enum": [
"public",
"public_drop_vod"
],
"type": "string"
}
},
"required": [
"group"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"group": {
"description": "The folder's or send's id.",
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"group",
"name"
],
"type": "object"
}
}veloq.delete_groupDelete an audio folder or send
Deletes an audio folder or send; its sources stay, out of any folder.
Parameters
The folder or send. Give its id or name.
Result
groupstring (uuid)alwaysThe id it had.
Live state
{
"jsonrpc": "2.0",
"id": 1,
"method": "veloq.delete_group",
"params": {
"group": "<folder or send id or name>"
}
}In the SDKs
Task<VeloqDeleteGroupResult> VeloqDeleteGroupAsync(VeloqDeleteGroupParams parameters, CancellationToken cancellationToken = default)veloqDeleteGroup(params: VeloqDeleteGroupParams): Promise<VeloqDeleteGroupResult>async def veloq_delete_group(self, *, group: str) -> VeloqDeleteGroupResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"group": {
"description": "The folder or send. Give its id or name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"group"
],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"group": {
"description": "The id it had.",
"format": "uuid",
"type": "string"
}
},
"required": [
"group"
],
"type": "object"
}
}veloq.send_withSend to Velora with
Chooses how Studio sends to Velora: whip (one mixed track, the default) or veloq (Velora's own protocol: a track per source viewers can mix), and over VELoQ how many qualities (layers, 1 to 4; 0 = the default, 2). Applies the next time you go live.
Parameters
whip or veloq; as it is when left out.
Qualities over VELoQ, 1 to 4 (0 = the default, 2); as it is when left out.
Result
layersintegeralwayscan be nullQualities over VELoQ (null = the default, 2).
How Studio sends to Velora now.
Live state
{
"jsonrpc": "2.0",
"id": 1,
"method": "veloq.send_with"
}In the SDKs
Task<VeloqSendWithResult> VeloqSendWithAsync(CancellationToken cancellationToken = default)async def veloq_send_with(self, *, layers: int | None = None, protocol: VeloraProtocol | None = None) -> VeloqSendWithResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"layers": {
"description": "Qualities over VELoQ, 1 to 4 (0 = the default, 2); as it is when left out.",
"maximum": 4,
"minimum": 0,
"type": "integer"
},
"protocol": {
"description": "whip or veloq; as it is when left out.",
"enum": [
"whip",
"veloq"
],
"type": "string"
}
},
"required": [],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"layers": {
"description": "Qualities over VELoQ (null = the default, 2).",
"type": [
"integer",
"null"
]
},
"protocol": {
"description": "How Studio sends to Velora now.",
"enum": [
"whip",
"veloq"
],
"title": "VeloraProtocol",
"type": "string"
}
},
"required": [
"protocol",
"layers"
],
"type": "object"
}
}veloq.slidersViewer sliders
Shows how many of the 8 viewer sliders a VELoQ Go Live gives out now (sources and sends).
Displayscope: control
Parameters
Result
slider_limitintegeralwayssliders_usedintegeralways
Live state
veloq.sliders_used number
Viewer sliders taken. From the veloq topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "veloq.sliders"
}In the SDKs
Task<VeloqSlidersResult> VeloqSlidersAsync(CancellationToken cancellationToken = default)veloqSliders(): Promise<VeloqSlidersResult>async def veloq_sliders(self) -> VeloqSlidersResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {},
"required": [],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"slider_limit": {
"type": "integer"
},
"sliders_used": {
"type": "integer"
}
},
"required": [
"sliders_used",
"slider_limit"
],
"type": "object"
}
}
