GuiParams

Table of contents

1. Description
2. Accessing the UI Parameters

---

Description

The GuiParams data type contains the status and value of the specified daw parameters. These values are updated in real time and can be accessed in any thread.

Remember that the values can be modified/automated by the user in the DAW, or via the GUI.

Accessing the UI Parameters

The UI parameters can be accessed in any thread using the following methods. To access the UI parameters, all you need to reference the element is the name you gave it in the previous step.

If you need to access information from the GUI, you can do so by using the following methods:

Rotary/Sliders: gui_params.getValueFor([slider/rotary name])
Toggle Buttons: gui_params.isToggleButtonOn([button name])
Trigger Buttons: gui_params.wasButtonClicked([button name])

For example, if you have a slider named “Slider 1”, a toggle button named “ToggleButton 1”, and a trigger button named “TriggerButton 1”, you can access them like this:

auto Slider1 = gui_params.getValueFor("Slider 1");
auto ToggleButton1 = gui_params.isToggleButtonOn("ToggleButton 1");
auto ButtonTrigger = gui_params.wasButtonClicked("TriggerButton 1");

If you only need this data when the GUI parameters CHANGE, you can use the provided gui_params_changed_since_last_call flag

    if (gui_params_changed_since_last_call) {
        auto Slider1 = gui_params.getValueFor("Slider 1");
        auto ToggleButton1 = gui_params.isToggleButtonOn("ToggleButton 1");
        auto ButtonTrigger = gui_params.wasButtonClicked("TriggerButton 1");
    }

You should be careful about the following:

1. The name of the parameter is case sensitive

2. The name of the parameter is the same as the name you gave it in the GUI

3. You should use the right method for the right type of parameter (slider, toggle button, trigger button). That is, you should use getValueFor for sliders/rotaries and isToggleButtonOn for toggle buttons, and wasButtonClicked for trigger buttons.