Skip to content

Reference Script Functions Goxlr

Jump to bottom
Kristopher Barrantes edited this page Nov 5, 2026 · 2 revisions

GoXLR script functions

Also on the Cuebot Docs site.

Functions for C# (Cb.Call) and Python (a cb method each, or cb.call). See Script functions for how to use them.

A Run Python code step in the action editor

goxlr.command

Sends a raw command to the GoXLR Utility. For advanced users who know the GoXLR Utility's command names.

Value In Python What to put in
command command The command, like {"SetFXEnabled": true}. You can also give it as JSON text.
serial serial Optional. The serial number of the GoXLR to send it to. Leave it out for your main GoXLR.

Gives back: true when done.

C#

var answer = await Cb.Call("goxlr.command", new { command = new { SetFXEnabled = true } });

Python

answer = cb.goxlr_command(command={"SetFXEnabled": True})

goxlr.connect

Starts connecting to the GoXLR Utility. It does not wait: Cuebot keeps trying in the background until it works.

Gives back: true once connecting has started (not when it is connected).

C#

var answer = await Cb.Call("goxlr.connect");

Python

answer = cb.goxlr_connect()

goxlr.disconnect

Disconnects Cuebot from the GoXLR Utility.

Gives back: true when done.

C#

var answer = await Cb.Call("goxlr.disconnect");

Python

answer = cb.goxlr_disconnect()

goxlr.getRawStatus

Gives you everything the GoXLR Utility reports, exactly as it sends it. For advanced scripts.

Gives back: The utility's whole status as JSON text. Empty text when nothing was received yet.

C#

var answer = await Cb.Call("goxlr.getRawStatus");

Python

answer = cb.goxlr_get_raw_status()

goxlr.getStatus

Tells you about the GoXLR Utility connection and your GoXLR: profiles, faders, volumes, mutes and effects.

Gives back: isConnected, status (a status line), url, daemonVersion, devices (each GoXLR with its profile, faders, volumes in percent, cough button, effects and sampler bank), profiles, micProfiles and presets.

C#

var answer = await Cb.Call("goxlr.getStatus");

Python

answer = cb.goxlr_get_status()

goxlr.isConnected

Checks whether Cuebot is connected to the GoXLR Utility right now.

Gives back: true while connected, otherwise false.

C#

var answer = await Cb.Call("goxlr.isConnected");

Python

answer = cb.goxlr_is_connected()

goxlr.loadMicProfile

Loads one of your GoXLR mic profiles. Fails with an error when the GoXLR Utility is not connected.

Value In Python What to put in
name name The mic profile name as the GoXLR Utility shows it, like "Dynamic Mic".
remember remember Optional. true makes the GoXLR Utility load this mic profile again next time it starts. Default true.

Gives back: true when done.

C#

var answer = await Cb.Call("goxlr.loadMicProfile", new { name = "Dynamic Mic" });

Python

answer = cb.goxlr_load_mic_profile(name="Dynamic Mic")

goxlr.loadProfile

Loads one of your GoXLR profiles. Fails with an error when the GoXLR Utility is not connected.

Value In Python What to put in
name name The profile name as the GoXLR Utility shows it, like "Streaming".
remember remember Optional. true makes the GoXLR Utility load this profile again next time it starts. Default true.

Gives back: true when done.

C#

var answer = await Cb.Call("goxlr.loadProfile", new { name = "Streaming" });

Python

answer = cb.goxlr_load_profile(name="Streaming")

goxlr.playSample

Plays a sample from a sampler button, as if you pressed it. The GoXLR Mini has no sampler, so it fails with an error there.

Value In Python What to put in
bank bank Optional. The bank: "A", "B" or "C". Leave it empty for the bank that is active now.
button button The button: "TopLeft", "TopRight", "BottomLeft" or "BottomRight".
index index Optional. Which sample on that button, counting from 1. Leave it out to play the button's next sample.

Gives back: bank and button that were played.

C#

var answer = await Cb.Call("goxlr.playSample", new { button = "TopLeft" });

Python

answer = cb.goxlr_play_sample(button="TopLeft")

goxlr.request

Sends any raw request to the GoXLR Utility and gives back its answer. For advanced users.

Value In Python What to put in
request request The request, like "GetStatus" or {"Command": [...]}. You can also give it as JSON text.

Gives back: The GoXLR Utility's answer data, like "Ok" or the status object.

C#

var answer = await Cb.Call("goxlr.request", new { request = "GetStatus" });

Python

answer = cb.goxlr_request(request="GetStatus")

goxlr.setCoughMute

Mutes or unmutes your mic with the cough button (on a GoXLR Mini: the mic mute button). Fails with an error when the GoXLR Utility is not connected.

Value In Python What to put in
state state Optional. "Mute", "Mute to all", "Unmute" or "Toggle" (switch). Default "Toggle".

Gives back: The new mute state: "Unmuted", "MutedToX" or "MutedToAll".

C#

var answer = await Cb.Call("goxlr.setCoughMute", new { state = "Mute" });

Python

answer = cb.goxlr_set_cough_mute(state="Mute")

goxlr.setEffect

Turns a voice effect on or off. The GoXLR Mini has no effects, so it fails with an error there.

Value In Python What to put in
effect effect The effect: "FX", "Megaphone", "Robot" or "Hard Tune".
state state Optional. "On", "Off" or "Toggle" (switch). Default "Toggle".

Gives back: The new state: true for on, false for off.

C#

var answer = await Cb.Call("goxlr.setEffect", new { effect = "Robot", state = "On" });

Python

answer = cb.goxlr_set_effect(effect="Robot", state="On")

goxlr.setEffectPreset

Picks one of the six effect presets. The GoXLR Mini has no effects, so it fails with an error there.

Value In Python What to put in
preset preset The preset number 1-6, like "3", or its name.

Gives back: The preset that is now active, like "Preset3".

C#

var answer = await Cb.Call("goxlr.setEffectPreset", new { preset = "3" });

Python

answer = cb.goxlr_set_effect_preset(preset="3")

goxlr.setFaderChannel

Puts a different channel on one of the GoXLR faders. Fails with an error when the GoXLR Utility is not connected.

Value In Python What to put in
fader fader The fader letter: A, B, C or D.
channel channel The channel to put on it, like "Game" or "Music".

Gives back: true when done.

C#

var answer = await Cb.Call("goxlr.setFaderChannel", new { fader = "B", channel = "Game" });

Python

answer = cb.goxlr_set_fader_channel(fader="B", channel="Game")

goxlr.setFaderMute

Mutes or unmutes one GoXLR fader. Fails with an error when the GoXLR Utility is not connected or the channel is not on a fader.

Value In Python What to put in
target target The fader letter A, B, C or D, or the channel on it, like "Music".
state state Optional. "Mute", "Mute to all", "Unmute" or "Toggle" (switch). Default "Toggle".

Gives back: The new mute state: "Unmuted", "MutedToX" or "MutedToAll".

C#

var answer = await Cb.Call("goxlr.setFaderMute", new { target = "Music", state = "Mute" });

Python

answer = cb.goxlr_set_fader_mute(target="Music", state="Mute")

goxlr.setGlobalColour

Changes the colour of all the lights on your GoXLR. Fails with an error when the colour is not a hex colour.

Value In Python What to put in
colour colour The colour as a hex code, like "#FF8800".

Gives back: true when done.

C#

var answer = await Cb.Call("goxlr.setGlobalColour", new { colour = "#9146FF" });

Python

answer = cb.goxlr_set_global_colour(colour="#9146FF")

goxlr.setRouting

Sends a GoXLR input to an output, or stops it, like the Routing table in the GoXLR Utility.

Value In Python What to put in
input input The input: Microphone, Chat, Music, Game, Console, LineIn, System or Samples.
output output The output: Headphones, BroadcastMix, ChatMic, Sampler, LineOut or StreamMix2.
state state Optional. "On", "Off" or "Toggle" (switch). Default "Toggle".

Gives back: The new state: true when the input goes to the output, false when not.

C#

var answer = await Cb.Call("goxlr.setRouting", new { input = "Music", output = "BroadcastMix", state = "Off" });

Python

answer = cb.goxlr_set_routing(input="Music", output="BroadcastMix", state="Off")

goxlr.setSamplerBank

Switches the sampler to bank A, B or C. The GoXLR Mini has no sampler, so it fails with an error there.

Value In Python What to put in
bank bank The bank: "A", "B" or "C".

Gives back: true when done.

C#

var answer = await Cb.Call("goxlr.setSamplerBank", new { bank = "B" });

Python

answer = cb.goxlr_set_sampler_bank(bank="B")

goxlr.setVolume

Changes the volume of one GoXLR channel. Fails with an error when the GoXLR Utility is not connected.

Value In Python What to put in
channel channel The channel: Mic, LineIn, Console, System, Game, Chat, Sample, Music, Headphones, MicMonitor or LineOut.
volume volume The volume in percent, 0-100, like 80.
relative relative Optional. true adds the number to the current volume instead (use a minus number to turn it down). Default false.

Gives back: The new volume in percent.

C#

var answer = await Cb.Call("goxlr.setVolume", new { channel = "Music", volume = 40 });

Python

answer = cb.goxlr_set_volume(channel="Music", volume=40)

goxlr.stopSample

Stops the sample that a sampler button is playing.

Value In Python What to put in
bank bank Optional. The bank: "A", "B" or "C". Leave it empty for the bank that is active now.
button button The button: "TopLeft", "TopRight", "BottomLeft" or "BottomRight".

Gives back: bank and button that were stopped.

C#

var answer = await Cb.Call("goxlr.stopSample", new { button = "TopLeft" });

Python

answer = cb.goxlr_stop_sample(button="TopLeft")

Cuebot by Tech Daddy Digital · MIT license · Privacy

Cuebot Docs (the same pages, nicer to read)

Clone this wiki locally