Developer
Log in

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 example Velum 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

ActionOn the button
Switch scenePut scene [Scene] on air
Switch scene with a transitionPut scene [Scene] on air with [Transition]
Next scenePut the next scene on air (Scenes list order, wrapping around)
Previous scenePut the previous scene on air (Scenes list order, wrapping around)
Switch scene collectionOpen scene collection [Collection]

Layers 9

ActionOn the button
Show or hide a layerIn scene [Scene], [Mode] layer [Layer]
Clip a layer to the one belowIn scene [Scene], [Mode] clipping layer [Layer] to the layer below it
Restart a layerIn scene [Scene], restart layer [Layer] (its show and its video from the start)
Set a layer's opacityIn scene [Scene], set layer [Layer] to [Percent] % opacity (0 gone, 100 solid)
Raise or lower a layer's opacityIn scene [Scene], change layer [Layer]'s opacity by [Step] % (negative fades it out)
Copy a layer's styleIn scene [Scene], copy [Parts] from layer [From]
Apply a framingIn scene [Scene], move layer [Layer] to framing [Framing]
Nudge a layerIn scene [Scene], move layer [Layer] by [Dx] px right and [Dy] px down (negative: left or up)
Freeze when the scene comes on airIn scene [Scene], [Mode] Freeze when this scene comes on air for layer [Layer]

Effects 3

ActionOn the button
Turn an effect on or offOn [Owner], [Mode] effect [Filter]
Set an effect's settingOn [Owner], set effect [Filter]'s [Setting] to [Value]
Raise or lower an effect's settingOn [Owner], change effect [Filter]'s [Setting] by [Step] (negative lowers it)

Audio 12

ActionOn 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 volumeChange [Input] by [Step db] dB (negative lowers it)
MonitorMonitor [Input]: [Mode]
Audio track[Mode] [Track] for [Input]
Monitor bus[Bus]: [Enabled], volume [Volume percent] % (empty keeps it)
Monitor sendSend [Input] to [Bus] at [Percent] % (after its volume and mute)
Raise or lower a monitor sendChange [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 WindowsChange 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

ActionOn the button
Set textSet text source [Source] to [Text]
Point a MirrorMake Mirror [Mirror] show [Source]
Remove a source from all scenesRemove every layer of [Source] from every scene (the source stays)
Delete a source everywhereDelete [Source] and every layer of it (Undo in Studio puts it back)
Merge duplicate sourcesKeep [Keep] and merge into it [Merge] (names, separated by commas)
Media control[Action] media source [Source]
Seek a media sourceJump 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

ActionOn the button
Fire a source's actionOn [Source], fire [Setting]
Turn a source's setting on or off[Mode] [Setting] on [Source]
Choose a source setting's optionOn [Source], set [Setting] to [Option]
Set a source's settingOn [Source], set [Setting] to [Value] (a number, words, a color like #ff8800; a list separated by commas)
Raise or lower a source's settingOn [Source], change [Setting] by [Step] (negative lowers it)

Recording, streaming and virtual camera 20

ActionOn the button
ScreenshotScreenshot [Of]: scene [Scene], source [Source]
Start recordingStart recording
Stop recordingStop recording
Record (toggle)Start recording, or stop it if it's running
Go liveGo live to [Destination]
End streamEnd 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 destinationMake [Destination] where Go live sends
Start virtual cameraStart the virtual camera
Stop virtual cameraStop 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 bufferStart keeping the last seconds of what's on air (for Save replay)
Stop replay bufferStop the replay buffer (what it held is let go)
Replay buffer (toggle)Start the replay buffer, or stop it if it's running
Save replaySave the replay buffer's last seconds into [Folder] (empty: the replay buffer's folder)
Go live on a destinationGo live on [Destination] (beside the destinations already live; offline, on it alone)
End a destination's streamEnd 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

ActionOn the button
Set title and categoryTitle [Title]

Chat 6

