Mellite 2.33.0 API - de.sciss.synth.Server.Config

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

val audioBuffers: Int

The maximum number of audio buffers (for the Buffer class).

Definition Classes: Config → ConfigLike

val audioBusChannels: Int

The maximum number of audio bus channels.

The maximum number of audio bus channels. This includes the channels connected to hardware (outputBusChannels) as well as all channels for internal routing.

Definition Classes: Config → ConfigLike

val blockSize: Int

The calculation block size.

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.

Definition Classes: Config → ConfigLike

def clone(): AnyRef

Attributes: protected[java.lang]
Definition Classes: AnyRef
Annotations: @native() @throws( ... )

val controlBusChannels: Int

The maximum number of control bus channels.

Definition Classes: Config → ConfigLike

val deviceName: Option[String]

(Realtime) An option denoting the name of the sound card to use.

(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.

Definition Classes: Config → ConfigLike
See also: deviceNames

val deviceNames: Option[(String, String)]

(Realtime) An option denoting the name of the input and output sound device to use.

(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.

Definition Classes: Config → ConfigLike
See also: deviceName

final def eq(arg0: AnyRef): Boolean

Definition Classes: AnyRef

def equals(arg0: Any): Boolean

Definition Classes: AnyRef → Any

def finalize(): Unit

Attributes: protected[java.lang]
Definition Classes: AnyRef
Annotations: @throws( classOf[java.lang.Throwable] )

final def getClass(): Class[_]

Definition Classes: AnyRef → Any
Annotations: @native()

val hardwareBlockSize: Int

(Realtime) A value to adjust the sound card's hardware block size.

(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.

Definition Classes: Config → ConfigLike

def hashCode(): Int

Definition Classes: AnyRef → Any
Annotations: @native()

val host: String

(Realtime) Host address of scsynth, when trying to connect to an already running server on the net.

Definition Classes: Config → ConfigLike

val inputBusChannels: Int

(Realtime) The number of connected audio hardware input 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.

Definition Classes: Config → ConfigLike

val inputStreamsEnabled: Option[String]

(Realtime) An option to enable particular input 'streams' or 'bundles' of a sound card.

(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.

Definition Classes: Config → 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 outputBusChannels and inputBusChannels).

Definition Classes: ConfigLike

final def isInstanceOf[T0]: Boolean

Definition Classes: Any

val loadSynthDefs: Boolean

Whether scsynth should load synth definitions stored on the hard-disk when booted.

Definition Classes: Config → ConfigLike

val machPortName: Option[(String, String)]

?

Definition Classes: Config → ConfigLike

val maxLogins: Int

(Realtime) The maximum number of client connections when using TCP transport.

Definition Classes: Config → ConfigLike

val maxNodes: Int

The maximum number of concurrent nodes (synths and groups).

Definition Classes: Config → ConfigLike

val maxSynthDefs: Int

The maximum number of synth defs.

Definition Classes: Config → ConfigLike

val memorySize: Int

The maximum number of pre-allocated realtime memory in bytes.

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.

Definition Classes: Config → ConfigLike

final def ne(arg0: AnyRef): Boolean

Definition Classes: AnyRef

final def notify(): Unit

Definition Classes: AnyRef
Annotations: @native()

final def notifyAll(): Unit

Definition Classes: AnyRef
Annotations: @native()

val nrtCommandPath: String

(Non-Realtime) Path to the binary OSC file.

Definition Classes: Config → ConfigLike

val nrtHeaderFormat: AudioFileType

(Non-Realtime) Audio file format for writing the output.

Definition Classes: Config → ConfigLike

val nrtInputPath: Option[String]

(Non-Realtime) Path to the audio input file used as audio input bus supplement.

Definition Classes: Config → ConfigLike

val nrtOutputPath: String

(Non-Realtime) Path to the audio output file used as audio output bus supplement.

Definition Classes: Config → ConfigLike

val nrtSampleFormat: SampleFormat

(Non-Realtime) Audio sample format for writing the output.

Definition Classes: Config → ConfigLike

val outputBusChannels: Int

The number of connected audio hardware output 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.

Definition Classes: Config → ConfigLike

val outputStreamsEnabled: Option[String]

(Realtime) An option to enable particular output 'streams' or 'bundles' of a sound card.

(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.

Definition Classes: Config → ConfigLike

val plugInsPaths: List[String]

An explicit list of paths where DSP plugins are found.

An explicit list of paths where DSP plugins are found. Usually this is not specified, and scsynth looks for plugins in their default location.

Definition Classes: Config → ConfigLike

val port: Int

(Realtime) UDP or TCP port used by scsynth.

Definition Classes: Config → ConfigLike

val program: String

The path to scsynth, used when booting a server.

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.

Definition Classes: Config → ConfigLike
See also: de.sciss.synth.Server#defaultProgram

val randomSeeds: Int

The number of individual random number generators allocated.

Definition Classes: Config → ConfigLike

val restrictedPath: Option[String]

An option to restrict access to files (e.g.

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.

Definition Classes: Config → ConfigLike

val sampleRate: Int

The audio hardware sampling rate to use.

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.

Definition Classes: Config → ConfigLike

val sessionPassword: Option[String]

(Realtime) A requires session password when using TCP transport.

(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.

Definition Classes: Config → 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.

Definition Classes: ConfigLike

final def toRealtimeArgs: List[String]

Produces a command line for booting scsynth in realtime mode.

Definition Classes: ConfigLike

def toString(): String

Definition Classes: Config → AnyRef → Any

val transport: Net

(Realtime) Open Sound Control transport used by scsynth.

(Realtime) Open Sound Control transport used by scsynth. (Either of UDP and TCP).

Definition Classes: Config → ConfigLike

val verbosity: Int

The verbosity level of scsynth.

The verbosity level of scsynth. The standard value is 0, while -1 suppresses informational messages, -2 also suppresses many error messages.

Definition Classes: Config → ConfigLike

final def wait(): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

final def wait(arg0: Long, arg1: Int): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

final def wait(arg0: Long): Unit

Definition Classes: AnyRef
Annotations: @native() @throws( ... )

val wireBuffers: Int

The maximum number of concurrent connections between UGens in a single synth.

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.

Definition Classes: Config → ConfigLike

val zeroConf: Boolean

(Realtime) Whether to announce scsynth's OSC service via zero conf.

(Realtime) Whether to announce scsynth's OSC service via zero conf. See Wikipedia for more details.

Definition Classes: Config → ConfigLike

Packages

Welcome to the Mellite API documentation.

Config

Companion object Config

final class Config extends ConfigLike

Value Members

Inherited from ConfigLike

Inherited from AnyRef

Inherited from Any

Ungrouped