GoXLR triggers¶
Button pressed¶
Runs when you press a button on your GoXLR. Great for turning any GoXLR button into a Cuebot hotkey.
| Setting | What to put in |
|---|---|
| Devices | Which GoXLR to react to, by serial number (shown on the GoXLR page). Separate several with commas. Leave empty to react to any GoXLR. |
| Buttons | Which button, like "Cough", "Bleep", "Fader 1 Mute", "Effect Select 1", "Effect Fx" or "Sampler Top Left". Separate several with commas. Leave empty for any button. |
Variables you get
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The serial number of the GoXLR that did it |
%goXlrDeviceType% |
The kind of GoXLR ("Mini" or the full-size one) |
%goXlrProfile% |
The name of the profile loaded on that GoXLR right now |
%goXlrMicProfile% |
The name of the mic profile loaded right now |
%goXlrButton% |
The button, like "EffectSelect1" |
%goXlrButtonName% |
The button's name as shown to you, like "Effect Select 1" |
%goXlrPressed% |
True when the button is down, false when it came back up |
Type id: goxlr.buttonPressed
Button released¶
Runs when you let go of a button on your GoXLR.
| Setting | What to put in |
|---|---|
| Devices | Which GoXLR to react to, by serial number (shown on the GoXLR page). Separate several with commas. Leave empty to react to any GoXLR. |
| Buttons | Which button, like "Cough", "Bleep", "Fader 1 Mute", "Effect Select 1", "Effect Fx" or "Sampler Top Left". Separate several with commas. Leave empty for any button. |
Variables you get
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The serial number of the GoXLR that did it |
%goXlrDeviceType% |
The kind of GoXLR ("Mini" or the full-size one) |
%goXlrProfile% |
The name of the profile loaded on that GoXLR right now |
%goXlrMicProfile% |
The name of the mic profile loaded right now |
%goXlrButton% |
The button, like "EffectSelect1" |
%goXlrButtonName% |
The button's name as shown to you, like "Effect Select 1" |
%goXlrPressed% |
True when the button is down, false when it came back up |
Type id: goxlr.buttonReleased
Cough / mic mute changed¶
Runs when the Cough button (the mic mute button on a GoXLR Mini) mutes or unmutes your microphone.
| Setting | What to put in |
|---|---|
| Devices | Which GoXLR to react to, by serial number (shown on the GoXLR page). Separate several with commas. Leave empty to react to any GoXLR. |
| State | Choose Muted to react only when it gets muted, Unmuted only when it gets unmuted, or Any for both. Options: Any, Muted, Unmuted. Starts as: Any. |
Variables you get
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The serial number of the GoXLR that did it |
%goXlrDeviceType% |
The kind of GoXLR ("Mini" or the full-size one) |
%goXlrProfile% |
The name of the profile loaded on that GoXLR right now |
%goXlrMicProfile% |
The name of the mic profile loaded right now |
%goXlrMuted% |
True when the mic is muted now |
%goXlrMuteState% |
Unmuted, MutedToX or MutedToAll |
%goXlrPreviousMuteState% |
The mute state before |
%goXlrMuteFunction% |
Where the mute applies, like "All" or "ToStream" |
Type id: goxlr.coughMuteChanged
Device connected¶
Runs when a GoXLR shows up, for example when you plug it in or switch it on.
| Setting | What to put in |
|---|---|
| Devices | Which GoXLR to react to, by serial number (shown on the GoXLR page). Separate several with commas. Leave empty to react to any GoXLR. |
Variables you get
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The serial number of the GoXLR that did it |
%goXlrDeviceType% |
The kind of GoXLR ("Mini" or the full-size one) |
%goXlrProfile% |
The name of the profile loaded on that GoXLR right now |
%goXlrMicProfile% |
The name of the mic profile loaded right now |
Type id: goxlr.deviceConnected
Device disconnected¶
Runs when a GoXLR goes away, for example when you unplug it or switch it off.
| Setting | What to put in |
|---|---|
| Devices | Which GoXLR to react to, by serial number (shown on the GoXLR page). Separate several with commas. Leave empty to react to any GoXLR. |
Variables you get
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The serial number of the GoXLR that did it |
%goXlrDeviceType% |
The kind of GoXLR ("Mini" or the full-size one) |
%goXlrProfile% |
The name of the profile loaded on that GoXLR right now |
%goXlrMicProfile% |
The name of the mic profile loaded right now |
Type id: goxlr.deviceDisconnected
Effect preset changed¶
Runs when you pick a different effect preset (one of the six saved voice effect setups).
| Setting | What to put in |
|---|---|
| Devices | Which GoXLR to react to, by serial number (shown on the GoXLR page). Separate several with commas. Leave empty to react to any GoXLR. |
| Presets | Only react to this preset, by number (1 to 6) or by its name. Separate several with commas. Leave empty for any preset. |
Variables you get
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The serial number of the GoXLR that did it |
%goXlrDeviceType% |
The kind of GoXLR ("Mini" or the full-size one) |
%goXlrProfile% |
The name of the profile loaded on that GoXLR right now |
%goXlrMicProfile% |
The name of the mic profile loaded right now |
%goXlrPreset% |
The new preset slot, like "Preset3" |
%goXlrPresetNumber% |
The new preset number, 1 to 6 |
%goXlrPresetName% |
The new preset's name |
%goXlrPreviousPreset% |
The slot it was before |
%goXlrPreviousPresetName% |
The name it had before |
Type id: goxlr.effectPresetChanged
Effect turned on/off¶
Runs when one of the voice effects (FX, Megaphone, Robot or Hard Tune) is turned on or off.
| Setting | What to put in |
|---|---|
| Devices | Which GoXLR to react to, by serial number (shown on the GoXLR page). Separate several with commas. Leave empty to react to any GoXLR. |
| Effects | Which effect: FX, Megaphone, Robot or Hard Tune. Separate several with commas. Leave empty for any effect. |
| State | Choose On to react only when an effect is turned on, Off only when it is turned off, or Any for both. Options: Any, On, Off. Starts as: Any. |
Variables you get
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The serial number of the GoXLR that did it |
%goXlrDeviceType% |
The kind of GoXLR ("Mini" or the full-size one) |
%goXlrProfile% |
The name of the profile loaded on that GoXLR right now |
%goXlrMicProfile% |
The name of the mic profile loaded right now |
%goXlrEffect% |
The effect, like "HardTune" |
%goXlrEffectName% |
The effect's name as shown to you, like "Hard Tune" |
%goXlrEnabled% |
True when the effect is on now |
Type id: goxlr.effectStateChanged
Fader channel changed¶
Runs when you give a fader a different channel, for example when fader B changes from Music to Game.
| Setting | What to put in |
|---|---|
| Devices | Which GoXLR to react to, by serial number (shown on the GoXLR page). Separate several with commas. Leave empty to react to any GoXLR. |
| Faders | Which fader (A, B, C or D). Separate several with commas. Leave empty for any fader. |
| Channels | Only react when the fader now has this channel, like "Music". Separate several with commas. Leave empty for any channel. |
Variables you get
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The serial number of the GoXLR that did it |
%goXlrDeviceType% |
The kind of GoXLR ("Mini" or the full-size one) |
%goXlrProfile% |
The name of the profile loaded on that GoXLR right now |
%goXlrMicProfile% |
The name of the mic profile loaded right now |
%goXlrFader% |
The fader letter, A to D |
%goXlrChannel% |
The channel on that fader, like "Music" |
%goXlrChannelName% |
The channel's name as shown to you |
%goXlrMuted% |
True when the fader is muted now |
%goXlrMuteState% |
Unmuted, MutedToX or MutedToAll |
%goXlrVolume% |
The channel's volume, 0 to 100 |
%goXlrPreviousChannel% |
The channel the fader had before |
Type id: goxlr.faderAssignmentChanged
Fader mute changed¶
Runs when a fader gets muted or unmuted. Handy for showing on stream that your music or game sound is off.
| Setting | What to put in |
|---|---|
| Devices | Which GoXLR to react to, by serial number (shown on the GoXLR page). Separate several with commas. Leave empty to react to any GoXLR. |
| Faders | Which fader (A, B, C or D). Separate several with commas. Leave empty for any fader. |
| Channels | Which channel, like "Music" or "Mic". Separate several with commas. Leave empty for any channel. The channels are Mic, Line In, Console, System, Game, Chat, Sample, Music, Headphones, Mic Monitor and Line Out. |
| State | Choose Muted to react only when it gets muted, Unmuted only when it gets unmuted, or Any for both. Options: Any, Muted, Unmuted. Starts as: Any. |
Variables you get
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The serial number of the GoXLR that did it |
%goXlrDeviceType% |
The kind of GoXLR ("Mini" or the full-size one) |
%goXlrProfile% |
The name of the profile loaded on that GoXLR right now |
%goXlrMicProfile% |
The name of the mic profile loaded right now |
%goXlrFader% |
The fader letter, A to D |
%goXlrChannel% |
The channel on that fader, like "Music" |
%goXlrChannelName% |
The channel's name as shown to you |
%goXlrMuted% |
True when the fader is muted now |
%goXlrMuteState% |
Unmuted, MutedToX or MutedToAll |
%goXlrVolume% |
The channel's volume, 0 to 100 |
%goXlrWasMuted% |
True when it was muted before |
%goXlrPreviousMuteState% |
The mute state before |
Type id: goxlr.faderMuteChanged
Mic profile changed¶
Runs when a different mic profile is loaded. A mic profile holds your microphone sound settings.
| Setting | What to put in |
|---|---|
| Devices | Which GoXLR to react to, by serial number (shown on the GoXLR page). Separate several with commas. Leave empty to react to any GoXLR. |
| Mic profiles | Only react when this mic profile was loaded, by name. Separate several with commas. Leave empty for any mic profile. |
Variables you get
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The serial number of the GoXLR that did it |
%goXlrDeviceType% |
The kind of GoXLR ("Mini" or the full-size one) |
%goXlrProfile% |
The name of the profile loaded on that GoXLR right now |
%goXlrMicProfile% |
The name of the mic profile loaded right now |
%goXlrPreviousMicProfile% |
The name of the mic profile that was loaded before |
Type id: goxlr.micProfileChanged
Profile changed¶
Runs when a different GoXLR profile is loaded. A profile holds all your mixer settings, so this tells you that you switched setups.
| Setting | What to put in |
|---|---|
| Devices | Which GoXLR to react to, by serial number (shown on the GoXLR page). Separate several with commas. Leave empty to react to any GoXLR. |
| Profiles | Only react when this profile was loaded, by name. Separate several with commas. Leave empty for any profile. |
Variables you get
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The serial number of the GoXLR that did it |
%goXlrDeviceType% |
The kind of GoXLR ("Mini" or the full-size one) |
%goXlrProfile% |
The name of the profile loaded on that GoXLR right now |
%goXlrMicProfile% |
The name of the mic profile loaded right now |
%goXlrPreviousProfile% |
The name of the profile that was loaded before |
Type id: goxlr.profileChanged
Routing changed¶
Runs when a sound source is connected to or cut off from an output, for example when Music is sent to or removed from the stream mix.
| Setting | What to put in |
|---|---|
| Devices | Which GoXLR to react to, by serial number (shown on the GoXLR page). Separate several with commas. Leave empty to react to any GoXLR. |
| Inputs | Which source: Microphone, Chat, Music, Game, Console, Line In, System or Samples. Separate several with commas. Leave empty for any. |
| Outputs | Which output: Headphones, Broadcast Mix, Chat Mic, Sampler, Line Out or Stream Mix 2. Separate several with commas. Leave empty for any. |
| State | Choose Routed to react only when the connection is switched on, Not routed only when it is switched off, or Any for both. Options: Any, Routed, Not routed. Starts as: Any. |
Variables you get
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The serial number of the GoXLR that did it |
%goXlrDeviceType% |
The kind of GoXLR ("Mini" or the full-size one) |
%goXlrProfile% |
The name of the profile loaded on that GoXLR right now |
%goXlrMicProfile% |
The name of the mic profile loaded right now |
%goXlrInput% |
The source, like "LineIn" |
%goXlrOutput% |
The output, like "BroadcastMix" |
%goXlrEnabled% |
True when the source now goes to that output |
Type id: goxlr.routingChanged
Sample started/stopped¶
Runs when a sampler sound starts or stops playing. Good for showing a 'sound playing' light on screen.
| Setting | What to put in |
|---|---|
| Devices | Which GoXLR to react to, by serial number (shown on the GoXLR page). Separate several with commas. Leave empty to react to any GoXLR. |
| Banks | Only react for this bank: A, B or C. Separate several with commas. Leave empty for any bank. |
| Sampler buttons | Only react for this sampler button: Top Left, Top Right, Bottom Left or Bottom Right. Separate several with commas. Leave empty for any. |
| State | Choose Playing to react only when a sound starts, Stopped only when it stops, or Any for both. Options: Any, Playing, Stopped. Starts as: Any. |
Variables you get
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The serial number of the GoXLR that did it |
%goXlrDeviceType% |
The kind of GoXLR ("Mini" or the full-size one) |
%goXlrProfile% |
The name of the profile loaded on that GoXLR right now |
%goXlrMicProfile% |
The name of the mic profile loaded right now |
%goXlrBank% |
The bank (A, B or C) |
%goXlrSampleButton% |
The sampler button, like "TopLeft" |
%goXlrPlaying% |
True when the sound is playing now |
Type id: goxlr.samplePlaybackChanged
Sampler bank changed¶
Runs when you switch to another sampler bank (A, B or C). Each bank holds its own set of sounds.
| Setting | What to put in |
|---|---|
| Devices | Which GoXLR to react to, by serial number (shown on the GoXLR page). Separate several with commas. Leave empty to react to any GoXLR. |
| Banks | Only react when this bank was chosen: A, B or C. Separate several with commas. Leave empty for any bank. |
Variables you get
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The serial number of the GoXLR that did it |
%goXlrDeviceType% |
The kind of GoXLR ("Mini" or the full-size one) |
%goXlrProfile% |
The name of the profile loaded on that GoXLR right now |
%goXlrMicProfile% |
The name of the mic profile loaded right now |
%goXlrBank% |
The new bank (A, B or C) |
%goXlrPreviousBank% |
The bank it was before |
Type id: goxlr.samplerBankChanged
Utility connected¶
Runs when Cuebot connects to the GoXLR Utility (the small helper program that talks to your GoXLR). Handy to show that your mixer is ready.
Variables you get
| Variable | What it holds |
|---|---|
%goXlrDaemonVersion% |
The version of the GoXLR Utility |
%goXlrDeviceCount% |
How many GoXLRs the utility sees |
Type id: goxlr.connected
Utility disconnected¶
Runs when Cuebot loses the connection to the GoXLR Utility, for example when you close it. Useful for a warning that your mixer is no longer controlled.
Variables you get
| Variable | What it holds |
|---|---|
%reason% |
A short text saying why the connection ended |
Type id: goxlr.disconnected
Volume changed¶
Runs when the volume of a GoXLR channel changes, whether you moved a fader, used the GoXLR app or Cuebot did it.
| Setting | What to put in |
|---|---|
| Devices | Which GoXLR to react to, by serial number (shown on the GoXLR page). Separate several with commas. Leave empty to react to any GoXLR. |
| Channels | Which channel, like "Music" or "Mic". Separate several with commas. Leave empty for any channel. The channels are Mic, Line In, Console, System, Game, Chat, Sample, Music, Headphones, Mic Monitor and Line Out. |
Variables you get
| Variable | What it holds |
|---|---|
%goXlrSerial% |
The serial number of the GoXLR that did it |
%goXlrDeviceType% |
The kind of GoXLR ("Mini" or the full-size one) |
%goXlrProfile% |
The name of the profile loaded on that GoXLR right now |
%goXlrMicProfile% |
The name of the mic profile loaded right now |
%goXlrChannel% |
The channel that changed, like "LineIn" |
%goXlrChannelName% |
The channel's name as shown to you, like "Line In" |
%goXlrFader% |
The fader (A-D) that channel is on, empty if it is on none |
%goXlrVolume% |
The new volume, 0 to 100 |
%goXlrPreviousVolume% |
The volume before, 0 to 100 |
Type id: goxlr.volumeChanged