final class ConfigBuilder extends ConfigLike
- Alphabetic
- By Inheritance
- ConfigBuilder
- ConfigLike
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def audioBuffers: Int
The default number of audio buffers is
1024(scsynth default).The default number of audio buffers is
1024(scsynth default). Must be greater than zero and a power of two.- Definition Classes
- ConfigBuilder → ConfigLike
- def audioBuffers_=(value: Int): Unit
The default number of audio buffers is
1024(scsynth default).The default number of audio buffers is
1024(scsynth default). Must be greater than zero and a power of two. - def audioBusChannels: Int
The default number of audio bus channels is
128(scsynth default).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 aConfig, this value may be increased to ensure thataudioBusChannels > inputBusChannels + outputBusChannels.- Definition Classes
- ConfigBuilder → ConfigLike
- def audioBusChannels_=(value: Int): Unit
The default number of audio bus channels is
128(scsynth default).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 aConfig, this value may be increased to ensure thataudioBusChannels > inputBusChannels + outputBusChannels. - def blockSize: Int
The default calculation block size is
64(scsynth default).The default calculation block size is
64(scsynth default). Must be greater than zero and a power of two.- Definition Classes
- ConfigBuilder → ConfigLike
- def blockSize_=(value: Int): Unit
The default calculation block size is
64(scsynth default).The default calculation block size is
64(scsynth default). Must be greater than zero and a power of two. - def build: Config
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def controlBusChannels: Int
The default number of control bus channels is
4096(scsynth default).The default number of control bus channels is
4096(scsynth default). Must be greater than zero and a power of two.- Definition Classes
- ConfigBuilder → ConfigLike
- def controlBusChannels_=(value: Int): Unit
The default number of control bus channels is
4096(scsynth default).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)- Definition Classes
- ConfigBuilder → ConfigLike
- 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) - 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)- Definition Classes
- ConfigBuilder → ConfigLike
- 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) - final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- var hardwareBlockSize: Int
(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)- Definition Classes
- ConfigBuilder → ConfigLike
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- var host: String
(Realtime) The default host name is
127.0.0.1.(Realtime) The default host name is
127.0.0.1. When booting, this is used to force scsynth to bind to a particular address (-Bswitch). To avoid the-Bswitch, you can use"0.0.0.0"(server will be reachable via network).- Definition Classes
- ConfigBuilder → ConfigLike
- def inputBusChannels: Int
(Realtime) The default number of input bus channels is
8(scsynth default)(Realtime) The default number of input bus channels is
8(scsynth default)- Definition Classes
- ConfigBuilder → ConfigLike
- def inputBusChannels_=(value: Int): Unit
(Realtime) The default number of input bus channels is
8(scsynth default) - var inputStreamsEnabled: Option[String]
(Realtime) The default settings for enabled input streams is
None(Realtime) The default settings for enabled input streams is
None- Definition Classes
- ConfigBuilder → ConfigLike
- final def internalBusIndex: Int
A utility method providing the audio bus offset for the start of the internal channels.
A utility method providing the audio bus offset for the start of the internal channels. (simply the sum of
outputBusChannelsandinputBusChannels).- Definition Classes
- ConfigLike
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isLocal: Boolean
Checks if the currently set
hostis located on the local machine. - 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!)- Definition Classes
- ConfigBuilder → ConfigLike
- 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)- Definition Classes
- ConfigBuilder → ConfigLike
- 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)- Definition Classes
- ConfigBuilder → ConfigLike
- var maxNodes: Int
The default maximum number of nodes is
1024(scsynth default)The default maximum number of nodes is
1024(scsynth default)- Definition Classes
- ConfigBuilder → ConfigLike
- 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)- Definition Classes
- ConfigBuilder → ConfigLike
- 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)- Definition Classes
- ConfigBuilder → ConfigLike
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- var nrtCommandPath: String
(Non-Realtime) Path to the binary OSC file.
(Non-Realtime) Path to the binary OSC file.
- Definition Classes
- ConfigBuilder → ConfigLike
- var nrtHeaderFormat: AudioFileType
(Non-Realtime) Audio file format for writing the output.
(Non-Realtime) Audio file format for writing the output.
- Definition Classes
- ConfigBuilder → ConfigLike
- var nrtInputPath: Option[String]
(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.
- Definition Classes
- ConfigBuilder → ConfigLike
- var nrtOutputPath: String
(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.
- Definition Classes
- ConfigBuilder → ConfigLike
- var nrtSampleFormat: SampleFormat
(Non-Realtime) Audio sample format for writing the output.
(Non-Realtime) Audio sample format for writing the output.
- Definition Classes
- ConfigBuilder → ConfigLike
- def outputBusChannels: Int
The default number of output bus channels is
8(scsynth default)The default number of output bus channels is
8(scsynth default)- Definition Classes
- ConfigBuilder → ConfigLike
- def outputBusChannels_=(value: Int): Unit
The default number of output bus channels is
8(scsynth default) - var outputStreamsEnabled: Option[String]
(Realtime) The default settings for enabled output streams is
None(Realtime) The default settings for enabled output streams is
None- Definition Classes
- ConfigBuilder → ConfigLike
- def pickPort(): Unit
Picks and assigns a random free port for the server.
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
portvalue. The caller must ensure that thehostandtransportfields 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.
- 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)- Definition Classes
- ConfigBuilder → ConfigLike
- var port: Int
(Realtime) The default port is
57110.(Realtime) The default port is
57110.- Definition Classes
- ConfigBuilder → ConfigLike
- var program: String
The default
programis read fromdefaultProgramThe default
programis read fromdefaultProgram- Definition Classes
- ConfigBuilder → ConfigLike
- 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)- Definition Classes
- ConfigBuilder → ConfigLike
- def read(config: Config): Unit
- 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)- Definition Classes
- ConfigBuilder → ConfigLike
- 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)- Definition Classes
- ConfigBuilder → ConfigLike
- 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) - var sessionPassword: Option[String]
(Realtime) The default TCP session password is
None(Realtime) The default TCP session password is
None- Definition Classes
- ConfigBuilder → ConfigLike
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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.
- Definition Classes
- 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.
- Definition Classes
- ConfigLike
- def toString(): String
- Definition Classes
- AnyRef → Any
- var transport: Transport
(Realtime) The default transport is
UDP.(Realtime) The default transport is
UDP.- Definition Classes
- ConfigBuilder → ConfigLike
- var verbosity: Int
The default verbosity level is
0(scsynth default).The default verbosity level is
0(scsynth default).Note: currently, decreasing the verbosity prevents the server connection to notice when the server has booted (issue no. 98).
- Definition Classes
- ConfigBuilder → ConfigLike
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- var wireBuffers: Int
The default number of wire buffers is
256(higher than scsynth's default of64).The default number of wire buffers is
256(higher than scsynth's default of64).- Definition Classes
- ConfigBuilder → ConfigLike
- var zeroConf: Boolean
(Realtime) The default setting for zero-conf is
false(other than scsynth's default which istrue)(Realtime) The default setting for zero-conf is
false(other than scsynth's default which istrue)- Definition Classes
- ConfigBuilder → ConfigLike
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated