Commands

class goxlr.commands.daemon.DaemonCommands

Used to send commands to the GoXLR daemon.

async open_ui()
async activate()
async stop_daemon()
async open_path(pathType)
Parameters:

pathType (PathType)

async set_log_level(logLevel)
Parameters:

logLevel (LogLevel)

async set_show_tray_icon(enabled)
Parameters:

enabled (bool)

async set_tts_enabled(enabled)
Parameters:

enabled (bool)

async set_auto_start_enabled(enabled)
Parameters:

enabled (bool)

async set_allow_network_access(enabled)
Parameters:

enabled (bool)

async recover_defaults(pathType)
Parameters:

pathType (PathType)

class goxlr.commands.goxlr.GoXLRCommands

GoXLR-specific commands.

async set_shutdown_commands(*methods)

Set the commands to be executed when the GoXLR is shutting down. Commands are accepted as a list of lists, where the first item is the method name and the remaining items are the arguments for that method.

Parameters:

methods (list) – A list of methods to be executed when the GoXLR is shutting down.

Returns:

The response from the GoXLR.

Example:

Return type:

dict | str

>>> await xlr.set_shutdown_commands(
...     ["SetFader", Fader.A, Channel.Headphones],
...     ["SetFader", Fader.B, Channel.Chat]
... )
async set_sampler_pre_buffer_duration(duration)
Parameters:

duration (c_ushort)

async set_fader(fader, channel)
Parameters:
async set_fader_mute_function(fader, mute_function)
Parameters:
async set_volume(channel, volume)
Parameters:

  • channel (Channel)

  • volume (c_ubyte)

async set_microphone_type(microphone_type)
Parameters:

microphone_type (MicrophoneType)

async set_microphone_gain(microphone_type, gain)
Parameters:
async set_router(input_device, output_device, enabled)
Parameters:
async set_cough_mute_function(mute_function)
Parameters:

mute_function (MuteFunction)

async set_cough_is_hold(is_hold)
Parameters:

is_hold (bool)

async set_bleep_volume(volume)
Parameters:

volume (c_byte)

async set_eq_mini_gain(mini_eq_frequency, gain)
Parameters:
async set_eq_mini_frequency(mini_eq_frequency, frequency)
Parameters:
async set_eq_gain(eq_frequency, gain)
Parameters:
async set_eq_frequency(eq_frequency, frequency)
Parameters:
async set_gate_threshold(gate_threshold)
Parameters:

gate_threshold (c_byte)

async set_gate_attenuation(gate_attenuation)
Parameters:

gate_attenuation (c_ubyte)

async set_gate_attack(gate_attack)
Parameters:

gate_attack (GateTime)

async set_gate_release(gate_release)
Parameters:

gate_release (GateTime)

async set_gate_active(gate_active)
Parameters:

gate_active (bool)

async set_compressor_threshold(compressor_threshold)
Parameters:

compressor_threshold (c_byte)

async set_compressor_ratio(compressor_ratio)
Parameters:

compressor_ratio (CompressorRatio)

async set_compressor_attack(compressor_attack)
Parameters:

compressor_attack (CompressorAttackTime)

async set_compressor_release_time(compressor_release)
Parameters:

compressor_release (CompressorReleaseTime)

async set_compressor_makeup_gain(compressor_makeup_gain)
Parameters:

compressor_makeup_gain (c_byte)

async set_element_display_mode(display_mode_component, display_mode)
Parameters:
async set_deesser(deesser)
Parameters:

deesser (c_ubyte)

async set_animation_mode(animation_mode)

Set the animation mode of the device.

Parameters:

animation_mode (AnimationMode) – The animation mode to set.

Raises:

MissingFeatureError – If the animation mode is not supported on the GoXLR Mini.

async set_animation_mod1(animation_mod1)
Parameters:

animation_mod1 (c_ubyte)

async set_animation_mod2(animation_mod2)
Parameters:

animation_mod2 (c_ubyte)

async set_animation_waterfall(waterfall_direction)
Parameters:

waterfall_direction (WaterfallDirection)

async set_global_colour(colour)
Parameters:

colour (str)

async set_fader_display_style(fader, fader_display_style)
Parameters:
async set_fader_colours(fader, colour1, colour2)
Parameters:

  • fader (Fader)

  • colour1 (str)

  • colour2 (str)

