GoXLR sub-actions¶
Cough / mic mute¶
Mutes or unmutes your microphone with the Cough button (on a GoXLR Mini this is the mic mute button).
| Setting | What to put in |
|---|---|
| State | Mute silences it, using the mute button's own setting (for example only to the stream). Mute to all silences it everywhere. Unmute turns the sound back on. Toggle flips the current state. Options: Mute, Mute to all, Unmute, Toggle. Starts as: Toggle. |
Variables it adds
| Variable | What it holds |
|---|---|
%goXlrMuteState% |
The new state: Unmuted, MutedToX or MutedToAll |
%goXlrMuted% |
True when the mic is muted now |
Type id: goxlr.setCoughMute
Get status¶
Reads the current state of your GoXLR (volumes, mutes, effects, sampler) into variables you can use in later steps.
| Setting | What to put in |
|---|---|
| Device serial | Which GoXLR to control, by serial number. Leave empty to use the one chosen on the GoXLR page (or the first one found). |
Variables it adds
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The GoXLR's serial number |
%goXlrProfile% |
The loaded profile |
%goXlrMicProfile% |
The loaded mic profile |
%goXlrVolumeMusic% |
The Music volume, 0 to 100 (the same for other channels, like goXlrVolumeGame) |
%goXlrFaderAChannel% |
The channel on fader A (the same for B, C and D) |
%goXlrFaderAMuted% |
True when fader A is muted (the same for B, C and D) |
%goXlrFaderAVolume% |
The volume of fader A's channel, 0 to 100 |
%goXlrCoughMuted% |
True when the Cough button has the mic muted |
%goXlrFxEnabled% |
True when FX is on (also goXlrMegaphoneEnabled, goXlrRobotEnabled, goXlrHardTuneEnabled) |
%goXlrPreset% |
The active effect preset slot |
%goXlrBank% |
The active sampler bank |
Type id: goxlr.getStatus
Load effect preset from library¶
Loads a preset saved in the GoXLR Utility's library into the effect preset that is active now. Needs a full-size GoXLR.
| Setting | What to put in |
|---|---|
| Library preset | The name of the saved preset, as the GoXLR Utility shows it. |
Type id: goxlr.loadEffectPreset
Load mic profile¶
Loads a saved mic profile, which holds your microphone sound settings such as equalizer and compressor.
| Setting | What to put in |
|---|---|
| Mic profile | The mic profile name as the GoXLR Utility shows it, like "Podcast". |
| Remember | Tick to make the GoXLR Utility load this one again the next time it starts, like choosing it there yourself. Untick to use it only for now. Starts as: true. |
Type id: goxlr.loadMicProfile
Load profile¶
Loads a saved GoXLR profile, which holds all your mixer settings. Handy to switch between a streaming and a chatting setup.
| Setting | What to put in |
|---|---|
| Profile | The profile name as the GoXLR Utility shows it, like "Streaming". |
| Remember | Tick to make the GoXLR Utility load this one again the next time it starts, like choosing it there yourself. Untick to use it only for now. Starts as: true. |
Type id: goxlr.loadProfile
Mute fader¶
Mutes, unmutes or toggles one of the four GoXLR faders. Handy for a hotkey that silences your music or game sound.
| Setting | What to put in |
|---|---|
| Fader or channel | The fader (A, B, C or D) or the channel on it, like "Music". The channel must be on a fader. Starts as: A. |
| State | Mute silences it, using the mute button's own setting (for example only to the stream). Mute to all silences it everywhere. Unmute turns the sound back on. Toggle flips the current state. Options: Mute, Mute to all, Unmute, Toggle. Starts as: Toggle. |
Variables it adds
| Variable | What it holds |
|---|---|
%goXlrFader% |
The fader letter that was changed |
%goXlrChannel% |
The channel on that fader |
%goXlrMuteState% |
The new state: Unmuted, MutedToX or MutedToAll |
%goXlrMuted% |
True when it is muted now |
Type id: goxlr.setFaderMute
Play sample¶
Plays or stops a sound on a GoXLR sampler button. Handy for a sound effect when someone redeems a reward. Needs a full-size GoXLR.
| Setting | What to put in |
|---|---|
| Bank | Which bank to use. Active means the bank selected now; or choose A, B or C. Options: Active, A, B, C. Starts as: Active. |
| Button | Which of the four sampler buttons to use. Options: Top Left, Top Right, Bottom Left, Bottom Right. Starts as: Top Left. |
| Mode | Play next plays the button's next sound. Play by index plays the sound number you choose. Stop stops what that button is playing. Options: Play next, Play by index, Stop. Starts as: Play next. |
| Sample index | Only for Play by index: which sound on the button, where 1 is the first. Ignored in the other modes. Starts as: 1. |
Variables it adds
| Variable | What it holds |
|---|---|
%goXlrBank% |
The bank that was used |
%goXlrSampleButton% |
The sampler button that was used |
Type id: goxlr.playSample
Select effect preset¶
Picks one of the six effect presets (saved voice effect setups). Needs a full-size GoXLR.
| Setting | What to put in |
|---|---|
| Preset | A number from 1 to 6, or the preset's name. Starts as: 1. |
Variables it adds
| Variable | What it holds |
|---|---|
%goXlrPreset% |
The chosen preset slot, like "Preset2" |
Type id: goxlr.setEffectPreset
Select sampler bank¶
Switches the sampler to bank A, B or C. Each bank holds its own sounds. Needs a full-size GoXLR.
| Setting | What to put in |
|---|---|
| Bank | The bank to switch to: A, B or C. Options: A, B, C. Starts as: A. |
Type id: goxlr.setSamplerBank
Send raw command¶
For experts: sends your own command to the GoXLR Utility. Most people never need this, because the other GoXLR steps cover everything common.
| Setting | What to put in |
|---|---|
| Command (JSON) | The command written in the GoXLR Utility's data format, like {"SetFXEnabled": true}. See the GoXLR Utility's own documentation for the list. Starts as: {"SetVolume": ["Music", 128]}. |
| Device serial | Which GoXLR to control, by serial number. Leave empty to use the one chosen on the GoXLR page (or the first one found). |
| Raw request | Tick only if your command is a complete request for the utility, not a command for one GoXLR. Leave unticked for normal commands. Starts as: false. |
Variables it adds
| Variable | What it holds |
|---|---|
%goXlrResponse% |
The utility's answer as text |
Type id: goxlr.sendCommand
Set button colours¶
Sets the light colour of a GoXLR button, for when it is on and (if you want) when it is off.
| Setting | What to put in |
|---|---|
| Button | Which button to colour. Options: Fader 1 Mute, Fader 2 Mute, Fader 3 Mute, Fader 4 Mute, Bleep, Cough, Effect Select 1, Effect Select 2, Effect Select 3, Effect Select 4, Effect Select 5, Effect Select 6, Effect Fx, Effect Megaphone, Effect Robot, Effect Hard Tune, Sampler Select A, Sampler Select B, Sampler Select C, Sampler Top Left, Sampler Top Right, Sampler Bottom Left, Sampler Bottom Right, Sampler Clear. Starts as: Cough. |
| On colour | The colour when the button is on. A colour as a hex code, like #FF8800 (orange). The # is optional. Starts as: #00FFFF. |
| Off colour | The colour when the button is off, as a hex code like #000000. Leave empty to keep the current one. |
Type id: goxlr.setButtonColours
Set effect on/off¶
Turns a voice effect on or off. Handy for a robot voice reward.
| Setting | What to put in |
|---|---|
| Effect | Which effect: FX, Megaphone, Robot or Hard Tune. FX is the main effects switch. Needs a full-size GoXLR. Options: FX, Megaphone, Robot, Hard Tune. Starts as: FX. |
| State | On turns it on, Off turns it off, Toggle flips it. Options: On, Off, Toggle. Starts as: Toggle. |
Variables it adds
| Variable | What it holds |
|---|---|
%goXlrEffect% |
The effect that was changed |
%goXlrEnabled% |
True when the effect is on now |
Type id: goxlr.setEffect
Set fader channel¶
Changes which channel a fader controls, for example to put Music on fader B.
| Setting | What to put in |
|---|---|
| Fader | Which fader: A, B, C or D. Options: A, B, C, D. Starts as: A. |
| Channel | The channel to put on the fader: Mic, Line In, Console, System, Game, Chat, Sample, Music, Headphones, Mic Monitor or Line Out. |
Type id: goxlr.setFaderChannel
Set fader colours¶
Sets the two light colours of a fader, the top and the bottom.
| Setting | What to put in |
|---|---|
| Fader | Which fader: A, B, C or D. Options: A, B, C, D. Starts as: A. |
| Top colour | A colour as a hex code, like #FF8800 (orange). The # is optional. Starts as: #00FFFF. |
| Bottom colour | A colour as a hex code, like #FF8800 (orange). The # is optional. Starts as: #000000. |
Type id: goxlr.setFaderColours
Set fader mute function¶
Chooses where a fader's mute button silences the sound, for example only on the stream but not in your headphones.
| Setting | What to put in |
|---|---|
| Fader | Which fader: A, B, C or D. Options: A, B, C, D. Starts as: A. |
| Mute function | Where muting applies. All mutes everywhere. The To options mute only that output, such as To Stream or To Phones (your headphones). Options: All, To Stream, To Voice Chat, To Phones, To Line Out, To Stream 2, To Streams. Starts as: All. |
Type id: goxlr.setFaderMuteFunction
Set global colour¶
Sets the main light colour of your GoXLR.
| Setting | What to put in |
|---|---|
| Colour | A colour as a hex code, like #FF8800 (orange). The # is optional. Starts as: #00FFFF. |
Type id: goxlr.setGlobalColour
Set lighting animation¶
Chooses a moving light show for your GoXLR, such as a rainbow. Choose None to turn it off.
| Setting | What to put in |
|---|---|
| Animation | The animation to show. It only works if your GoXLR's firmware supports animations. Options: Retro Rainbow, Rainbow Dark, Rainbow Bright, Simple, Ripple, None. Starts as: None. |
Type id: goxlr.setAnimationMode
Set routing¶
Connects or disconnects a sound source from an output, for example to send Music to your stream or keep it out of it.
| Setting | What to put in |
|---|---|
| Input | The sound source: Microphone, Chat, Music, Game, Console, Line In, System or Samples. Options: Microphone, Chat, Music, Game, Console, Line In, System, Samples. Starts as: Music. |
| Output | Where it goes: Headphones, Broadcast Mix (your stream), Chat Mic, Sampler, Line Out or Stream Mix 2. Options: Headphones, Broadcast Mix, Chat Mic, Sampler, Line Out, Stream Mix 2. Starts as: Broadcast Mix. |
| Routed | On connects the source to the output, Off disconnects it, Toggle flips the current state. Options: On, Off, Toggle. Starts as: Toggle. |
Variables it adds
| Variable | What it holds |
|---|---|
%goXlrEnabled% |
True when the source goes to that output now |
Type id: goxlr.setRouting
Set scribble strip text¶
Writes a short text on a fader's little screen (the scribble strip). Not available on the GoXLR Mini.
| Setting | What to put in |
|---|---|
| Fader | Which fader: A, B, C or D. Options: A, B, C, D. Starts as: A. |
| Text | The words to show at the bottom of the fader's screen, like "Music". |
Type id: goxlr.setScribbleText
Set volume¶
Sets the volume of a GoXLR channel, or raises or lowers it a bit. Handy for a 'turn the music down' command.
| Setting | What to put in |
|---|---|
| Channel | The channel to change, like "Music". Choose from Mic, Line In, Console, System, Game, Chat, Sample, Music, Headphones, Mic Monitor or Line Out. |
| Volume (0-100) | The volume from 0 (silent) to 100 (full). With Relative change ticked, this is how much to add; use a minus number like -10 to lower it. Starts as: 100. |
| Add to current value | Tick to add the number to the current volume instead of setting it exactly. Untick to set the volume to exactly this. Starts as: false. |
Variables it adds
| Variable | What it holds |
|---|---|
%goXlrChannel% |
The channel that was changed |
%goXlrVolume% |
The new volume, 0 to 100 |
Type id: goxlr.setVolume