Trait

de.sciss.synth.Server

ConfigLike

Related Doc: package Server

Permalink

trait ConfigLike extends AnyRef

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

de.sciss.synth.Server.Config

de.sciss.synth.Server.ConfigBuilder

Linear Supertypes
AnyRef, Any
Known Subclasses
Config, ConfigBuilder
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigLike
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def audioBuffers: Int

    Permalink

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

  2. abstract def audioBusChannels: Int

    Permalink

    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.

  3. abstract def blockSize: Int

    Permalink

    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.

  4. abstract def controlBusChannels: Int

    Permalink

    The maximum number of control bus channels.

  5. abstract def deviceName: Option[String]

    Permalink

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

    See also

    deviceNames

  6. abstract def deviceNames: Option[(String, String)]

    Permalink

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

    See also

    deviceName

  7. abstract def hardwareBlockSize: Int

    Permalink

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

  8. abstract def host: String

    Permalink

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

  9. abstract def inputBusChannels: Int

    Permalink

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

  10. abstract def inputStreamsEnabled: Option[String]

    Permalink

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

  11. abstract def loadSynthDefs: Boolean

    Permalink

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

  12. abstract def machPortName: Option[(String, String)]

    Permalink

    ?

  13. abstract def maxLogins: Int

    Permalink

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

  14. abstract def maxNodes: Int

    Permalink

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

  15. abstract def maxSynthDefs: Int

    Permalink

    The maximum number of synth defs.

  16. abstract def memorySize: Int

    Permalink

    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.

  17. abstract def nrtCommandPath: String

    Permalink

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

  18. abstract def nrtHeaderFormat: AudioFileType

    Permalink

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

  19. abstract def nrtInputPath: Option[String]

    Permalink

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

  20. abstract def nrtOutputPath: String

    Permalink

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

  21. abstract def nrtSampleFormat: SampleFormat

    Permalink

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

  22. abstract def outputBusChannels: Int

    Permalink

    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.

  23. abstract def outputStreamsEnabled: Option[String]

    Permalink

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

  24. abstract def plugInsPaths: List[String]

    Permalink

    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.

  25. abstract def port: Int

    Permalink

    (Realtime) UDP or TCP port used by scsynth.

  26. abstract def program: String

    Permalink

    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.

    See also

    de.sciss.synth.Server#defaultProgramPath

  27. abstract def randomSeeds: Int

    Permalink

    The number of individual random number generators allocated.

  28. abstract def restrictedPath: Option[String]

    Permalink

    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.

  29. abstract def sampleRate: Int

    Permalink

    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.

  30. abstract def sessionPassword: Option[String]

    Permalink

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

  31. abstract def transport: Net

    Permalink

    (Realtime) Open Sound Control transport used by scsynth.

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

  32. abstract def verbosity: Int

    Permalink

    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.

  33. abstract def wireBuffers: Int

    Permalink

    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.

  34. abstract def zeroConf: Boolean

    Permalink

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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

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

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

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

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def internalBusIndex: Int

    Permalink

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

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  17. final def toNonRealtimeArgs: List[String]

    Permalink

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

  18. final def toRealtimeArgs: List[String]

    Permalink

    Produces a command line for booting scsynth in realtime mode.

  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def wait(): Unit

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

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

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

  22. final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped