Bitwig Studio Control Surface API  5.0.11
Settings Interface Reference
+ Inheritance diagram for Settings:

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)
 

Detailed Description

This interface builds the foundation for storing custom settings in Bitwig Studio documents or in the Bitwig Studio preferences.

Since
API version 1

Member Function Documentation

◆ getBooleanSetting()

SettableBooleanValue getBooleanSetting ( final String  label,
final String  category,
final boolean  initialValue 
)

Returns a boolean setting.

Parameters
labelthe name of the setting, must not be null
categorythe name of the category, may not be null
initialValuethe initial color value of the setting
Returns
the object that encapsulates the requested string setting
Since
API version 7

◆ getBooleanSettingForValue()

SettableBooleanValue getBooleanSettingForValue ( final String  label,
final String  category,
final SettableBooleanValue  value 
)

Returns an boolean setting.

Parameters
labelthe name of the setting, must not be null
categorythe name of the category, may not be null
valuethe settable enum value that the setting will be connected to
Returns
the object that encapsulates the requested boolean setting
Since
API version 11

◆ getColorSetting()

SettableColorValue getColorSetting ( final String  label,
final String  category,
final Color  initialColor 
)

Returns a color setting that is shown in the Bitwig Studio user interface.

Parameters
labelthe name of the setting, must not be null
categorythe name of the category, may not be null
initialColorthe initial color value of the setting
Returns
the object that encapsulates the requested string setting
Since
API version 5

◆ getColorSettingForValue()

SettableColorValue getColorSettingForValue ( final String  label,
final String  category,
final SettableColorValue  value 
)

Returns a color setting that is shown in the Bitwig Studio user interface.

Parameters
labelthe name of the setting, must not be null
categorythe name of the category, may not be null
valuethe color value to which the setting will be connected to
Returns
the object that encapsulates the requested string setting
Since
API version 5

◆ getEnumSetting() [1/2]

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.

Parameters
labelthe name of the setting, must not be null
categorythe name of the category, may not be null
initialValuethe 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

◆ getEnumSetting() [2/2]

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
labelthe name of the setting, must not be null
categorythe name of the category, may not be null
optionsthe string array that defines the allowed options for the button group or chooser
initialValuethe 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

◆ getEnumSettingForValue()

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.

Parameters
labelthe name of the setting, must not be null
categorythe name of the category, may not be null
valuethe settable enum value that the setting will be connected to
Returns
the object that encapsulates the requested enum setting
Since
API version 11

◆ getNumberSetting()

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
labelthe name of the setting, must not be null
categorythe name of the category, may not be null
minValuethe minimum value that the user is allowed to enter
maxValuethe minimum value that the user is allowed to enter
stepResolutionthe step resolution used for the number field
unitthe string that should be used to display the unit of the number
initialValuethe initial numeric value of the setting
Returns
the object that encapsulates the requested numeric setting
Since
API version 1

◆ getSignalSetting()

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
labelthe name of the setting, must not be null
categorythe name of the category, may not be null
actionthe 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

◆ getStringSetting()

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
labelthe name of the setting, must not be null
categorythe name of the category, may not be null
numCharsthe maximum number of character used for the text value
initialTextthe 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: