Developer
Log in

Integrations

Companion

The Companion module builds its actions from the running Studio's own catalog, lights buttons from Studio's pushes, and keeps a preset library made from what your Studio has right now.

Preset buttons, as Companion 5.0.7 drew them
Preset buttons, as Companion 5.0.7 drew them

At a glance

  • Version 0.2.0.
  • Module id: velum-studio, for Companion 5.0 and later.
  • Built on the TypeScript SDK, so it speaks the control API exactly as your own code would.
  • Three ways to reach Studio: this computer through the discovery file (the default; nothing to type), this computer with the port and token typed in (for Companion running as another user or in a container), or another computer through pairing.
  • Tokens stay secret. They're never logged or put in a variable, and typed-in and paired tokens live in Companion's secrets.
  • A newer Studio's new actions appear when the module connects to it, without updating the module.

Actions

Every catalog action that suits a button becomes a Companion action, with its id's dots turned into underscores. This list is generated from Studio's catalog with the module's own rule:

Companion action idNameCatalog id
scene_switchSwitch scenescene.switch
scene_nextNext scenescene.next
scene_previousPrevious scenescene.previous
vertical_pinPin the vertical canvasvertical.pin
layer_visibilityShow or hide a layerlayer.visibility
layer_restartRestart a layerlayer.restart
layer_freeze_on_airFreeze when its scene comes on airlayer.freeze_on_air
layer_copy_styleCopy a layer's style to anotherlayer.copy_style
layer_opacityLayer opacitylayer.opacity
layer_clipClip to the layer belowlayer.clip
filter_toggleTurn an effect on or offfilter.toggle
filter_setSet an effect's settingfilter.set
layer_framingApply a framinglayer.framing
layer_nudgeNudge a layerlayer.nudge
audio_muteMuteaudio.mute
audio_volumeVolumeaudio.volume
audio_monitorMonitoraudio.monitor
audio_monitor_whenMonitor whenaudio.monitor_when
audio_monitor_busMonitor busaudio.monitor_bus
audio_monitor_sendMonitor sendaudio.monitor_send
audio_app_volumeApp volume in Windowsaudio.app_volume
audio_trackAudio trackaudio.track
veloq_visibilityWhat viewers getveloq.visibility
veloq_viewer_startWhere viewers startveloq.viewer_start
veloq_stemEditor+ stemveloq.stem
veloq_groupPut in a folder or sendveloq.group
veloq_slider_orderWho gets a slider firstveloq.slider_order
veloq_transitionsStinger sounds for viewersveloq.transitions
veloq_smart_defaultsSmart defaultsveloq.smart_defaults
veloq_create_groupNew audio folder or sendveloq.create_group
veloq_update_groupChange an audio folder or sendveloq.update_group
veloq_delete_groupDelete an audio folder or sendveloq.delete_group
veloq_send_withSend to Velora withveloq.send_with
source_copy_settingsCopy a source's settings to anothersource.copy_settings
source_record_separatelyRecord this source separatelysource.record_separately
source_setSet a source's settingsource.set
source_triggerTrigger a source's actionsource.trigger
text_setSet texttext.set
source_remove_from_all_scenesRemove a source from all scenessource.remove_from_all_scenes
source_delete_everywhereDelete a source everywheresource.delete_everywhere
source_mergeMerge duplicate sourcessource.merge
mirror_showPoint a Mirrormirror.show
capture_targetsWhat a capture can showcapture.targets
capture_setSwitch what a capture showscapture.set
media_controlMedia controlmedia.control
media_speedMedia speedmedia.speed
output_screenshotScreenshotoutput.screenshot
record_startStart recordingrecord.start
record_stopStop recordingrecord.stop
record_toggleRecordrecord.toggle
record_pausePause recordingrecord.pause
replay_startStart replay bufferreplay.start
replay_stopStop replay bufferreplay.stop
replay_toggleReplay bufferreplay.toggle
replay_saveSave replayreplay.save
stream_goliveGo livestream.golive
stream_stopEnd streamstream.stop
destination_selectSelect destinationdestination.select
destination_startGo live on a destinationdestination.start
destination_stopEnd a destination's streamdestination.stop
destination_reconnectReconnect a destinationdestination.reconnect
destination_audioAudio sentdestination.audio
vcam_startStart virtual cameravcam.start
vcam_stopStop virtual cameravcam.stop
vcam_toggleVirtual cameravcam.toggle
vcam_sourceVirtual camera sourcevcam.source
ndi_startStart NDI® outputndi.start
ndi_stopStop NDI® outputndi.stop
ndi_toggleNDI® outputndi.toggle
source_ndi_sendSend a source over NDI®source.ndi_send
streaminfo_applySet title and categorystreaminfo.apply
raid_targetsWho's live to raidraid.targets
raid_startRaidraid.start
raid_cancelCancel raidraid.cancel
captions_sendSend closed captionscaptions.send
chat_sendSend a chat messagechat.send
chat_modeChat modechat.mode
chat_clearClear chatchat.clear
automation_runRun an automationautomation.run
automation_enableTurn an automation on or offautomation.enable
variable_setSet a variablevariable.set
avatar_lipsyncAvatar lip syncavatar.lipsync
dynamic_set_variableSet a Dynamic Sources variabledynamic.set_variable
collection_switchSwitch scene collectioncollection.switch
transition_setSet the transitiontransition.set
transition_waitWait until the transition finishestransition.wait
scene_transition_overrideSet a scene's transitionscene.transition_override
studio_modeStudio modestudio.mode
scene_previewPreview a scenescene.preview
studio_takeTakestudio.take
gpu_draw_onDraw scenes ongpu.draw_on
gpu_encode_onEncode ongpu.encode_on
network_stream_onStream on network cardnetwork.stream_on
update_checkCheck for updatesupdate.check
update_installInstall updateupdate.install
raw_transactionRaw requestraw.transaction

