Bitwig Studio Control Surface API
5.0.11
|
Public Member Functions | |
Signal | getSignalSetting (final String label, final String category, final String action) |
SettableRangedValue | getNumberSetting (final String label, final String category, final double minValue, final double maxValue, final double stepResolution, final String unit, final double initialValue) |
SettableEnumValue | getEnumSetting (final String label, final String category, final String[] options, final String initialValue) |
SettableEnumValue | getEnumSetting (final String label, final String category, final EnumValueDefinition initialValue) |
SettableEnumValue | getEnumSettingForValue (final String label, final String category, final SettableEnumValue value) |
SettableStringValue | getStringSetting (final String label, final String category, final int numChars, final String initialText) |
SettableColorValue | getColorSetting (final String label, final String category, final Color initialColor) |
SettableColorValue | getColorSettingForValue (final String label, final String category, final SettableColorValue value) |
SettableBooleanValue | getBooleanSetting (final String label, final String category, final boolean initialValue) |
SettableBooleanValue | getBooleanSettingForValue (final String label, final String category, final SettableBooleanValue value) |
This interface builds the foundation for storing custom settings in Bitwig Studio documents or in the Bitwig Studio preferences.
SettableBooleanValue getBooleanSetting | ( | final String | label, |
final String | category, | ||
final boolean | initialValue | ||
) |
Returns a boolean setting.
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 |
SettableBooleanValue getBooleanSettingForValue | ( | final String | label, |
final String | category, | ||
final SettableBooleanValue | value | ||
) |
Returns an boolean setting.
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 |
SettableColorValue getColorSetting | ( | final String | label, |
final String | category, | ||
final Color | initialColor | ||
) |
Returns a color setting that is shown in the Bitwig Studio user interface.
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 |
SettableColorValue getColorSettingForValue | ( | final String | label, |
final String | category, | ||
final SettableColorValue | value | ||
) |
Returns a color setting that is shown in the Bitwig Studio user interface.
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 |
SettableEnumValue getEnumSetting | ( | final String | label, |
final String | category, | ||
final 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.
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 |
SettableEnumValue getEnumSetting | ( | final String | label, |
final String | category, | ||
final String[] | options, | ||
final 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.
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 |
SettableEnumValue getEnumSettingForValue | ( | final String | label, |
final String | category, | ||
final 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.
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 |
SettableRangedValue getNumberSetting | ( | final String | label, |
final String | category, | ||
final double | minValue, | ||
final double | maxValue, | ||
final double | stepResolution, | ||
final String | unit, | ||
final double | initialValue | ||
) |
Returns a numeric setting that is shown a number field in Bitwig Studio.
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 |
Signal getSignalSetting | ( | final String | label, |
final String | category, | ||
final String | action | ||
) |
Returns a signal setting object, which is shown a push button with the given label in Bitwig Studio.
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 |
SettableStringValue getStringSetting | ( | final String | label, |
final String | category, | ||
final int | numChars, | ||
final String | initialText | ||
) |
Returns a textual setting that is shown as a text field in the Bitwig Studio user interface.
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 |