ConfigBuilder

final class ConfigBuilder extends ConfigLike
class Object
trait Matchable
class Any

Value members

Concrete methods

def audioBuffers: Int

The default number of audio buffers is 1024 (scsynth default). Must be greater than zero and a power of two.

The default number of audio buffers is 1024 (scsynth default). Must be greater than zero and a power of two.

def audioBuffers_=(value: Int): Unit

The default number of audio buffers is 1024 (scsynth default). Must be greater than zero and a power of two.

The default number of audio buffers is 1024 (scsynth default). Must be greater than zero and a power of two.

The default number of audio bus channels is 128 (scsynth default). Must be greater than zero and a power of two. When the builder is converted to a Config, this value may be increased to ensure that audioBusChannels > inputBusChannels + outputBusChannels.

The default number of audio bus channels is 128 (scsynth default). Must be greater than zero and a power of two. When the builder is converted to a Config, this value may be increased to ensure that audioBusChannels > inputBusChannels + outputBusChannels.

def audioBusChannels_=(value: Int): Unit

The default number of audio bus channels is 128 (scsynth default). Must be greater than zero and a power of two. When the builder is converted to a Config, this value may be increased to ensure that audioBusChannels > inputBusChannels + outputBusChannels.

The default number of audio bus channels is 128 (scsynth default). Must be greater than zero and a power of two. When the builder is converted to a Config, this value may be increased to ensure that audioBusChannels > inputBusChannels + outputBusChannels.

def blockSize: Int

The default calculation block size is 64 (scsynth default). Must be greater than zero and a power of two.

The default calculation block size is 64 (scsynth default). Must be greater than zero and a power of two.

def blockSize_=(value: Int): Unit

The default calculation block size is 64 (scsynth default). Must be greater than zero and a power of two.

The default calculation block size is 64 (scsynth default). Must be greater than zero and a power of two.

The default number of control bus channels is 4096 (scsynth default). Must be greater than zero and a power of two.

The default number of control bus channels is 4096 (scsynth default). Must be greater than zero and a power of two.

def controlBusChannels_=(value: Int): Unit

The default number of control bus channels is 4096 (scsynth default). Must be greater than zero and a power of two.

The default number of control bus channels is 4096 (scsynth default). Must be greater than zero and a power of two.

def deviceName: Option[String]

(Realtime) The default input/output device names is None (scsynth default; it will use the system default sound card)

(Realtime) The default input/output device names is None (scsynth default; it will use the system default sound card)

def deviceName_=(value: Option[String]): Unit

(Realtime) The default input/output device names is None (scsynth default; it will use the system default sound card)

(Realtime) The default input/output device names is None (scsynth default; it will use the system default sound card)

def deviceNames: Option[(String, String)]

(Realtime) The default input/output device names is None (scsynth default; it will use the system default sound card)

(Realtime) The default input/output device names is None (scsynth default; it will use the system default sound card)

def deviceNames_=(value: Option[(String, String)]): Unit

(Realtime) The default input/output device names is None (scsynth default; it will use the system default sound card)

(Realtime) The default input/output device names is None (scsynth default; it will use the system default sound card)

(Realtime) The default number of input bus channels is 8 (scsynth default)

(Realtime) The default number of input bus channels is 8 (scsynth default)

def inputBusChannels_=(value: Int): Unit

(Realtime) The default number of input bus channels is 8 (scsynth default)

(Realtime) The default number of input bus channels is 8 (scsynth default)

def isLocal: Boolean

Checks if the currently set host is located on the local machine.

Checks if the currently set host is located on the local machine.

The default number of output bus channels is 8 (scsynth default)

The default number of output bus channels is 8 (scsynth default)

def outputBusChannels_=(value: Int): Unit

The default number of output bus channels is 8 (scsynth default)

The default number of output bus channels is 8 (scsynth default)

def pickPort(): Unit

Picks and assigns a random free port for the server. This implies that the server will be running on the local machine.

Picks and assigns a random free port for the server. This implies that the server will be running on the local machine.

As a result, this method will change this config builder's port value. The caller must ensure that the host and transport fields have been decided on before calling this method. Later changes of either of these will render the result invalid.

This method will fail with runtime exception if the host is not local.

def read(config: Config): Unit
def sampleRate: Int

