Settings

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

Class methods

clearMidiLearn

Clears all MIDI CC assignments. Edit on GitHub

Settings.clearMidiLearn()

crashAndBurn

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

Settings.crashAndBurn()

getAvailableBufferSizes

Returns available buffer sizes for the selected audio device. Edit on GitHub

Settings.getAvailableBufferSizes()

getAvailableDeviceNames

Returns names of available audio devices. Edit on GitHub

Settings.getAvailableDeviceNames()

getAvailableDeviceTypes

Returns available audio device types. Edit on GitHub

Settings.getAvailableDeviceTypes()

getAvailableOutputChannels

Returns array of available output channel pairs. Edit on GitHub

Settings.getAvailableOutputChannels()

getAvailableSampleRates

Returns array of available sample rate. Edit on GitHub

Settings.getAvailableSampleRates()

getCurrentAudioDevice

Gets the current audio device name Edit on GitHub

Settings.getCurrentAudioDevice()

getCurrentAudioDeviceType

Returns the current audio device type. Edit on GitHub

Settings.getCurrentAudioDeviceType()

getCurrentBufferSize

Returns the current buffer block size. Edit on GitHub

Settings.getCurrentBufferSize()

getCurrentOutputChannel

Returns current output channel pair. Edit on GitHub

Settings.getCurrentOutputChannel()

getCurrentSampleRate

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

Settings.getCurrentSampleRate()

getCurrentVoiceMultiplier

Returns current voice amount multiplier setting. Edit on GitHub

Settings.getCurrentVoiceMultiplier()

getDiskMode

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

Settings.getDiskMode()

getMidiInputDevices

Returns array of MIDI input device names. Edit on GitHub

Settings.getMidiInputDevices()

getUserDesktopSize

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

Settings.getUserDesktopSize()

getZoomLevel

Returns the UI Zoom factor. Edit on GitHub

Settings.getZoomLevel()

isMidiChannelEnabled

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

Settings.isMidiChannelEnabled(int index)

isMidiInputEnabled

Returns enabled state of midi input device. Edit on GitHub

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). Edit on GitHub

Settings.isOpenGLEnabled()

setAudioDevice

Sets the current audio device Edit on GitHub

Settings.setAudioDevice(String name)

setAudioDeviceType

Sets the current audio device type Edit on GitHub

Settings.setAudioDeviceType(String deviceName)

setBufferSize

Sets the buffer block size for the selected audio device. Edit on GitHub

Settings.setBufferSize(int newBlockSize)

setDiskMode

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

Settings.setDiskMode(int mode)

setEnableDebugMode

Enables or disables debug logging Edit on GitHub

Settings.setEnableDebugMode(bool shouldBeEnabled)

setEnableOpenGL

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

Settings.setEnableOpenGL(bool shouldBeEnabled)

setOutputChannel

Sets the output channel pair Edit on GitHub

Settings.setOutputChannel(int index)

setSampleFolder

Changes the sample folder. Edit on GitHub

Settings.setSampleFolder(var sampleFolder)

setSampleRate

Sets the output sample rate Edit on GitHub

Settings.setSampleRate(double sampleRate)

setVoiceMultiplier

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

Settings.setVoiceMultiplier(int newVoiceAmount)

setZoomLevel

Changes the UI zoom (1.0 = 100%). Edit on GitHub

Settings.setZoomLevel(double newLevel)

startPerfettoTracing

Starts the perfetto profile recording. Edit on GitHub

Settings.startPerfettoTracing()

stopPerfettoTracing

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

Settings.stopPerfettoTracing(var traceFileToUse)

toggleMidiChannel

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

Settings.toggleMidiChannel(int index, bool value)

toggleMidiInput

Enables or disables named MIDI input device. Edit on GitHub

Settings.toggleMidiInput( String midiInputName, bool enableInput)