|
| 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) |
| |
| SettableStringValue | getStringSetting (final String label, final String category, final int numChars, final String initialText) |
| |
This interface builds the foundation for storing custom settings in Bitwig Studio documents or in the Bitwig Studio preferences.
- Since
- API version 1
Definition at line 9 of file Settings.java.
| 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.
- 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
| 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.
- 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
| 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.
- 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
| 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.
- 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
The documentation for this interface was generated from the following file:
