Wave Link triggers¶
Channel effects changed¶
Runs when an effect on a Wave Link channel is switched on or off or added or removed. Also fires for Wave Link 1.x/2.x filters.
| Setting | What to put in |
|---|---|
| Channels | Which channel to watch: its name as Wave Link shows it, like "Music", or its ID. Separate several with commas. Leave empty for every channel. |
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkChannelName% |
The channel's name |
%waveLinkChannelId% |
The channel's ID |
%waveLinkChannelMuted% |
true if the whole channel is muted |
%waveLinkChannelVolume% |
The channel's volume (0-100) |
%waveLinkEffectName% |
The effect that changed |
%waveLinkEffectEnabled% |
true if that effect is on now |
Type id: wavelink.channelEffectsChanged
Channel mute changed¶
Runs when a channel (or one of its mixes) is muted or unmuted in Wave Link. Handy for an on-screen 'music muted' sign.
| Setting | What to put in |
|---|---|
| Channels | Which channel to watch: its name as Wave Link shows it, like "Music", or its ID. Separate several with commas. Leave empty for every channel. |
| Mixes | Only react to this mix, like "Stream Mix". Separate several with commas. Leave empty to react to any mix, and to changes of the whole channel. |
| State | Muted: only when it became muted. Not muted: only when it became unmuted. Any: both. Options: Any, Muted, Not muted. Starts as: Any. |
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkChannelName% |
The channel's name |
%waveLinkChannelId% |
The channel's ID |
%waveLinkChannelMuted% |
true if the whole channel is muted |
%waveLinkChannelVolume% |
The channel's volume (0-100) |
%waveLinkScope% |
channel if the whole channel changed, mix if only one of its mixes changed |
%waveLinkMixName% |
The mix that changed (only when waveLinkScope is mix) |
%waveLinkMuted% |
true if it is muted now, false if not |
Type id: wavelink.channelMuteChanged
Channel updated¶
Runs when anything about a Wave Link channel changes, such as its volume, mute or effects. It runs alongside the more exact triggers.
| Setting | What to put in |
|---|---|
| Channels | Which channel to watch: its name as Wave Link shows it, like "Music", or its ID. Separate several with commas. Leave empty for every channel. |
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkChannelName% |
The channel's name |
%waveLinkChannelId% |
The channel's ID |
%waveLinkChannelMuted% |
true if the whole channel is muted |
%waveLinkChannelVolume% |
The channel's volume (0-100) |
Type id: wavelink.channelUpdated
Channel volume changed¶
Runs when the volume of a channel (or of one of its mixes) changes in Wave Link.
| Setting | What to put in |
|---|---|
| Channels | Which channel to watch: its name as Wave Link shows it, like "Music", or its ID. Separate several with commas. Leave empty for every channel. |
| Mixes | Only react to this mix, like "Stream Mix". Separate several with commas. Leave empty to react to any mix, and to changes of the whole channel. |
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkChannelName% |
The channel's name |
%waveLinkChannelId% |
The channel's ID |
%waveLinkChannelMuted% |
true if the whole channel is muted |
%waveLinkChannelVolume% |
The channel's volume (0-100) |
%waveLinkScope% |
channel if the whole channel changed, mix if only one of its mixes changed |
%waveLinkMixName% |
The mix that changed (only when waveLinkScope is mix) |
%waveLinkVolume% |
The new volume (0-100) |
%waveLinkPreviousVolume% |
The volume before the change |
Type id: wavelink.channelVolumeChanged
Channels changed¶
Runs when channels are added or removed in Wave Link, so the list of channels is different.
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkChannelsCount% |
How many channels there are now |
Type id: wavelink.channelsChanged
Connected¶
Runs when Cuebot connects to Wave Link. It works with Wave Link 3 and the older 1.x/2.x. Wave Link only exists on Windows and macOS.
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkApi% |
3 for Wave Link 3, legacy for Wave Link 1.x/2.x |
%waveLinkPort% |
The port Cuebot connected on |
Type id: wavelink.connected
Create profile requested¶
Runs when Wave Link 3 asks to create a new profile. The variables say what kind of device it is for and which mixes it lists.
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkDeviceType% |
The kind of device the profile is for |
%waveLinkProfileMixes% |
The mixes listed, separated by commas |
%waveLinkProfileMixesCount% |
How many mixes are listed |
Type id: wavelink.createProfileRequested
Disconnected¶
Runs when Cuebot loses or ends its connection to Wave Link, for example when you close Wave Link.
Variables you get
| Variable | What it holds |
|---|---|
%reason% |
Why the connection ended |
Type id: wavelink.disconnected
DSP effects changed¶
Runs when a built-in effect of a microphone or input device changes (like Clipguard or low cut).
| Setting | What to put in |
|---|---|
| Input devices | Which microphone or other input device to watch, by name or ID. Separate several with commas. Leave empty for every input device. |
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkInputDeviceName% |
The input device's name |
%waveLinkEffectName% |
The effect that changed |
%waveLinkEffectEnabled% |
true if that effect is on now |
Type id: wavelink.inputDspEffectsChanged
Focused app changed¶
Runs when the program you are using (the one in front) changes, as Wave Link 3 sees it. Handy for routing that program's sound to a channel.
| Setting | What to put in |
|---|---|
| Applications | Which program to react to, by name or ID, like "Spotify". Separate several with commas. Leave empty for any program. |
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkAppName% |
The program's name |
%waveLinkAppId% |
The program's ID |
%waveLinkChannelName% |
The channel the program plays on, if any |
Type id: wavelink.focusedAppChanged
Input device updated¶
Runs when anything about an input device (like your microphone) changes, such as its mute, gain or balance.
| Setting | What to put in |
|---|---|
| Input devices | Which microphone or other input device to watch, by name or ID. Separate several with commas. Leave empty for every input device. |
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkInputDeviceName% |
The input device's name |
%waveLinkInputDeviceMuted% |
true if it is muted |
%waveLinkInputDeviceGain% |
Its gain (microphone loudness) |
%waveLinkInputDeviceMicPcMix% |
Its mic/PC balance (0-100) |
%waveLinkInputDeviceOutputVolume% |
Its output volume, if Wave Link has one |
Type id: wavelink.inputDeviceUpdated
Input devices changed¶
Runs when input devices (like microphones) are added or removed in Wave Link.
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkInputDevicesCount% |
How many input devices there are now |
Type id: wavelink.inputDevicesChanged
Input gain changed¶
Runs when the gain (how loud the microphone picks you up) of an input device changes.
| Setting | What to put in |
|---|---|
| Input devices | Which microphone or other input device to watch, by name or ID. Separate several with commas. Leave empty for every input device. |
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkInputDeviceName% |
The input device's name |
%waveLinkInputDeviceGain% |
The new gain |
%waveLinkPreviousGain% |
The gain before the change |
Type id: wavelink.inputGainChanged
Level meter updated¶
Runs while Wave Link reports sound levels. Switch level meters on at the Wave Link page first; they are off by default. Cuebot limits how often this runs.
| Setting | What to put in |
|---|---|
| Meter | Which kind of meter to watch: a channel, a mix, an input device or an output device. Any means all of them. Level meters must be switched on first (see below). Options: Any, Channel, Mix, Input, Output. Starts as: Any. |
| Meter names | Names or IDs of the meters to watch, separated by commas. Leave empty for every meter. |
| Minimum level (0-100) | Only run when the meter is at least this loud, from 0 (silent) to 100 (loudest). Leave empty to ignore how loud it is. |
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkLevelName% |
The name of the loudest matching meter |
%waveLinkLevelType% |
Its kind: channel, mix, input or output |
%waveLinkLevelLeft% |
Left loudness (0-100) |
%waveLinkLevelRight% |
Right loudness (0-100) |
%waveLinkLevelPeak% |
The louder of left and right (0-100) |
%waveLinkLevelsCount% |
How many meters moved |
Type id: wavelink.levelMeter
Main output device changed¶
Runs when you pick a different main output device in Wave Link, the one you listen on.
| Setting | What to put in |
|---|---|
| Output devices | Which output device (speakers or headphones) to watch, by name or ID. Separate several with commas. Leave empty for every output device. |
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkOutputDeviceName% |
The new main output device |
%waveLinkOutputDeviceId% |
Its ID |
%waveLinkPreviousOutputDeviceId% |
The ID of the one before |
Type id: wavelink.mainOutputChanged
Mix updated¶
Runs when a mix is muted, unmuted or has its volume changed in Wave Link.
| Setting | What to put in |
|---|---|
| Mixes | Which mix to watch, by name or ID. Separate several with commas. Leave empty for every mix. |
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkMixName% |
The mix's name |
%waveLinkMixMuted% |
true if it is muted |
%waveLinkMixVolume% |
Its volume (0-100) |
%waveLinkPreviousVolume% |
The volume before the change |
%waveLinkMuteChanged% |
true if the mute changed |
%waveLinkVolumeChanged% |
true if the volume changed |
Type id: wavelink.mixUpdated
Mixes changed¶
Runs when mixes are added or removed in Wave Link.
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkMixesCount% |
How many mixes there are now |
Type id: wavelink.mixesChanged
Output device updated¶
Runs when an output device (speakers or headphones) changes in Wave Link, such as its volume, mute or mix.
| Setting | What to put in |
|---|---|
| Output devices | Which output device (speakers or headphones) to watch, by name or ID. Separate several with commas. Leave empty for every output device. |
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkOutputDeviceName% |
The output device's name |
%waveLinkOutputVolume% |
Its volume (0-100) |
%waveLinkOutputMuted% |
true if it is muted |
%waveLinkOutputMixName% |
The mix it plays |
Type id: wavelink.outputDeviceUpdated
Output mix changed¶
Runs when an output device is set to play a different mix in Wave Link (Wave Link 1.x/2.x: when you switch between Monitor Mix and Stream Mix).
| Setting | What to put in |
|---|---|
| Output devices | Which output device (speakers or headphones) to watch, by name or ID. Separate several with commas. Leave empty for every output device. |
| Mixes | Only react when the output switched to this mix, by name or ID. Separate several with commas. Leave empty for any mix. |
Variables you get
| Variable | What it holds |
|---|---|
%waveLinkOutputDeviceName% |
The output device |
%waveLinkOutputMixName% |
The mix it plays now |
%waveLinkPreviousMixName% |
The mix it played before (Wave Link 3) |
%waveLinkPreviousMixId% |
The ID of the mix it played before |
Type id: wavelink.outputMixChanged