Integrations
Touch Portal
Everything Velum Studio can do from a button is in the Touch Portal plug-in, and every value a page might show is a Touch Portal state, pushed by Studio the moment it changes.
At a glance
- Version 0.9.0.
- One small native program per platform: Windows 10 or 11 (x64), macOS 13 or later (Apple silicon or Intel), and Linux (x64; Touch Portal for Linux is in open beta). Nothing else to install.
- Touch Portal Pro is required. Touch Portal's FAQ says plug-ins need it: "As a user you need the Pro Upgrade to be able to use plug-ins."
- Finds Studio by itself on the same computer: no port to type, no token to copy. It reads Studio's discovery file every two seconds and reconnects when Studio starts, quits, restarts on another port, or gets a new token. The token never leaves the plug-in.
- Lists are live. Scenes, sources, effects and the rest are choice lists filled from Studio, and they follow renames and new things as they happen.
Settings
Under Plug-ins in Touch Portal's settings, Velum Studio has:
- Studio instance.
Active(the default) follows the first Velum Studio running. To follow another, type its name exactly as Studios found lists it, for exampleVelum Studio (2). - Status (read only): connected, connecting, or why not.
- Studios found (read only): every Velum Studio running on this computer.
Actions
Generated from the plug-in's own entry file, by its groups in Touch Portal. hold marks actions that also work on a button's On Hold tab.
Scenes 5
| Action | On the button |
|---|---|
| Switch scene | Put scene [Scene] on air |
| Switch scene with a transition | Put scene [Scene] on air with [Transition] |
| Next scene | Put the next scene on air (Scenes list order, wrapping around) |
| Previous scene | Put the previous scene on air (Scenes list order, wrapping around) |
| Switch scene collection | Open scene collection [Collection] |
Layers 9
| Action | On the button |
|---|---|
| Show or hide a layer | In scene [Scene], [Mode] layer [Layer] |
| Clip a layer to the one below | In scene [Scene], [Mode] clipping layer [Layer] to the layer below it |
| Restart a layer | In scene [Scene], restart layer [Layer] (its show and its video from the start) |
| Set a layer's opacity | In scene [Scene], set layer [Layer] to [Percent] % opacity (0 gone, 100 solid) |
| Raise or lower a layer's opacity | In scene [Scene], change layer [Layer]'s opacity by [Step] % (negative fades it out) |
| Copy a layer's style | In scene [Scene], copy [Parts] from layer [From] |
| Apply a framing | In scene [Scene], move layer [Layer] to framing [Framing] |
| Nudge a layer | In scene [Scene], move layer [Layer] by [Dx] px right and [Dy] px down (negative: left or up) |
| Freeze when the scene comes on air | In scene [Scene], [Mode] Freeze when this scene comes on air for layer [Layer] |
Effects 3
| Action | On the button |
|---|---|
| Turn an effect on or off | On [Owner], [Mode] effect [Filter] |
| Set an effect's setting | On [Owner], set effect [Filter]'s [Setting] to [Value] |
| Raise or lower an effect's setting | On [Owner], change effect [Filter]'s [Setting] by [Step] (negative lowers it) |
Audio 12
| Action | On the button |
|---|---|
| Mute | [Mode] [Input] |
| Set volume (fader position) | Set [Input] to [Percent] on the mixer's fader (0 silent, 100 = 0 dB) |
| Set volume (dB) | Set [Input] to [Db] dB (-100 to 26; 0 = as it comes in) |
| Raise or lower volume | Change [Input] by [Step db] dB (negative lowers it) |
| Monitor | Monitor [Input]: [Mode] |
| Audio track | [Mode] [Track] for [Input] |
| Monitor bus | [Bus]: [Enabled], volume [Volume percent] % (empty keeps it) |
| Monitor send | Send [Input] to [Bus] at [Percent] % (after its volume and mute) |
| Raise or lower a monitor send | Change [Input]'s send to [Bus] by [Step] % (negative lowers it) |
| Set an app's volume in Windows (what you hear) | Set the app [Input] captures to [Percent] % in Windows' Volume Mixer (you hear it; viewers get the fader) |
| Raise or lower an app's volume in Windows | Change the app [Input] captures by [Step] % in Windows' Volume Mixer (negative lowers it) |
| Mute an app in Windows | [Mode] the app [Input] captures in Windows (viewers lose it too while it's muted) |
Sources 8
| Action | On the button |
|---|---|
| Set text | Set text source [Source] to [Text] |
| Point a Mirror | Make Mirror [Mirror] show [Source] |
| Remove a source from all scenes | Remove every layer of [Source] from every scene (the source stays) |
| Delete a source everywhere | Delete [Source] and every layer of it (Undo in Studio puts it back) |
| Merge duplicate sources | Keep [Keep] and merge into it [Merge] (names, separated by commas) |
| Media control | [Action] media source [Source] |
| Seek a media source | Jump media source [Source] to [Seconds] seconds into the item playing |
| Record a source separately | [Mode] recording [Source] separately (a clean file beside the next recording) |
Source settings 5
| Action | On the button |
|---|---|
| Fire a source's action | On [Source], fire [Setting] |
| Turn a source's setting on or off | [Mode] [Setting] on [Source] |
| Choose a source setting's option | On [Source], set [Setting] to [Option] |
| Set a source's setting | On [Source], set [Setting] to [Value] (a number, words, a color like #ff8800; a list separated by commas) |
| Raise or lower a source's setting | On [Source], change [Setting] by [Step] (negative lowers it) |
Recording, streaming and virtual camera 20
| Action | On the button |
|---|---|
| Screenshot | Screenshot [Of]: scene [Scene], source [Source] |
| Start recording | Start recording |
| Stop recording | Stop recording |
| Record (toggle) | Start recording, or stop it if it's running |
| Go live | Go live to [Destination] |
| End stream | End the stream (viewers see it end) |
| Go live or end stream (toggle) | Go live to [Destination], or end the stream if it's live |
| Select destination | Make [Destination] where Go live sends |
| Start virtual camera | Start the virtual camera |
| Stop virtual camera | Stop the virtual camera |
| Virtual camera (toggle) | Start the virtual camera, or stop it if it's on |
| Pause recording | [Mode] the recording (paused time is left out of the file) |
| Start replay buffer | Start keeping the last seconds of what's on air (for Save replay) |
| Stop replay buffer | Stop the replay buffer (what it held is let go) |
| Replay buffer (toggle) | Start the replay buffer, or stop it if it's running |
| Save replay | Save the replay buffer's last seconds into [Folder] (empty: the replay buffer's folder) |
| Go live on a destination | Go live on [Destination] (beside the destinations already live; offline, on it alone) |
| End a destination's stream | End the stream on [Destination] (the others carry on; its viewers see it end) |
| Go live on a destination or end it (toggle) | Go live on [Destination], or end its stream if it's live (the others carry on) |
| Audio sent to a destination | [Destination] gets [Audio] (from its next go live; not Velora) |
Stream info 1
| Action | On the button |
|---|---|
| Set title and category | Title [Title] |
Chat 6
| Action | On the button |
|---|---|
| Send a chat message | Send [Text] to [Platform] |
| Chat mode | [Set] [Mode] on [Platform] |
| Ban or time out | [Action] [User] on [Platform] |
| Clear chat | Clear [Platform] chat for everyone |
| Delete a chat message | Delete message [Message] on [Platform] for everyone (the message's id on its platform) |
| Delete the last chat message | Delete the newest chat message from [Platform] for everyone (press again for the one before) |
Automations 3
| Action | On the button |
|---|---|
| Run an automation | Run automation [Automation] |
| Set a variable | Set variable [Name] to [Value] (empty forgets it) |
| Turn an automation on or off | [Mode] automation [Automation] |
Dynamic Sources 1
| Action | On the button |
|---|---|
| Set a Dynamic Sources variable | Set Dynamic Sources [Variable] to [Value] (empty clears it) |
Transitions and studio mode 6
| Action | On the button |
|---|---|
| Set the transition | Scene switches play [Transition] |
| Set a scene's transition | Coming on air, scene [Scene] plays [Transition] (Default clears its own) |
| Studio mode | [Mode] studio mode |
| Preview a scene | Put scene [Scene] in studio mode's preview (for the next Take) |
| Take | Put the preview scene on air with its transition |
| Wait until the transition finishes | Hold the Velum Studio actions after this one until the scene transition finishes |
Updates 2
| Action | On the button |
|---|---|
| Check for updates | Ask Studio's update channel whether there's a newer Studio (nothing is downloaded) |
| Install update | Download and verify the update on offer (never while live, recording or keeping a replay buffer) |
VELoQ: what Velora viewers hear 11
| Action | On the button |
|---|---|
| What Velora viewers get from a source | Velora viewers get [Input]: [Visibility] |
| Where viewers' slider starts | Velora viewers' slider for [Input] starts at [Volume percent] % (empty keeps it) |
| Editor+ stem | [Mode] recording [Input] as its own Editor+ stem (viewers never hear stems) |
| Put a source in an audio folder or send | Put [Input] in [Group] |
| Who gets a viewer slider first | [Input] is number [Order] for the 8 viewer sliders (1 first; 0 = automatic) |
| Stinger sounds for Velora viewers | Every stinger's sound for Velora viewers: [Visibility] |
| Smart defaults for Velora viewers | Give [Input] its smart first choice for Velora viewers |
| New audio folder or send | Make a [Kind] named [Name] |
| Change an audio folder or send | Change [Group]: rename it [Name] (empty keeps the name) |
| Delete an audio folder or send | Delete [Group] (its sources stay, out of any folder) |
| Send to Velora with | Send to Velora with [Protocol] |
Avatars 1
| Action | On the button |
|---|---|
| Avatar lip sync | [Mode] lip sync [Pairing] (Settings › Avatars in Studio) |
Advanced 1
| Action | On the button |
|---|---|
| Raw request | Commit scene-model commands [Commands] |
Velum Studio connection 1
| Action | On the button |
|---|---|
| Follow a Velum Studio | Follow Velum Studio [Instance] |
Sliders and dials
Connectors are two-way: moving the slider changes Studio, and a change in Studio moves the slider.
| Connector | Connects | On |
|---|---|---|
| Volume (fader) | Volume of [Input] on the mixer's fader | slider |
| Volume (dB dial) | Volume of [Input] in dB (set the dial from -100 to 26) | dial |
| Effect setting (slider) | Effect [Effect], setting [Setting], from its lowest to its highest | slider |
| Effect setting (dial) | Effect [Effect], setting [Setting] (set the dial to the setting's own range) | dial |
| Media position (slider) | Where media source [Source] is in the item playing, from its start to its end | slider |
| Where viewers' slider starts (slider) | Where Velora viewers' slider for [Input] starts, 0 to 100 | slider |
| Layer opacity (slider) | Opacity of layer [Layer], 0 (gone) to 100 (solid) | slider |
| Monitor send (slider) | How much of [Input] [Bus] hears, 0 to 100 | slider |
| Monitor bus volume (slider) | Volume of [Bus], 0 to 100 | slider |
| App volume in Windows (slider: what you hear) | Windows' volume for the app [Input] captures, 0 to 100 (you hear it; viewers get the fader) | slider |
| Source setting (slider) | Source setting [Setting], from its lowest to its highest | slider |
| Source setting (dial) | Source setting [Setting] (set the dial to the setting's own range) | dial |
| Scene by position | Scene on air, by its place in the Scenes list | slider |
The volume fader is Studio's own mixer scale: 0 is silent, 100 is 0 dB, and 50 is about −18 dB. For dB directly, use the dial with a range of −100 to 26.
Events
| Event | When | Local states |
|---|---|---|
| Scene changed | When the scene on air changes | Scene on air, Scene before |
| Scene goes on air (by name) | When the scene on air becomes $val | none |
| Scene leaves the air (by name) | When the scene $val leaves the air | none |
| Went live | When the stream goes live | Live to |
| Went offline | When the stream ends | Stream length (h:mm:ss) |
| Recording started | When recording starts | none |
| Recording stopped | When recording stops | Recording length (h:mm:ss) |
| Virtual camera started | When the virtual camera starts | none |
| Virtual camera stopped | When the virtual camera stops | none |
| Destination degraded | When the live destination is reconnecting or losing packets | Destination, State, Packet loss (%), Bitrate (kb/s) |
| Destination recovered | When the live destination is healthy again | Destination |
| Mute changed | When a source is muted or unmuted | Source, Muted (On/Off) |
| Screenshot saved | When a screenshot is saved | File, Folder, File name, Of (program, scene or source name) |
| Chat message | When a chat message arrives | Platform, Who, Message, Its id on its platform (for Delete a chat message) |
| Activity | When a follow, sub, gift, support, redemption or raid arrives | Platform, Kind, Who, Text, Amount |
| Studio connected | When Velum Studio connects | Instance, Version |
| Studio disconnected | When Velum Studio disconnects or quits | Instance |
| Scene collection changed | When another scene collection opens | Collection open, Collection before |
| Recording paused | When the recording is paused | Recording length (h:mm:ss) |
| Recording resumed | When the recording resumes | Recording length (h:mm:ss) |
| Replay buffer started | When the replay buffer starts | Seconds it keeps |
| Replay buffer stopped | When the replay buffer stops | none |
| Replay saved | When a replay is saved | File, Folder, File name |
| Media changed | When a media source plays, pauses, stops, ends, goes on or off air, or moves to another item | Media source, State now, State before, Item playing, On air (On/Off) |
| Studio mode turned on or off | When studio mode turns on or off | Studio mode (On/Off) |
| Transition started | When a transition starts playing | Transition, Scene it goes to |
| Transition ended | When the transitions playing have finished | none |
| Update available | When a newer Studio is on offer | Version on offer |
| Update ready | When an update is downloaded and verified, ready to restart into | Version |
| Chat message deleted | When a chat message is deleted (from Studio, a button or the platform) | Platform, Who wrote it, Message, Deleted by, when the platform says |
| What Velora viewers get changed | When where a source's sound goes for Velora viewers changes | Source, Now (public, public_drop_vod, hidden_keep_vod, hidden_drop_vod, not_sent), Before, In the VOD (On/Off) |
| How Studio sends to Velora changed | When Studio switches between WHIP and VELoQ for Velora | Sends with (whip or veloq), Qualities over VELoQ |
States
Each of these is a Touch Portal state you can show with ${value:<state id>} or react to with When plug-in state changes. On top of them, the plug-in adds states for each thing in Studio as it appears: each scene's on-air and in-preview state, each layer's visibility, each effect and each of its settings, each source's mute, volume and tracks and what Velora viewers get from it, each audio folder and send, each destination's health and protocol, each media source, and each scene collection.
Velum Studio 4
| State id | Shows |
|---|---|
velumstudio.studio.connection | Velum Studio connection |
velumstudio.studio.instance | Velum Studio instance followed |
velumstudio.studio.version | Velum Studio version |
velumstudio.studio.last_error | Velum Studio last error |
Velum Studio: Scenes 9
| State id | Shows |
|---|---|
velumstudio.scenes.current | Scene on air |
velumstudio.scenes.previous | Scene on air before this one |
velumstudio.scenes.preview | Scene in preview (studio mode) |
velumstudio.scenes.count | Number of scenes |
velumstudio.scenes.list | Scenes (comma-separated, in list order) |
velumstudio.collections.current | Scene collection open |
velumstudio.collections.previous | Scene collection open before this one |
velumstudio.collections.list | Scene collections (comma-separated) |
velumstudio.collections.count | Number of scene collections |
Velum Studio: Stream 10
| State id | Shows |
|---|---|
velumstudio.stream.live | Live |
velumstudio.stream.state | Stream state |
velumstudio.stream.uptime | Stream uptime (h:mm:ss) |
velumstudio.stream.seconds | Stream uptime in seconds |
velumstudio.stream.destination | Live to (destination name) |
velumstudio.stream.viewers | Viewers (all platforms) |
velumstudio.destinations.selected | Selected destination |
velumstudio.vcam.on | Virtual camera |
velumstudio.destinations.live | Destinations live (comma-separated) |
velumstudio.destinations.live_count | Number of destinations live |
Velum Studio: Recording 5
| State id | Shows |
|---|---|
velumstudio.record.recording | Recording |
velumstudio.record.duration | Recording length (h:mm:ss) |
velumstudio.record.seconds | Recording length in seconds |
velumstudio.record.dropped | Recording: frames dropped |
velumstudio.record.paused | Recording paused |
Velum Studio: Stats 8
| State id | Shows |
|---|---|
velumstudio.stats.fps | Frames per second |
velumstudio.stats.kbps | Stream bitrate (kb/s) |
velumstudio.stats.loss | Stream packet loss (%) |
velumstudio.stats.rtt_ms | Stream round trip (ms) |
velumstudio.stats.reconnects | Stream reconnects |
velumstudio.stats.rendered | Frames rendered |
velumstudio.stats.lagged | Frames rendered late |
velumstudio.stats.dropped | Recording frames dropped |
Velum Studio: Screenshots 3
| State id | Shows |
|---|---|
velumstudio.screenshot.last_path | Last screenshot: file |
velumstudio.screenshot.last_folder | Last screenshot: folder |
velumstudio.screenshot.last_name | Last screenshot: file name |
Velum Studio: Stream info 4
| State id | Shows |
|---|---|
velumstudio.streaminfo.title | Stream title |
velumstudio.streaminfo.category | Stream category |
velumstudio.streaminfo.tags | Stream tags (comma-separated) |
velumstudio.dynamic.category | Dynamic Sources category |
Velum Studio: Chat 5
| State id | Shows |
|---|---|
velumstudio.chat.last.text | Last chat message |
velumstudio.chat.last.author | Last chat message: who |
velumstudio.chat.last.platform | Last chat message: platform |
velumstudio.chat.lit | Chats lit in Studio (comma-separated) |
velumstudio.chat.last.id | Last chat message: its id on its platform (for Delete a chat message) |
Velum Studio: Activity 5
| State id | Shows |
|---|---|
velumstudio.activity.last.kind | Last activity: kind (follow, sub, raid…) |
velumstudio.activity.last.author | Last activity: who |
velumstudio.activity.last.text | Last activity: text |
velumstudio.activity.last.amount | Last activity: amount |
velumstudio.activity.last.platform | Last activity: platform |
Velum Studio: Replay buffer 6
| State id | Shows |
|---|---|
velumstudio.replay.active | Replay buffer running |
velumstudio.replay.seconds | Replay buffer length it keeps (seconds) |
velumstudio.replay.buffered_seconds | Replay buffer: seconds a save would hold now |
velumstudio.replay.last_path | Last replay: file |
velumstudio.replay.last_folder | Last replay: folder |
velumstudio.replay.last_name | Last replay: file name |
Velum Studio: Transitions 6
| State id | Shows |
|---|---|
velumstudio.transitions.studio_mode | Studio mode |
velumstudio.transitions.current | Transition scene switches play |
velumstudio.transitions.duration_ms | Transition length (ms) |
velumstudio.transitions.in_progress | Transition playing |
velumstudio.transitions.saved | Saved transitions (comma-separated) |
velumstudio.transitions.error | Why the last stinger or shader transition couldn't play |
Velum Studio: Updates 10
| State id | Shows |
|---|---|
velumstudio.update.state | Update: state |
velumstudio.update.available | Update on offer |
velumstudio.update.version | Update: version on offer |
velumstudio.update.current_version | Update: Studio's version now |
velumstudio.update.latest | Update: newest version on the channel |
velumstudio.update.channel | Update: channel (stable, beta, internal) |
velumstudio.update.progress | Update: download progress (%) |
velumstudio.update.install_pending | Update: waiting to install (live, recording or replay buffer) |
velumstudio.update.waiting_for | Update: what a pending install waits for |
velumstudio.update.error | Update: why the last check or download failed |
Velum Studio: VELoQ 11
| State id | Shows |
|---|---|
velumstudio.veloq.protocol | Velora: sends with (whip or veloq) |
velumstudio.veloq.layers | Velora: qualities over VELoQ (1 to 4; empty: Studio's default, 2) |
velumstudio.veloq.sliders_used | Velora viewer sliders taken (sources and sends) |
velumstudio.veloq.slider_limit | Velora viewer sliders there are |
velumstudio.veloq.sliders | Velora viewer sliders (taken / there are) |
velumstudio.veloq.mixer_shown | Velora shows viewers the mixer (two or more sliders) |
velumstudio.veloq.transitions | Stinger sounds for Velora viewers |
velumstudio.veloq.vod_tracks | Tracks Velora's VOD keeps (comma-separated) |
velumstudio.veloq.not_sent | Sources that never leave Studio (comma-separated) |
velumstudio.veloq.groups | Audio folders and sends (comma-separated) |
velumstudio.veloq.groups_count | Number of audio folders and sends |
Velum Studio: Avatars 2
| State id | Shows |
|---|---|
velumstudio.avatars.feature | Avatars turned on in Studio (Settings › Advanced › Avatars) |
velumstudio.avatars.running | Lip-sync pairings running (comma-separated) |
A few patterns
- A scene button that lights up on air. On Pressed: Switch scene. Then an event, When plug-in state changes, on that scene's on-air state,
OnandOff, changing the button's background. - Push to talk. On the On Hold tab, Mute with Unmute and your mic: live while held, muted again on release.
- Safety. End stream, Clear chat, Ban or time out and the two Delete a message actions (by id, or the newest message, each press taking the one before) need their I'm sure switch; without it, pressing does nothing and Touch Portal shows a notification.
- What Velora viewers hear. The VELoQ actions set what viewers get from each source, its folder or send, where viewers' slider starts (also a slider) and its Editor+ stem, and states show each source's choice, the sliders taken out of eight, and how Studio sends to Velora. A button that lights while the music is out of the VOD: When plug-in state changes on that source's In the VOD state.