async set_all_fader_colours(colour1, colour2)
Parameters:

  • colour1 (str)

  • colour2 (str)

async set_all_fader_display_style(fader_display_style)
Parameters:

fader_display_style (FaderDisplayStyle)

async set_button_colours(button, colour1, colour2=None)
Parameters:

  • button (Button)

  • colour1 (str)

  • colour2 (str)

async set_button_off_style(button, off_style)
Parameters:
async set_button_group_colours(button_colour_group, colour1, colour2=None)
Parameters:
async set_button_group_off_style(button_colour_group, off_style)
Parameters:
async set_simple_colour(simple_colour_target, colour)
Parameters:
async set_encoder_colours(encoder, colours)
Parameters:
async set_sample_colours(sample, colours)
Parameters:
async set_sample_off_style(sample, off_style)
Parameters:
async load_effect(effect_name)
Parameters:

effect_name (str)

async rename_active_preset(new_name)
Parameters:

new_name (str)

async save_active_preset()
async set_reverb_style(reverb_style)
Parameters:

reverb_style (ReverbStyle)

async set_reverb_amount(reverb_amount)
Parameters:

reverb_amount (c_ubyte)

async set_reverb_decay(reverb_decay)
Parameters:

reverb_decay (c_ushort)

async set_reverb_early_level(reverb_early_level)
Parameters:

reverb_early_level (c_byte)

async set_reverb_tail_level(reverb_tail_level)
Parameters:

reverb_tail_level (c_byte)

async set_reverb_pre_delay(reverb_pre_delay)
Parameters:

reverb_pre_delay (c_ubyte)

async set_reverb_low_colour(reverb_low_colour)
Parameters:

reverb_low_colour (c_byte)

async set_reverb_high_colour(reverb_high_colour)
Parameters:

reverb_high_colour (c_byte)

async set_reverb_high_factor(reverb_high_factor)
Parameters:

reverb_high_factor (c_byte)

async set_reverb_diffuse(reverb_diffuse)
Parameters:

reverb_diffuse (c_ubyte)

async set_reverb_mod_speed(reverb_mod_speed)
Parameters:

reverb_mod_speed (c_ubyte)

async set_reverb_mod_depth(reverb_mod_depth)
Parameters:

reverb_mod_depth (c_ubyte)

async set_echo_style(echo_style)
Parameters:

echo_style (EchoStyle)

async set_echo_amount(echo_amount)
Parameters:

echo_amount (c_ubyte)

async set_echo_feedback(echo_feedback)
Parameters:

echo_feedback (c_ubyte)

async set_echo_tempo(echo_tempo)
Parameters:

echo_tempo (c_ushort)

async set_echo_delay_left(echo_delay_left)
Parameters:

echo_delay_left (c_ushort)

async set_echo_delay_right(echo_delay_right)
Parameters:

echo_delay_right (c_ushort)

async set_echo_feedback_left(echo_feedback_left)
Parameters:

echo_feedback_left (c_ubyte)

async set_echo_feedback_right(echo_feedback_right)
Parameters:

echo_feedback_right (c_ubyte)

async set_echo_feedback_xfb_l_to_r(echo_feedback_xfb_l_to_r)
Parameters:

echo_feedback_xfb_l_to_r (c_ubyte)

async set_echo_feedback_xfb_r_to_l(echo_feedback_xfb_r_to_l)
Parameters:

echo_feedback_xfb_r_to_l (c_ubyte)

async set_pitch_style(pitch_style)
Parameters:

pitch_style (PitchStyle)

async set_pitch_amount(pitch_amount)
Parameters:

pitch_amount (c_byte)

async set_pitch_character(pitch_character)
Parameters:

pitch_character (c_ubyte)

async set_gender_style(gender_style)
Parameters:

gender_style (GenderStyle)

async set_gender_amount(gender_amount)
Parameters:

gender_amount (c_byte)

async set_megaphone_style(megaphone_style)
Parameters:

megaphone_style (MegaphoneStyle)

async set_megaphone_amount(megaphone_amount)
Parameters:

megaphone_amount (c_ubyte)

async set_megaphone_post_gain(megaphone_post_gain)
Parameters:

megaphone_post_gain (c_byte)

