ConfigLike
The base trait for Config and ConfigBuilder describes the settings used to boot scsynth in
realtime or non-realtime mode, as well as its server address and port.
The base trait for Config and ConfigBuilder describes the settings used to boot scsynth in
realtime or non-realtime mode, as well as its server address and port.
You obtain a ConfigBuilder by calling Server.Config(). This builder can then be mutated and
will be implicitly converted to an immutable Config when required.
See ConfigBuilder for its default values.
- See also
Value members
Abstract methods
The maximum number of audio buffers (for the Buffer class).
The maximum number of audio buffers (for the Buffer class).
The maximum number of audio bus channels. This includes the channels connected
to hardware (outputBusChannels) as well as all channels for internal routing.
The maximum number of audio bus channels. This includes the channels connected
to hardware (outputBusChannels) as well as all channels for internal routing.
The calculation block size. That is, the number of audio samples calculated en-bloc.
This corresponds with the control rate, such that
controlRate := audioRate / blockSize. It should be a power of two.
The calculation block size. That is, the number of audio samples calculated en-bloc.
This corresponds with the control rate, such that
controlRate := audioRate / blockSize. It should be a power of two.
(Realtime) An option denoting the name of the sound card to use. On systems which distinguish
input and output devices (OS X), this implies that both are the same. Otherwise, you can
use the deviceNames method instead.
(Realtime) An option denoting the name of the sound card to use. On systems which distinguish
input and output devices (OS X), this implies that both are the same. Otherwise, you can
use the deviceNames method instead.
- See also
deviceNames
(Realtime) An option denoting the name of the input and output sound device to use. This is for
systems which distinguish input and output devices (OS X). If you use a single device both for
input and output (applies to most professional audio interfaces), you can simply use the
single string method deviceName.
(Realtime) An option denoting the name of the input and output sound device to use. This is for
systems which distinguish input and output devices (OS X). If you use a single device both for
input and output (applies to most professional audio interfaces), you can simply use the
single string method deviceName.
- See also
deviceName
(Realtime) A value to adjust the sound card's hardware block size. Typically you will leave
this to 0 which means that the current block size is used. The block sizes supported depend
on the particular sound card. Lower values decrease latency but may increase CPU load.
(Realtime) A value to adjust the sound card's hardware block size. Typically you will leave
this to 0 which means that the current block size is used. The block sizes supported depend
on the particular sound card. Lower values decrease latency but may increase CPU load.
(Realtime) Host address of scsynth, when trying to connect to an already running server on the net.
(Realtime) Host address of scsynth, when trying to connect to an already running server on the net.
(Realtime) The number of connected audio hardware input channels. This does not need to correspond to the actual number of channels your sound card provides, but can be lower or higher, although a higher value doesn't have any effect as channel indices above the number of channels of the sound card will be treated as internal channels.
(Realtime) The number of connected audio hardware input channels. This does not need to correspond to the actual number of channels your sound card provides, but can be lower or higher, although a higher value doesn't have any effect as channel indices above the number of channels of the sound card will be treated as internal channels.
(Realtime) An option to enable particular input 'streams' or 'bundles' of a sound card.
This is a 'binary' String made of '0' and '1' characters.
If the string is "01100", for example, then only the second and third input streams on
the device will be enabled.
(Realtime) An option to enable particular input 'streams' or 'bundles' of a sound card.
This is a 'binary' String made of '0' and '1' characters.
If the string is "01100", for example, then only the second and third input streams on
the device will be enabled.
Whether scsynth should load synth definitions stored on the hard-disk when booted.
Whether scsynth should load synth definitions stored on the hard-disk when booted.
(Realtime) The maximum number of client connections when using TCP transport.
(Realtime) The maximum number of client connections when using TCP transport.
The maximum number of concurrent nodes (synths and groups).
The maximum number of concurrent nodes (synths and groups).
The maximum number of pre-allocated realtime memory in bytes. This memory
is used for many UGens such as Limiter, DelayN etc. It does not
affect dynamically allocated memory such as audio buffers.
The maximum number of pre-allocated realtime memory in bytes. This memory
is used for many UGens such as Limiter, DelayN etc. It does not
affect dynamically allocated memory such as audio buffers.
(Non-Realtime) Audio file format for writing the output.
(Non-Realtime) Audio file format for writing the output.
(Non-Realtime) Path to the audio input file used as audio input bus supplement.
(Non-Realtime) Path to the audio input file used as audio input bus supplement.
(Non-Realtime) Path to the audio output file used as audio output bus supplement.
(Non-Realtime) Path to the audio output file used as audio output bus supplement.
(Non-Realtime) Audio sample format for writing the output.
(Non-Realtime) Audio sample format for writing the output.
The number of connected audio hardware output channels. This does not need to correspond to the actual number of channels your sound card provides, but can be lower or higher, although a higher value doesn't have any effect as channel indices above the number of channels of the sound card will be treated as internal channels.
The number of connected audio hardware output channels. This does not need to correspond to the actual number of channels your sound card provides, but can be lower or higher, although a higher value doesn't have any effect as channel indices above the number of channels of the sound card will be treated as internal channels.
(Realtime) An option to enable particular output 'streams' or 'bundles' of a sound card.
This is a 'binary' String made of '0' and '1' characters.
If the string is "01100", for example, then only the second and third output streams on
the device will be enabled.
(Realtime) An option to enable particular output 'streams' or 'bundles' of a sound card.
This is a 'binary' String made of '0' and '1' characters.
If the string is "01100", for example, then only the second and third output streams on
the device will be enabled.
An explicit list of paths where DSP plugins are found. Usually this is not specified, and scsynth looks for plugins in their default location.
An explicit list of paths where DSP plugins are found. Usually this is not specified, and scsynth looks for plugins in their default location.
The path to scsynth, used when booting a server. This can be either a relative path
(relating to the JVM's working directory), or an absolute path.
The path to scsynth, used when booting a server. This can be either a relative path
(relating to the JVM's working directory), or an absolute path.
- See also
The number of individual random number generators allocated.
The number of individual random number generators allocated.
An option to restrict access to files (e.g. for loading and saving buffers) to a particular directory. This is a security measure, preventing malicious clients from accessing parts of the hard-disk which they shouldn't.
An option to restrict access to files (e.g. for loading and saving buffers) to a particular directory. This is a security measure, preventing malicious clients from accessing parts of the hard-disk which they shouldn't.
The audio hardware sampling rate to use. A value of 0 indicates that scsynth
should use the current sampling rate of the audio hardware. An explicit setting
will make scsynth try to switch the sound card's sample rate if necessary.
The audio hardware sampling rate to use. A value of 0 indicates that scsynth
should use the current sampling rate of the audio hardware. An explicit setting
will make scsynth try to switch the sound card's sample rate if necessary.
(Realtime) A requires session password when using TCP transport. When using TCP and the password option is set, each client must send the correct password as the first command to the server, otherwise it is rejected.
(Realtime) A requires session password when using TCP transport. When using TCP and the password option is set, each client must send the correct password as the first command to the server, otherwise it is rejected.
(Realtime) Open Sound Control transport used by scsynth. (Either of UDP and TCP).
(Realtime) Open Sound Control transport used by scsynth. (Either of UDP and TCP).
The verbosity level of scsynth. The standard value is 0, while
-1 suppresses informational messages, -2 also suppresses many error messages.
The verbosity level of scsynth. The standard value is 0, while
-1 suppresses informational messages, -2 also suppresses many error messages.
The maximum number of concurrent connections between UGens in a single synth. ScalaCollider performs a depth-first topological sorting of the synth defs, so you should not worry too much about this value. It can become important in very heavy channel expansions and mix-down.
The maximum number of concurrent connections between UGens in a single synth. ScalaCollider performs a depth-first topological sorting of the synth defs, so you should not worry too much about this value. It can become important in very heavy channel expansions and mix-down.
This value will be automatically increased if a more complex def is loaded at startup, but it cannot be increased thereafter without rebooting.
Concrete methods
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).
Produces a command line for booting scsynth in non-realtime mode.
Produces a command line for booting scsynth in non-realtime mode.