The default sample rate is 0 (meaning that it is adjusted to the sound card's current rate; scsynth default)

The default sample rate is 0 (meaning that it is adjusted to the sound card's current rate; scsynth default)

def sampleRate_=(value: Int): Unit

The default sample rate is 0 (meaning that it is adjusted to the sound card's current rate; scsynth default)

The default sample rate is 0 (meaning that it is adjusted to the sound card's current rate; scsynth default)

Inherited methods

final def internalBusIndex: Int

A utility method providing the audio bus offset for the start of the internal channels. (simply the sum of outputBusChannels and inputBusChannels).

A utility method providing the audio bus offset for the start of the internal channels. (simply the sum of outputBusChannels and inputBusChannels).

Inherited from
ConfigLike
final def toNonRealtimeArgs: List[String]

Produces a command line for booting scsynth in non-realtime mode.

Produces a command line for booting scsynth in non-realtime mode.

Inherited from
ConfigLike
final def toRealtimeArgs: List[String]

Produces a command line for booting scsynth in realtime mode.

Produces a command line for booting scsynth in realtime mode.

Inherited from
ConfigLike

Concrete fields

(Realtime) The default setting for hardware block size is 0 (meaning that scsynth uses the hardware's current block size; scsynth default)

(Realtime) The default setting for hardware block size is 0 (meaning that scsynth uses the hardware's current block size; scsynth default)

var host: String

(Realtime) The default host name is 127.0.0.1. When booting, this is used to force scsynth to bind to a particular address (-B switch). To avoid the -B switch, you can use "0.0.0.0" (server will be reachable via network).

(Realtime) The default host name is 127.0.0.1. When booting, this is used to force scsynth to bind to a particular address (-B switch). To avoid the -B switch, you can use "0.0.0.0" (server will be reachable via network).

var inputStreamsEnabled: Option[String]

(Realtime) The default settings for enabled input streams is None

(Realtime) The default settings for enabled input streams is None

var loadSynthDefs: Boolean

The default setting for loading synth defs is false (this is not the scsynth default!)

The default setting for loading synth defs is false (this is not the scsynth default!)

var machPortName: Option[(String, String)]

The default settings for mach port name is None (scsynth default)

The default settings for mach port name is None (scsynth default)

var maxLogins: Int

(Realtime) The maximum number of TCP clients is 64 (scsynth default)

(Realtime) The maximum number of TCP clients is 64 (scsynth default)

var maxNodes: Int

The default maximum number of nodes is 1024 (scsynth default)

The default maximum number of nodes is 1024 (scsynth default)

var maxSynthDefs: Int

The default maximum number of synth defs is 1024 (scsynth default)

The default maximum number of synth defs is 1024 (scsynth default)

var memorySize: Int

The default memory size is 65536 (64 KB) (higher than scsynth's default of 8 KB)

The default memory size is 65536 (64 KB) (higher than scsynth's default of 8 KB)

var nrtCommandPath: String
var nrtHeaderFormat: AudioFileType
var nrtInputPath: Option[String]
var nrtOutputPath: String
var nrtSampleFormat: SampleFormat
var outputStreamsEnabled: Option[String]

(Realtime) The default settings for enabled output streams is None

(Realtime) The default settings for enabled output streams is None

var plugInsPaths: List[String]

The default setting for plugin path redirection is Nil (use standard paths; scsynth default)

The default setting for plugin path redirection is Nil (use standard paths; scsynth default)

var port: Int

(Realtime) The default port is 57110.

(Realtime) The default port is 57110.

var program: String

The default program is read from defaultProgram

The default program is read from defaultProgram

See also
var randomSeeds: Int

The default number of random number generators is 64 (scsynth default)

The default number of random number generators is 64 (scsynth default)

var restrictedPath: Option[String]

The default setting for restricting file access is None (scsynth default)

The default setting for restricting file access is None (scsynth default)

var sessionPassword: Option[String]

(Realtime) The default TCP session password is None

(Realtime) The default TCP session password is None

var transport: Transport

(Realtime) The default transport is UDP.

(Realtime) The default transport is UDP.

var verbosity: Int

The default verbosity level is 0 (scsynth default)

The default verbosity level is 0 (scsynth default)

var wireBuffers: Int

The default number of wire buffers is 256 (higher than scsynth's default of 64).

The default number of wire buffers is 256 (higher than scsynth's default of 64).

var zeroConf: Boolean

(Realtime) The default setting for zero-conf is false (other than scsynth's default which is true)

(Realtime) The default setting for zero-conf is false (other than scsynth's default which is true)