Package com.bitwig.extension.controller.api

Interface Settings

All Known Subinterfaces:
DocumentState, Preferences
public interface Settings
This interface builds the foundation for storing custom settings in Bitwig Studio documents or in the Bitwig Studio preferences.
Since:
API version 1

  • Method Details

    • getSignalSetting

      Signal getSignalSetting(String label, String category, String action)
      Returns a signal setting object, which is shown a push button with the given label in Bitwig Studio.
      Parameters:
      label - the name of the setting, must not be `null`
      category - the name of the category, may not be `null`
      action - the action string as displayed on the related Bitwig Studio button, must not be `null`
      Returns:
      the object that encapsulates the requested signal
      Since:
      API version 1

    • getNumberSetting

      SettableRangedValue getNumberSetting(String label, String category, double minValue, double maxValue, double stepResolution, String unit, double initialValue)
      Returns a numeric setting that is shown a number field in Bitwig Studio.
      Parameters:
      label - the name of the setting, must not be `null`
      category - the name of the category, may not be `null`
      minValue - the minimum value that the user is allowed to enter
      maxValue - the minimum value that the user is allowed to enter
      stepResolution - the step resolution used for the number field
      unit - the string that should be used to display the unit of the number
      initialValue - the initial numeric value of the setting
      Returns:
      the object that encapsulates the requested numeric setting
      Since:
      API version 1

    • getEnumSetting

      SettableEnumValue getEnumSetting(String label, String category, String[] options, String initialValue)
      Returns an enumeration setting that is shown either as a chooser or as a button group in Bitwig Studio, depending on the number of provided options.
      Parameters:
      label - the name of the setting, must not be `null`
      category - the name of the category, may not be `null`
      options - the string array that defines the allowed options for the button group or chooser
      initialValue - the initial string value, must be one of the items specified with the option argument
      Returns:
      the object that encapsulates the requested enum setting
      Since:
      API version 1

    • getEnumSetting

      SettableEnumValue getEnumSetting(String label, String category, EnumValueDefinition initialValue)
      Returns an enumeration setting that is shown either as a chooser or as a button group in Bitwig Studio, depending on the number of provided options.
      Parameters:
      label - the name of the setting, must not be `null`
      category - the name of the category, may not be `null`
      initialValue - the initial string value, must be one of the items specified with the option argument
      Returns:
      the object that encapsulates the requested enum setting
      Since:
      API version 11

    • getEnumSettingForValue

      SettableEnumValue getEnumSettingForValue(String label, String category, SettableEnumValue value)
      Returns an enumeration setting that is shown either as a chooser or as a button group in Bitwig Studio, depending on the number of provided options.
      Parameters:
      label - the name of the setting, must not be `null`
      category - the name of the category, may not be `null`
      value - the settable enum value that the setting will be connected to
      Returns:
      the object that encapsulates the requested enum setting
      Since:
      API version 11

    • getStringSetting

      SettableStringValue getStringSetting(String label, String category, int numChars, String initialText)
      Returns a textual setting that is shown as a text field in the Bitwig Studio user interface.
      Parameters:
      label - the name of the setting, must not be `null`
      category - the name of the category, may not be `null`
      numChars - the maximum number of character used for the text value
      initialText - the initial text value of the setting
      Returns:
      the object that encapsulates the requested string setting
      Since:
      API version 1

    • getColorSetting

      SettableColorValue getColorSetting(String label, String category, Color initialColor)
      Returns a color setting that is shown in the Bitwig Studio user interface.
      Parameters:
      label - the name of the setting, must not be `null`
      category - the name of the category, may not be `null`
      initialColor - the initial color value of the setting
      Returns:
      the object that encapsulates the requested string setting
      Since:
      API version 5

    • getColorSettingForValue

      SettableColorValue getColorSettingForValue(String label, String category, SettableColorValue value)
      Returns a color setting that is shown in the Bitwig Studio user interface.
      Parameters:
      label - the name of the setting, must not be `null`
      category - the name of the category, may not be `null`
      value - the color value to which the setting will be connected to
      Returns:
      the object that encapsulates the requested string setting
      Since:
      API version 5

    • getBooleanSetting

      SettableBooleanValue getBooleanSetting(String label, String category, boolean initialValue)
      Returns a boolean setting.
      Parameters:
      label - the name of the setting, must not be `null`
      category - the name of the category, may not be `null`
      initialValue - the initial color value of the setting
      Returns:
      the object that encapsulates the requested string setting
      Since:
      API version 7

    • getBooleanSettingForValue

      SettableBooleanValue getBooleanSettingForValue(String label, String category, SettableBooleanValue value)
      Returns an boolean setting.
      Parameters:
      label - the name of the setting, must not be `null`
      category - the name of the category, may not be `null`
      value - the settable enum value that the setting will be connected to
      Returns:
      the object that encapsulates the requested boolean setting
      Since:
      API version 11