Reference Sub actions Wave Link Legacy

Wave Link (legacy) sub-actions

Also on the Cuebot Docs site.

Get filter state

For Wave Link 1.x/2.x, the older version. Reads whether a filter on an input is on into variables for later steps. It also works with Wave Link 3.

Setting	What to put in
Input	The input (channel), by name as Wave Link shows it, like "Music", or by ID.
Filter	The filter, by name as Wave Link shows it on that input, or by ID.

Variables it adds

Variable	What it holds
%filter.active%	true if the filter is on
%filter.name%	The filter's name
%filter.id%	The filter's ID
%input.name%	The input's name

Type id: wavelink.legacy.getFilterState

Get input information

For Wave Link 1.x/2.x, the older version. Reads an input's mute, volume and filter bypass for both mixes into variables for later steps. It also works with Wave Link 3.

Setting	What to put in
Input	The input (channel), by name as Wave Link shows it, like "Music", or by ID.

Variables it adds

Variable	What it holds
%input.name%	The input's name
%input.identifier%	Its ID
%input.local.muted%	true if muted in the Monitor Mix
%input.local.volume%	Volume in the Monitor Mix (0-100)
%input.local.filterBypass%	true if filters are skipped in the Monitor Mix
%input.stream.muted%	true if muted in the Stream Mix
%input.stream.volume%	Volume in the Stream Mix (0-100)
%input.stream.filterBypass%	true if filters are skipped in the Stream Mix

Type id: wavelink.legacy.getInputInfo

Get microphone information

For Wave Link 1.x/2.x, the older version. Reads your microphone's settings into variables for later steps. It also works with Wave Link 3.

Setting	What to put in
Microphone	The microphone, by name or ID. Leave empty if you only have one.

Variables it adds

Variable	What it holds
%microphone.name%	The microphone's name
%microphone.gain%	Its gain
%microphone.outputVolume%	Its output volume
%microphone.balance%	Its balance (0-100)
%microphone.muted%	true if muted
%microphone.lowCut%	true if low cut is on
%microphone.clipGuard%	true if Clipguard is on
%microphone.gainLocked%	true if the gain is locked

Type id: wavelink.legacy.getMicrophoneInfo

Get output volumes

For Wave Link 1.x/2.x, the older version. Reads the volume of the Monitor Mix and the Stream Mix into variables for later steps. It also works with Wave Link 3.

Variables it adds

Variable	What it holds
%localVolume%	Monitor Mix volume (0-100)
%streamVolume%	Stream Mix volume (0-100)

Type id: wavelink.legacy.getOutputVolumes

Get selected output

For Wave Link 1.x/2.x, the older version. Reads which output device you listen on into variables for later steps. It also works with Wave Link 3.

Variables it adds

Variable	What it holds
%output.name%	The output device's name
%output.identifier%	Its ID

Type id: wavelink.legacy.getSelectedOutput

Mute input

For Wave Link 1.x/2.x, the older version. Mutes or unmutes an input in the Monitor Mix, the Stream Mix or both. It also works with Wave Link 3.

Setting	What to put in
Input	The input (channel), by name as Wave Link shows it, like "Music", or by ID.
Mixer	Which mix to change: Local is the Monitor Mix (what you hear), Stream is the Stream Mix (what viewers hear), Both changes both. Options: Both, Local, Stream. Starts as: Both.
State	Mute mutes it, Unmute unmutes it, Toggle flips it to the opposite of what it is now. Options: Mute, Unmute, Toggle. Starts as: Mute.

Variables it adds

Variable	What it holds
%input.muted%	true if muted after the change

Type id: wavelink.legacy.muteInput

Mute microphone

For Wave Link 1.x/2.x, the older version. Mutes or unmutes your microphone. It also works with Wave Link 3.

Setting	What to put in
Microphone	The microphone, by name or ID. Leave empty if you only have one.
State	Mute mutes it, Unmute unmutes it, Toggle flips it to the opposite of what it is now. Options: Mute, Unmute, Toggle. Starts as: Mute.

Variables it adds

Variable	What it holds
%microphone.muted%	true if muted after the change

Type id: wavelink.legacy.muteMicrophone

Mute output

For Wave Link 1.x/2.x, the older version. Mutes or unmutes the whole Monitor Mix or Stream Mix. It also works with Wave Link 3.

Setting	What to put in
Mixer	Which mix to change: Local is the Monitor Mix (what you hear), Stream is the Stream Mix (what viewers hear). Options: Local, Stream. Starts as: Local.
State	Mute mutes it, Unmute unmutes it, Toggle flips it to the opposite of what it is now. Options: Mute, Unmute, Toggle. Starts as: Mute.

Variables it adds

Variable	What it holds
%output.muted%	true if muted after the change

Type id: wavelink.legacy.muteOutput

Set filter bypass state

For Wave Link 1.x/2.x, the older version. Skips all filters on an input (bypass) or uses them again. Wave Link 3 does not have this.