ActionOn the button
Send a chat messageSend [Text] to [Platform]
Chat mode[Set] [Mode] on [Platform]
Ban or time out[Action] [User] on [Platform]
Clear chatClear [Platform] chat for everyone
Delete a chat messageDelete message [Message] on [Platform] for everyone (the message's id on its platform)
Delete the last chat messageDelete the newest chat message from [Platform] for everyone (press again for the one before)

Automations 3

ActionOn the button
Run an automationRun automation [Automation]
Set a variableSet variable [Name] to [Value] (empty forgets it)
Turn an automation on or off[Mode] automation [Automation]

Dynamic Sources 1

ActionOn the button
Set a Dynamic Sources variableSet Dynamic Sources [Variable] to [Value] (empty clears it)

Transitions and studio mode 6

ActionOn the button
Set the transitionScene switches play [Transition]
Set a scene's transitionComing on air, scene [Scene] plays [Transition] (Default clears its own)
Studio mode[Mode] studio mode
Preview a scenePut scene [Scene] in studio mode's preview (for the next Take)
TakePut the preview scene on air with its transition
Wait until the transition finishesHold the Velum Studio actions after this one until the scene transition finishes

Updates 2

ActionOn the button
Check for updatesAsk Studio's update channel whether there's a newer Studio (nothing is downloaded)
Install updateDownload and verify the update on offer (never while live, recording or keeping a replay buffer)

VELoQ: what Velora viewers hear 11

ActionOn the button
What Velora viewers get from a sourceVelora viewers get [Input]: [Visibility]
Where viewers' slider startsVelora 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 sendPut [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 viewersEvery stinger's sound for Velora viewers: [Visibility]
Smart defaults for Velora viewersGive [Input] its smart first choice for Velora viewers
New audio folder or sendMake a [Kind] named [Name]
Change an audio folder or sendChange [Group]: rename it [Name] (empty keeps the name)
Delete an audio folder or sendDelete [Group] (its sources stay, out of any folder)
Send to Velora withSend to Velora with [Protocol]

Avatars 1

ActionOn the button
Avatar lip sync[Mode] lip sync [Pairing] (Settings › Avatars in Studio)

Advanced 1

ActionOn the button
Raw requestCommit scene-model commands [Commands]

Velum Studio connection 1

ActionOn the button
Follow a Velum StudioFollow Velum Studio [Instance]

Sliders and dials

Connectors are two-way: moving the slider changes Studio, and a change in Studio moves the slider.

ConnectorConnectsOn
Volume (fader)Volume of [Input] on the mixer's faderslider
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 highestslider
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 endslider
Where viewers' slider starts (slider)Where Velora viewers' slider for [Input] starts, 0 to 100slider
Layer opacity (slider)Opacity of layer [Layer], 0 (gone) to 100 (solid)slider
Monitor send (slider)How much of [Input] [Bus] hears, 0 to 100slider
Monitor bus volume (slider)Volume of [Bus], 0 to 100slider
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 highestslider
Source setting (dial)Source setting [Setting] (set the dial to the setting's own range)dial
Scene by positionScene on air, by its place in the Scenes listslider

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

EventWhenLocal states
Scene changedWhen the scene on air changesScene on air, Scene before
Scene goes on air (by name)When the scene on air becomes $valnone
Scene leaves the air (by name)When the scene $val leaves the airnone
Went liveWhen the stream goes liveLive to
Went offlineWhen the stream endsStream length (h:mm:ss)
Recording startedWhen recording startsnone
Recording stoppedWhen recording stopsRecording length (h:mm:ss)
Virtual camera startedWhen the virtual camera startsnone
Virtual camera stoppedWhen the virtual camera stopsnone
Destination degradedWhen the live destination is reconnecting or losing packetsDestination, State, Packet loss (%), Bitrate (kb/s)
Destination recoveredWhen the live destination is healthy againDestination
Mute changedWhen a source is muted or unmutedSource, Muted (On/Off)
Screenshot savedWhen a screenshot is savedFile, Folder, File name, Of (program, scene or source name)
Chat messageWhen a chat message arrivesPlatform, Who, Message, Its id on its platform (for Delete a chat message)
ActivityWhen a follow, sub, gift, support, redemption or raid arrivesPlatform, Kind, Who, Text, Amount
Studio connectedWhen Velum Studio connectsInstance, Version
Studio disconnectedWhen Velum Studio disconnects or quitsInstance
Scene collection changedWhen another scene collection opensCollection open, Collection before
Recording pausedWhen the recording is pausedRecording length (h:mm:ss)
Recording resumedWhen the recording resumesRecording length (h:mm:ss)
Replay buffer startedWhen the replay buffer startsSeconds it keeps
Replay buffer stoppedWhen the replay buffer stopsnone
Replay savedWhen a replay is savedFile, Folder, File name
Media changedWhen a media source plays, pauses, stops, ends, goes on or off air, or moves to another itemMedia source, State now, State before, Item playing, On air (On/Off)
Studio mode turned on or offWhen studio mode turns on or offStudio mode (On/Off)
Transition startedWhen a transition starts playingTransition, Scene it goes to
Transition endedWhen the transitions playing have finishednone
Update availableWhen a newer Studio is on offerVersion on offer
Update readyWhen an update is downloaded and verified, ready to restart intoVersion
Chat message deletedWhen 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 changedWhen where a source's sound goes for Velora viewers changesSource, Now (public, public_drop_vod, hidden_keep_vod, hidden_drop_vod, not_sent), Before, In the VOD (On/Off)
How Studio sends to Velora changedWhen Studio switches between WHIP and VELoQ for VeloraSends 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 idShows
velumstudio.studio.connectionVelum Studio connection
velumstudio.studio.instanceVelum Studio instance followed
velumstudio.studio.versionVelum Studio version
velumstudio.studio.last_errorVelum Studio last error

Velum Studio: Scenes 9

State idShows
velumstudio.scenes.currentScene on air
velumstudio.scenes.previousScene on air before this one
velumstudio.scenes.previewScene in preview (studio mode)
velumstudio.scenes.countNumber of scenes
velumstudio.scenes.listScenes (comma-separated, in list order)
velumstudio.collections.currentScene collection open
velumstudio.collections.previousScene collection open before this one
velumstudio.collections.listScene collections (comma-separated)
velumstudio.collections.countNumber of scene collections

Velum Studio: Stream 10

State idShows
velumstudio.stream.liveLive
velumstudio.stream.stateStream state
velumstudio.stream.uptimeStream uptime (h:mm:ss)
velumstudio.stream.secondsStream uptime in seconds
velumstudio.stream.destinationLive to (destination name)
velumstudio.stream.viewersViewers (all platforms)
velumstudio.destinations.selectedSelected destination
velumstudio.vcam.onVirtual camera
velumstudio.destinations.liveDestinations live (comma-separated)
velumstudio.destinations.live_countNumber of destinations live

Velum Studio: Recording 5

State idShows
velumstudio.record.recordingRecording
velumstudio.record.durationRecording length (h:mm:ss)
velumstudio.record.secondsRecording length in seconds
velumstudio.record.droppedRecording: frames dropped
velumstudio.record.pausedRecording paused

Velum Studio: Stats 8

State idShows
velumstudio.stats.fpsFrames per second
velumstudio.stats.kbpsStream bitrate (kb/s)
velumstudio.stats.lossStream packet loss (%)
velumstudio.stats.rtt_msStream round trip (ms)
velumstudio.stats.reconnectsStream reconnects
velumstudio.stats.renderedFrames rendered
velumstudio.stats.laggedFrames rendered late
velumstudio.stats.droppedRecording frames dropped

Velum Studio: Screenshots 3

State idShows
velumstudio.screenshot.last_pathLast screenshot: file
velumstudio.screenshot.last_folderLast screenshot: folder
velumstudio.screenshot.last_nameLast screenshot: file name

Velum Studio: Stream info 4

State idShows
velumstudio.streaminfo.titleStream title
velumstudio.streaminfo.categoryStream category
velumstudio.streaminfo.tagsStream tags (comma-separated)
velumstudio.dynamic.categoryDynamic Sources category

Velum Studio: Chat 5

State idShows
velumstudio.chat.last.textLast chat message
velumstudio.chat.last.authorLast chat message: who
velumstudio.chat.last.platformLast chat message: platform
velumstudio.chat.litChats lit in Studio (comma-separated)
velumstudio.chat.last.idLast chat message: its id on its platform (for Delete a chat message)

Velum Studio: Activity 5

State idShows
velumstudio.activity.last.kindLast activity: kind (follow, sub, raid…)
velumstudio.activity.last.authorLast activity: who
velumstudio.activity.last.textLast activity: text
velumstudio.activity.last.amountLast activity: amount
velumstudio.activity.last.platformLast activity: platform

Velum Studio: Replay buffer 6

State idShows
velumstudio.replay.activeReplay buffer running
velumstudio.replay.secondsReplay buffer length it keeps (seconds)
velumstudio.replay.buffered_secondsReplay buffer: seconds a save would hold now
velumstudio.replay.last_pathLast replay: file
velumstudio.replay.last_folderLast replay: folder
velumstudio.replay.last_nameLast replay: file name

Velum Studio: Transitions 6

State idShows
velumstudio.transitions.studio_modeStudio mode
velumstudio.transitions.currentTransition scene switches play
velumstudio.transitions.duration_msTransition length (ms)
velumstudio.transitions.in_progressTransition playing
velumstudio.transitions.savedSaved transitions (comma-separated)
velumstudio.transitions.errorWhy the last stinger or shader transition couldn't play

Velum Studio: Updates 10

State idShows
velumstudio.update.stateUpdate: state
velumstudio.update.availableUpdate on offer
velumstudio.update.versionUpdate: version on offer
velumstudio.update.current_versionUpdate: Studio's version now
velumstudio.update.latestUpdate: newest version on the channel
velumstudio.update.channelUpdate: channel (stable, beta, internal)
velumstudio.update.progressUpdate: download progress (%)
velumstudio.update.install_pendingUpdate: waiting to install (live, recording or replay buffer)
velumstudio.update.waiting_forUpdate: what a pending install waits for
velumstudio.update.errorUpdate: why the last check or download failed

Velum Studio: VELoQ 11

State idShows
velumstudio.veloq.protocolVelora: sends with (whip or veloq)
velumstudio.veloq.layersVelora: qualities over VELoQ (1 to 4; empty: Studio's default, 2)
velumstudio.veloq.sliders_usedVelora viewer sliders taken (sources and sends)
velumstudio.veloq.slider_limitVelora viewer sliders there are
velumstudio.veloq.slidersVelora viewer sliders (taken / there are)
velumstudio.veloq.mixer_shownVelora shows viewers the mixer (two or more sliders)
velumstudio.veloq.transitionsStinger sounds for Velora viewers
velumstudio.veloq.vod_tracksTracks Velora's VOD keeps (comma-separated)
velumstudio.veloq.not_sentSources that never leave Studio (comma-separated)
velumstudio.veloq.groupsAudio folders and sends (comma-separated)
velumstudio.veloq.groups_countNumber of audio folders and sends

Velum Studio: Avatars 2

State idShows
velumstudio.avatars.featureAvatars turned on in Studio (Settings › Advanced › Avatars)
velumstudio.avatars.runningLip-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, On and Off, 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.

to open · ↑ ↓ to move · Esc to close