Left out on purpose: chat.moderate, chat.delete, chat.emotes.

Lists (scenes, sources, layers, effects, audio, audio folders and sends, media, automations, destinations, collections) are filled from your Studio; you can also type a name, or use a Companion variable or expression. Learn works on Volume, Set text and Set an effect's setting.

Feedbacks

From the module's own help:

Each feedback has a default look in Velum's palette, and you can change it:

  • Scenes: scene on air (gold), scene in preview (green), and Tally (on air and preview in one; Velum gold or broadcast red).
  • Stream: live (red), state is (connecting, live, reconnecting, offline, refused), Status (red with LIVE and the uptime, amber while starting or reconnecting), destination selected, destination live.
  • Recording: recording (red), paused (amber), Status (red with REC and the length, amber while paused). Replay buffer running, virtual camera on.
  • Transitions: studio mode on, transition playing.
  • Audio: muted (red), monitoring, on a track.
  • Effects and layers: effect on, layer visible, layer freezes on air, layer in a framing.
  • VELoQ: what viewers get (a slider, in the VOD, sent at all, or one exact choice), viewers' slider starts muted (red), recorded as its own stem, in a folder or send (one, or any), stinger sounds for viewers. Velora sent with VELoQ or WHIP (and with how many qualities).
  • Other: automation on, collection open, media state is, chat mode on, update on offer, Studio connected.
  • Stats warning (amber): frames dropped while recording, frames rendered late, or stream reconnects within the last few seconds (10 by default); packet loss over a percentage; round trip over some milliseconds; frame rate under a number.

Variables

From the module's own help. Use them in button text as $(velum:name), with your connection's label in place of velum.

Use them in button text as $(velum:name) (with your connection's label in place of velum).

Variable What
scene_program, scene_preview, scene_count The scene on air, the preview scene, how many scenes
studio_mode, transition, transition_duration_ms, transition_playing Studio mode and the transition
stream_state, stream_live, stream_time, stream_seconds, destination The stream: state, uptime (h:mm:ss), where it goes
viewers, viewers_velora, viewers_twitch, viewers_kick, viewers_youtube, viewers_owncast, viewers_rumble Viewers, in total and per platform, while live
record_state, recording, record_time, record_seconds, record_dropped The recording: recording, paused or off, its length (paused time left out)
replay_active, replay_buffered_seconds, last_replay The replay buffer and the newest saved replay
last_screenshot, vcam_on The newest screenshot's path, the virtual camera
fps, frames_rendered, frames_lagged, dropped_frames Frame rate and frame counts
bitrate, bitrate_kbps, packet_loss, rtt_ms, reconnects Stream health while live
stream_title, stream_category, stream_tags, dynamic_title, dynamic_category Stream info and Dynamic Sources
collection, media_playing The open scene collection; media sources playing
audio_<name>_volume, audio_<name>_volume_db, audio_<name>_fader, audio_<name>_muted Each source with sound, by its name (for example audio_mic_volume)
audio_<name>_viewers, audio_<name>_viewer_start, audio_<name>_viewer_muted, audio_<name>_folder, audio_<name>_stem, audio_<name>_slider_order Each source over VELoQ: what viewers get, where their slider starts (0 to 100) and whether muted, its folder or send, its own stem, its place for a slider
audio_group_<name>_kind, audio_group_<name>_sources, audio_group_<name>_count, audio_group_count Each audio folder or send: folder or send, its sources; how many there are
veloq_sliders, veloq_sliders_used, veloq_slider_limit, veloq_tracks, veloq_mixer_shown, veloq_transitions VELoQ: viewer sliders taken (3/8), tracks a Go Live sends, whether Velora shows viewers the mixer, where stinger sounds go
velora_send_with, velora_layers, destination_protocol How Studio sends to Velora (whip or veloq, and qualities); how the selected destination is sent (whip, veloq, rtmps, rtmp or srt)
update_state, update_available, update_version Updates
connection, studio_name, studio_version, catalog_version, studio_scopes The connection, and what it may do (a paired device has only the scopes Studio gave it)

Studio doesn't report CPU use through its control API, so there's no CPU variable.

The preset library

Open Presets › Velum Studio and drag buttons onto your pages. The library is built from what your Studio has right now (your scenes, sources, layers and effects) and updates as you add and rename things. End stream and Clear chat are on a two-second hold, so a tap does nothing. VELoQ: what Velora viewers hear has buttons for each source's choice for VELoQ viewers, the stinger sounds and how Studio sends to Velora; Updates checks for and installs Studio updates.

How it stays current

The module follows every topic except meters and activity. Each push replaces that topic, re-checks only the feedbacks that read it, and updates the variables, batched at 100 ms. When a list a picker shows changes (a scene added or renamed), actions, feedbacks and presets are rebuilt once things settle; a plain state change, such as a mute, never rebuilds them. While Studio isn't connected, every feedback is off and state variables are empty: never stale.

to open · ↑ ↓ to move · Esc to close