Setting	What to put in
Input	The input (channel), by name as Wave Link shows it, like "Music", or by ID.
Mixer	Which mix to change: Local is the Monitor Mix (what you hear), Stream is the Stream Mix (what viewers hear), Both changes both. Options: Both, Local, Stream. Starts as: Both.
State	Bypassed skips the filters, Not Bypassed uses them, Toggle flips it to the opposite of what it is now. Options: Bypassed, Not Bypassed, Toggle. Starts as: Bypassed.

Variables it adds

Variable	What it holds
%input.filterBypass%	true if filters are skipped after the change

Type id: wavelink.legacy.setFilterBypass

Set filter state

For Wave Link 1.x/2.x, the older version. Switches one filter on an input on or off. It also works with Wave Link 3.

Setting	What to put in
Input	The input (channel), by name as Wave Link shows it, like "Music", or by ID.
Filter	The filter, by name as Wave Link shows it on that input, or by ID.
State	Enabled turns it on, Disabled turns it off, Toggle flips it to the opposite of what it is now. Options: Enabled, Disabled, Toggle. Starts as: Enabled.

Variables it adds

Variable	What it holds
%filter.active%	true if the filter is on after the change

Type id: wavelink.legacy.setFilterState

Set input volume

For Wave Link 1.x/2.x, the older version. Sets how loud an input is in the Monitor Mix, the Stream Mix or both. It also works with Wave Link 3.

Setting	What to put in
Input	The input (channel), by name as Wave Link shows it, like "Music", or by ID.
Mixer	Which mix to change: Local is the Monitor Mix (what you hear), Stream is the Stream Mix (what viewers hear), Both changes both. Options: Both, Local, Stream. Starts as: Both.
Volume (0-100)	Volume from 0 (silent) to 100 (loudest). With Relative change ticked, this is how much to add. Starts as: 100.
Add to current value	Tick to add your number to the current value instead of replacing it. Use a negative number to go down. Starts as: false.

Variables it adds

Variable	What it holds
%input.volume%	The volume after the change (0-100)

Type id: wavelink.legacy.setInputVolume

Set microphone balance

For Wave Link 1.x/2.x, the older version. Sets the microphone balance. It also works with Wave Link 3.

Setting	What to put in
Microphone	The microphone, by name or ID. Leave empty if you only have one.
Balance (0-100)	From 0 to 100, where 50 is the middle. With Relative change ticked, how much to add. Starts as: 50.
Add to current value	Tick to add your number to the current value instead of replacing it. Use a negative number to go down. Starts as: false.

Variables it adds

Variable	What it holds
%microphone.balance%	The balance after the change (0-100)

Type id: wavelink.legacy.setMicrophoneBalance

Set microphone gain

For Wave Link 1.x/2.x, the older version. Sets the microphone gain, which is how loudly it picks you up. It also works with Wave Link 3.

Setting	What to put in
Microphone	The microphone, by name or ID. Leave empty if you only have one.
Gain	The gain, using the microphone's own scale in Wave Link 1.x/2.x (on Wave Link 3 it is 0-100 percent). With Relative change ticked, how much to add. Starts as: 50.
Add to current value	Tick to add your number to the current value instead of replacing it. Use a negative number to go down. Starts as: false.

Variables it adds

Variable	What it holds
%microphone.gain%	The gain after the change

Type id: wavelink.legacy.setMicrophoneGain

Set microphone output volume

For Wave Link 1.x/2.x, the older version. Sets the microphone's output volume (what you hear of yourself). Wave Link 3 does not have this.

Setting	What to put in
Microphone	The microphone, by name or ID. Leave empty if you only have one.
Output volume	The volume, using the microphone's own scale. With Relative change ticked, how much to add. Starts as: 50.
Add to current value	Tick to add your number to the current value instead of replacing it. Use a negative number to go down. Starts as: false.

Variables it adds

Variable	What it holds
%microphone.outputVolume%	The volume after the change

Type id: wavelink.legacy.setMicrophoneOutputVolume

Set output monitor device

For Wave Link 1.x/2.x, the older version. Picks which output device (speakers or headphones) you listen on. It also works with Wave Link 3.

Setting	What to put in
Output device	The output device (speakers or headphones), by name or ID.

Variables it adds

Variable	What it holds
%output.name%	The new output device's name

Type id: wavelink.legacy.setOutputMonitorDevice

Set output volume

For Wave Link 1.x/2.x, the older version. Sets how loud the Monitor Mix or the Stream Mix is. It also works with Wave Link 3.

Setting	What to put in
Mixer	Which mix to change: Local is the Monitor Mix (what you hear), Stream is the Stream Mix (what viewers hear). Options: Local, Stream. Starts as: Local.
Volume (0-100)	Volume from 0 (silent) to 100 (loudest). With Relative change ticked, this is how much to add. Starts as: 100.
Add to current value	Tick to add your number to the current value instead of replacing it. Use a negative number to go down. Starts as: false.

Variables it adds

Variable	What it holds
%output.volume%	The volume after the change (0-100)

Type id: wavelink.legacy.setOutputVolume