async set_robot_style(robot_style)
Parameters:

robot_style (RobotStyle)

async set_robot_gain(robot_range, robot_gain)
Parameters:
async set_robot_frequency(robot_range, robot_frequency)
Parameters:

  • robot_range (RobotRange)

  • robot_frequency (c_ubyte)

async set_robot_width(robot_range, robot_width)
Parameters:
async set_robot_waveform(robot_waveform)
Parameters:

robot_waveform (c_ubyte)

async set_robot_pulse_width(robot_pulse_width)
Parameters:

robot_pulse_width (c_ubyte)

async set_robot_threshold(robot_threshold)
Parameters:

robot_threshold (c_byte)

async set_robot_dry_mix(robot_dry_mix)
Parameters:

robot_dry_mix (c_byte)

async set_hardtune_style(hardtune_style)
Parameters:

hardtune_style (HardTuneStyle)

async set_hardtune_amount(hardtune_amount)
Parameters:

hardtune_amount (c_ubyte)

async set_hardtune_rate(hardtune_rate)
Parameters:

hardtune_rate (c_ubyte)

async set_hardtune_window(hardtune_window)
Parameters:

hardtune_window (c_ushort)

async set_hardtune_source(hardtune_source)
Parameters:

hardtune_source (HardTuneSource)

async clear_sample_process_error()
async set_sampler_function(sample_bank, sample_button, sample_playback_mode)
Parameters:
async set_sampler_order(sample_bank, sample_button, sample_play_order)
Parameters:
async add_sample(sample_bank, sample_button, sample_name)
Parameters:
async set_sample_start_percent(sample_bank, sample_button, index, sample_start_percent)
Parameters:
async set_sample_stop_percent(sample_bank, sample_button, index, sample_stop_percent)
Parameters:
async remove_sample_by_index(sample_bank, sample_button, index)
Parameters:
async play_sample_by_index(sample_bank, sample_button, index)
Parameters:
async play_next_sample(sample_bank, sample_button)
Parameters:
async stop_sample_playback(sample_bank, sample_button)
Parameters:
async set_scribble_icon(fader, scribble_icon=None)
Parameters:

  • fader (Fader)

  • scribble_icon (str)

async set_scribble_text(fader, scribble_text)
Parameters:

  • fader (Fader)

  • scribble_text (str)

async set_scribble_number(fader, scribble_number)
Parameters:

  • fader (Fader)

  • scribble_number (str)

async set_scribble_invert(fader, scribble_invert)
Parameters:

  • fader (Fader)

  • scribble_invert (bool)

async new_profile(profile_name)
Parameters:

profile_name (str)

async load_profile(profile_name, save_changes=False)
Parameters:

  • profile_name (str)

  • save_changes (bool)

async load_profile_colours(profile_name)
Parameters:

profile_name (str)

async save_profile()
async save_profile_as(profile_name)
Parameters:

profile_name (str)

async delete_profile(profile_name)
Parameters:

profile_name (str)

async new_mic_profile(profile_name)
Parameters:

profile_name (str)

async load_mic_profile(profile_name, save_changes=False)
Parameters:

  • profile_name (str)

  • save_changes (bool)

async save_mic_profile()
async save_mic_profile_as(profile_name)
Parameters:

profile_name (str)

async delete_mic_profile(profile_name)
Parameters:

profile_name (str)

async set_mute_hold_duration(mute_hold_duration)
Parameters:

mute_hold_duration (c_ushort)

async set_vc_mute_also_mute_cm(vc_mute_also_mute_cm)
Parameters:

vc_mute_also_mute_cm (bool)

async set_active_effect_preset(active_effect_preset)
Parameters:

active_effect_preset (EffectBankPreset)

async set_sampler_active_bank(active_sampler_bank)
Parameters:

active_sampler_bank (SampleBank)

async set_megaphone_enabled(megaphone_enabled)
Parameters:

megaphone_enabled (bool)

async set_robot_enabled(robot_enabled)
Parameters:

robot_enabled (bool)

async set_hardtune_enabled(hardtune_enabled)
Parameters:

hardtune_enabled (bool)

async set_fx_enabled(fx_enabled)
Parameters:

fx_enabled (bool)

