Settings

The Settings object returns plugin specific settings, and functions to get and set their properties.

Class methods

clearMidiLearn

Clears all MIDI CC assignments.

Settings.clearMidiLearn()

crashAndBurn

Calls abort to terminate the program. You can use this to check your crash reporting workflow.

Settings.crashAndBurn()

getAvailableBufferSizes

Returns available buffer sizes for the selected audio device.

Settings.getAvailableBufferSizes()

getAvailableDeviceNames

Returns names of available audio devices.

Settings.getAvailableDeviceNames()

getAvailableDeviceTypes

Returns available audio device types.

Settings.getAvailableDeviceTypes()

getAvailableOutputChannels

Returns array of available output channel pairs.

Settings.getAvailableOutputChannels()

getAvailableSampleRates

Returns array of available sample rate.

Settings.getAvailableSampleRates()

getCurrentAudioDevice

Gets the current audio device name

Settings.getCurrentAudioDevice()

getCurrentAudioDeviceType

Returns the current audio device type.

Settings.getCurrentAudioDeviceType()

getCurrentBufferSize

Returns the current buffer block size.

Settings.getCurrentBufferSize()

getCurrentOutputChannel

Returns current output channel pair.

Settings.getCurrentOutputChannel()

getCurrentSampleRate

Returns the current output sample rate (-1 if no audio device selected)

Settings.getCurrentSampleRate()

getCurrentVoiceMultiplier

Returns current voice amount multiplier setting.

Settings.getCurrentVoiceMultiplier()

getDiskMode

Gets the Streaming Mode (0 -> Fast-SSD, 1 -> Slow-HDD)

Settings.getDiskMode()

getMidiInputDevices

Returns array of MIDI input device names.

Settings.getMidiInputDevices()

getUserDesktopSize

Returns an array of the form [width, height].

Settings.getUserDesktopSize()

getZoomLevel

Returns the UI Zoom factor.

Settings.getZoomLevel()

isMidiChannelEnabled

Returns enabled state of midi channel (0 = All channels).

Settings.isMidiChannelEnabled(int index)

isMidiInputEnabled

Returns enabled state of midi input device.

Settings.isMidiInputEnabled( String midiInputName)

isOpenGLEnabled

Returns whether OpenGL is enabled or not. The return value might be out of sync with the actual state (after you changed this setting until the next reload).

Settings.isOpenGLEnabled()

setAudioDevice

Sets the current audio device

Settings.setAudioDevice(String name)

setAudioDeviceType

Sets the current audio device type

Settings.setAudioDeviceType(String deviceName)

setBufferSize

Sets the buffer block size for the selected audio device.

Settings.setBufferSize(int newBlockSize)

setDiskMode

Sets the Streaming Mode (0 -> Fast-SSD, 1 -> Slow-HDD)

Settings.setDiskMode(int mode)

setEnableDebugMode

Enables or disables debug logging

Settings.setEnableDebugMode(bool shouldBeEnabled)

setEnableOpenGL

Enable OpenGL. This setting will be applied the next time the interface is rebuild.

Settings.setEnableOpenGL(bool shouldBeEnabled)

setOutputChannel

Sets the output channel pair

Settings.setOutputChannel(int index)

setSampleFolder

Changes the sample folder.

Settings.setSampleFolder(var sampleFolder)

setSampleRate

Sets the output sample rate

Settings.setSampleRate(double sampleRate)

setVoiceMultiplier

Sets the voice limit multiplier (1, 2, 4, or 8).

Settings.setVoiceMultiplier(int newVoiceAmount)

setZoomLevel

Changes the UI zoom (1.0 = 100%).

Settings.setZoomLevel(double newLevel)

startPerfettoTracing

Starts the perfetto profile recording.

Settings.startPerfettoTracing()

stopPerfettoTracing

Stops the perfetto profile recording and dumps the data to the given file.

Settings.stopPerfettoTracing(var traceFileToUse)

toggleMidiChannel

Enables or disables MIDI channel (0 = All channels).

Settings.toggleMidiChannel(int index, bool value)

toggleMidiInput

Enables or disables named MIDI input device.

Settings.toggleMidiInput( String midiInputName, bool enableInput)