async set_fader_mute_state(fader, mute_state)
Parameters:
async set_cough_mute_state(mute_state)
Parameters:

mute_state (MuteState)

async set_submix_enabled(enabled)
Parameters:

enabled (bool)

async set_submix_volume(channel, volume)
Parameters:
async set_submix_linked(channel, linked)
Parameters:
async set_submix_output_mix(output_device, mix)
Parameters:
async set_monitor_mix(output_device)
Parameters:

output_device (OutputDevice)

class goxlr.commands.status.StatusCommands

Used to retrieve information from the GoXLR Utility daemon.

async get_status()

Returns the status of the GoXLR.

Returns:

The status of the GoXLR.

Raises:

DaemonError – If the status could not be retrieved.

Note:

You should use GoXLR.update() instead of this method.

Return type:

Status

get_http_settings()
Returns:

The HTTP settings of the GoXLR.

Return type:

HttpSettings

get_daemon_version()
Returns:

The version of the GoXLR Utility daemon.

Return type:

str

is_autostart_enabled()
Returns:

Whether or not the GoXLR Utility daemon is set to start on boot.

Return type:

bool

is_tray_icon_visible()
Returns:

Whether or not the GoXLR Utility daemon is set to show a tray icon.

Return type:

bool

is_tts_enabled()
Returns:

Whether or not TTS is enabled.

Return type:

bool

is_network_access_allowed()
Returns:

Whether or not network access is allowed.

Return type:

bool

get_log_level()
Returns:

The log level of the GoXLR Utility daemon.

Return type:

LogLevel

get_mixer(serial=None)

Returns a mixer object with the specified serial number.

Parameters:

serial (str) – The serial number of the mixer to interact with. If not specified, it will default to the currently selected mixer.

Returns:

The requested mixer object.

Raises:

MixerNotFoundError – If the specified mixer is not found.

Return type:

Mixer

get_hardware_info()
Return type:

HardwareInfo

get_versions()
Return type:

MixerVersions

get_serial_number()
Return type:

str

get_manufactured_date()
Return type:

datetime

get_device_type()
Return type:

DeviceType

get_usb_device()
Return type:

USBDevice

get_shutdown_commands()
Return type:

List[Dict[str, str | List[str]]]

get_fader_status()
Return type:

Dict[Fader, FaderStatus]

get_fader(fader)
Parameters:

fader (Fader)

Return type:

FaderStatus | None

get_fader_channel(fader)
Parameters:

fader (Fader)

Return type:

Channel

get_fader_mute_function(fader)
Parameters:

fader (Fader)

Return type:

MuteFunction

get_fader_scribble(fader)
Parameters:

fader (Fader)

Return type:

Scribble

get_fader_scribble_file_name(fader)
Parameters:

fader (Fader)

Return type:

str

get_scribble_text(fader)
Parameters:

fader (Fader)

Return type:

str

get_scribble_left_text(fader)
Parameters:

fader (Fader)

Return type:

str

get_scribble_invert(fader)
Parameters:

fader (Fader)

Return type:

bool

get_fader_mute_state(fader)
Parameters:

fader (Fader)

Return type:

MuteState

is_fader_muted(fader)

Helper method to check if a fader is muted.

Parameters:

fader (Fader)

Return type:

bool

get_mic_status()
Return type:

MicStatus

get_microphone_type()
Return type:

MicrophoneType

get_microphone_gains()
Return type:

Dict[MicrophoneType, int]

get_microphone_gain(mic_type=None)
Note:

If no mic type is specified, the currently selected mic type will be used.

Parameters:

mic_type (MicrophoneType)

Return type:

int | None

get_eq()
Return type:

Equaliser

get_eq_gain(frequency)
Parameters:

frequency (EqFrequency)

Return type:

int | None

get_eq_frequency(frequency)
Parameters:

frequency (EqFrequency)

Return type:

float | None

get_eq_mini()
Return type:

EqMini

get_eq_mini_gain(frequency)
Parameters:

frequency (MiniEqFrequency)

Return type:

int | None

get_eq_mini_frequency(frequency)
Parameters:

frequency (MiniEqFrequency)

Return type:

float | None

get_noise_gate()
Return type:

NoiseGate

get_compressor()
Return type:

Compressor

get_levels()
Return type:

Levels

is_submix_supported()
Return type:

bool

get_monitor_mix()
Return type:

OutputDevice

get_volumes()
Return type:

Dict[Channel, int]

get_volume(channel)
Parameters:

channel (Channel)

Return type:

int | None

get_submixes()
Return type:

Submixes | None

get_submix_input_mix(channel)
Parameters:

channel (SubMixChannel)

Return type:

Submix | None

get_submix_volume(channel)
Parameters:

channel (SubMixChannel)

Return type:

int | None

get_submix_linked(channel)
Parameters:

channel (SubMixChannel)

Return type:

bool | None

get_submix_output_mix(output)
Parameters:

output (OutputDevice)

Return type:

Mix | None

get_bleep_volume()
Return type:

int

get_deesser()
Return type:

int

get_routing_table()
Return type:

Dict[InputDevice, Dict[OutputDevice, bool]]

get_routed_outputs(input)
Parameters:

input (InputDevice)

Return type:

Dict[OutputDevice, bool] | None

get_router(input, output)
Parameters:
Return type:

bool | None

get_routed_inputs(output)
Parameters:

output (OutputDevice)

Return type:

List[InputDevice]

get_cough_button()
Return type:

CoughButton

get_cough_is_hold()
Return type:

bool

get_cough_mute_function()
Return type:

MuteFunction

get_cough_mute_state()
Return type:

MuteState

is_cough_button_muted()
Return type:

bool

get_lighting()
Return type:

Lighting

get_animation()
Return type:

Animation

is_animation_supported()
Return type:

bool

get_animation_mode()
Return type:

AnimationMode

get_animation_mod1()
Return type:

int

get_animation_mod2()
Return type:

int

get_animation_waterfall()
Return type:

WaterfallDirection

get_fader_lighting(fader)
Parameters:

fader (Fader)

Return type:

FaderLighting | None

get_fader_display_style(fader)
Parameters:

fader (Fader)

Return type:

FaderDisplayStyle | None

get_fader_colours(fader)
Parameters:

fader (Fader)

Return type:

Colours | None

get_button_lighting(button)
Parameters:

button (Button)

Return type:

ButtonLighting | None

get_button_colours(button)
Parameters:

button (Button)

Return type:

Colours | None

get_button_off_style(button)
Parameters:

button (Button)

Return type:

ButtonColourOffStyle | None

get_simple_colour(target)
Parameters:

target (SimpleColourTarget)

Return type:

str | None

get_sample_lighting(target)
Parameters:

target (SamplerColourTarget)

Return type:

ButtonLighting | None

get_sample_colours(target)
Parameters:

target (SamplerColourTarget)

Return type:

Colours | None

get_encoder_colours(encoder)
Parameters:

encoder (Encoder)

Return type:

Colours | None

get_effects()
Return type:

Effects

is_effects_enabled()
Return type:

bool

get_active_effect_preset()
Return type:

EffectBankPreset

get_preset_name(preset)
Parameters:

preset (EffectBankPreset)

Return type:

str | None

get_current_effects()
Return type:

CurrentEffects

get_reverb()
Return type:

Reverb

get_reverb_amount()
Return type:

int

get_reverb_decay()
Return type:

int

get_reverb_diffuse()
Return type:

int

get_reverb_early_level()
Return type:

int

get_reverb_high_colour()
Return type:

int

get_reverb_high_factor()
Return type:

int

get_reverb_low_colour()
Return type:

int

get_reverb_mod_depth()
Return type:

int

get_reverb_mod_speed()
Return type:

int

get_reverb_pre_delay()
Return type:

int

get_reverb_style()
Return type:

ReverbStyle

get_reverb_tail_level()
Return type:

int

get_echo()
Return type:

Echo

get_echo_amount()
Return type:

int

get_echo_delay_left()
Return type:

int

get_echo_delay_right()
Return type:

int

get_echo_feedback()
Return type:

int

get_echo_feedback_left()
Return type:

int

get_echo_feedback_right()
Return type:

int

get_echo_feedback_xfb_l_to_r()
Return type:

int

get_echo_feedback_xfb_r_to_l()
Return type:

int

get_echo_style()
Return type:

EchoStyle

get_echo_tempo()
Return type:

int

get_pitch()
Return type:

Pitch

get_pitch_amount()
Return type:

int

get_pitch_character()
Return type:

int

get_pitch_style()
Return type:

PitchStyle

get_gender()
Return type:

Gender

get_gender_amount()
Return type:

int

get_gender_style()
Return type:

GenderStyle

get_megaphone()
Return type:

Megaphone

get_megaphone_amount()
Return type:

int

is_megaphone_enabled()
Return type:

bool

get_megaphone_post_gain()
Return type:

int

get_megaphone_style()
Return type:

MegaphoneStyle

get_robot()
Return type:

Robot

get_robot_dry_mix()
Return type:

int

is_robot_enabled()
Return type:

bool

get_robot_frequency(range)
Parameters:

range (RobotRange)

Return type:

int

get_robot_gain(range)
Parameters:

range (RobotRange)

Return type:

int

get_robot_width(range)
Parameters:

range (RobotRange)

Return type:

int

get_robot_pulse_width()
Return type:

int

get_robot_style()
Return type:

RobotStyle

get_robot_threshold()
Return type:

int

get_robot_waveform()
Return type:

int

get_hardtune()
Return type:

HardTune

is_hardtune_enabled()
Return type:

bool

get_hardtune_amount()
Return type:

int

get_hardtune_rate()
Return type:

int

get_hardtune_source()
Return type:

HardTuneSource

get_hardtune_style()
Return type:

HardTuneStyle

get_hardtune_window()
Return type:

int

get_sampler()
Return type:

Sampler

get_sampler_processing_state()
Return type:

SamplerProcessState

get_sampler_active_bank()
Return type:

SampleBank

is_clear_sample_process_error()
Return type:

bool

get_sampler_pre_buffer_duration()
Return type:

int

get_sample_banks()
Return type:

Dict[SampleBank, Dict[SampleButton, SampleMetadata]]

get_sample_bank(bank)
Parameters:

bank (SampleBank)

Return type:

Dict[SampleButton, SampleMetadata] | None

get_sample_metadata(bank, button)
Parameters:
Return type:

SampleMetadata | None

get_sampler_function(bank, button)
Parameters:
Return type:

SamplePlaybackMode | None

get_sampler_order(bank, button)
Parameters:
Return type:

SamplePlayOrder | None

get_samples(bank, button)
Parameters:
Return type:

List[Sample] | None

get_sample_start_percent(bank, button, index)
Parameters:
Return type:

float | None

get_sample_stop_percent(bank, button, index)
Parameters:
Return type:

float | None

get_sample_is_playing(bank, button)
Parameters:
Return type:

bool

get_sample_is_recording(bank, button)
Parameters:
Return type:

bool

get_settings()
Return type:

MixerSettings

get_display()
Return type:

DisplaySettings

get_noise_gate_display_mode()
Return type:

DisplayMode

get_compressor_display_mode()
Return type:

DisplayMode

get_equaliser_display_mode()
Return type:

DisplayMode

get_equaliser_fine_display_mode()
Return type:

DisplayMode

get_mute_hold_duration()
Return type:

int

is_vc_mute_also_mute_cm()
Return type:

bool

get_button_down(button)
Parameters:

button (Button)

Return type:

bool

async wait_for_button(buttons, all_values=False, invert=False)

Waits for the specified button states to be achieved.

Parameters:

  • buttons (List[Button] | Dict[Button, bool]) – List of buttons or dictionary specifying the button states to wait for. - If a list, all buttons are assumed to have the desired state as True (down). - If a dictionary, Key: Button, Value: Desired button state (True for down, False for up).

  • all – Whether to wait for all (instead of any) of the buttons to achieve the desired state.

  • invert (bool) – Whether to check for the opposite button states.

  • all_values (bool)

Return type:

Dict[Button, bool]

get_profile_name()
Return type:

str

get_mic_profile_name()
Return type:

str

get_path(path)

Returns the path of the specified path type.

Parameters:

path (PathType) – The path type to get the path of.

Returns:

The path of the specified path type.

Raises:

ValueError – If the specified path type is invalid.

Return type:

str

get_files(path)

Returns the files of the specified path type.

Parameters:

path (PathType) – The path type to get the files of.

Returns:

The files of the specified path type.

Raises:

ValueError – If the specified path type is invalid.

Return type:

list