Class/Object

de.sciss.synth.Server

Config

Related Docs: object Config | package Server

Permalink

final class Config extends ConfigLike

See also

de.sciss.synth.Server.ConfigLike

de.sciss.synth.Server.ConfigBuilder

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

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. val audioBuffers: Int

    Permalink

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

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

    Definition Classes
    ConfigConfigLike
  6. val 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.

    Definition Classes
    ConfigConfigLike
  7. val 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.

    Definition Classes
    ConfigConfigLike
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val controlBusChannels: Int

    Permalink

    The maximum number of control bus channels.

    The maximum number of control bus channels.

    Definition Classes
    ConfigConfigLike
  10. val 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.

    Definition Classes
    ConfigConfigLike
    See also

    deviceNames

  11. val 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.

    Definition Classes
    ConfigConfigLike
    See also

    deviceName

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

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. val 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.

    Definition Classes
    ConfigConfigLike
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. val host: String

    Permalink

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

    Definition Classes
    ConfigConfigLike
  19. val 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.

    Definition Classes
    ConfigConfigLike
  20. val 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.

    Definition Classes
    ConfigConfigLike
  21. 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).

    Definition Classes
    ConfigLike
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. val loadSynthDefs: Boolean

    Permalink

    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.

    Definition Classes
    ConfigConfigLike
  24. val machPortName: Option[(String, String)]

    Permalink

    ?

    ?

    Definition Classes
    ConfigConfigLike
  25. val maxLogins: Int

    Permalink

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

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

    Definition Classes
    ConfigConfigLike
  26. val maxNodes: Int

    Permalink

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

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

    Definition Classes
    ConfigConfigLike
  27. val maxSynthDefs: Int

    Permalink

    The maximum number of synth defs.

    The maximum number of synth defs.

    Definition Classes
    ConfigConfigLike
  28. val 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.

    Definition Classes
    ConfigConfigLike
  29. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  30. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. val nrtCommandPath: String

    Permalink

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

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

    Definition Classes
    ConfigConfigLike
  33. val nrtHeaderFormat: AudioFileType

    Permalink

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

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

    Definition Classes
    ConfigConfigLike
  34. val nrtInputPath: Option[String]

    Permalink

    (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
    ConfigConfigLike
  35. val nrtOutputPath: String

    Permalink

    (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
    ConfigConfigLike
  36. val nrtSampleFormat: SampleFormat

    Permalink

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

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

    Definition Classes
    ConfigConfigLike
  37. val 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.

    Definition Classes
    ConfigConfigLike
  38. val 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.

    Definition Classes
    ConfigConfigLike
  39. val 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.

    Definition Classes
    ConfigConfigLike
  40. val port: Int

    Permalink

    (Realtime) UDP or TCP port used by scsynth.

    (Realtime) UDP or TCP port used by scsynth.

    Definition Classes
    ConfigConfigLike
  41. val 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.

    Definition Classes
    ConfigConfigLike
    See also

    de.sciss.synth.Server#defaultProgramPath

  42. val randomSeeds: Int

    Permalink

    The number of individual random number generators allocated.

    The number of individual random number generators allocated.

    Definition Classes
    ConfigConfigLike
  43. val 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.

    Definition Classes
    ConfigConfigLike
  44. val 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.

    Definition Classes
    ConfigConfigLike
  45. val 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.

    Definition Classes
    ConfigConfigLike
  46. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  47. final def toNonRealtimeArgs: List[String]

    Permalink

    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
  48. final def toRealtimeArgs: List[String]

    Permalink

    Produces a command line for booting scsynth in realtime mode.

    Produces a command line for booting scsynth in realtime mode.

    Definition Classes
    ConfigLike
  49. def toString(): String

    Permalink
    Definition Classes
    Config → AnyRef → Any
  50. val transport: Net

    Permalink

    (Realtime) Open Sound Control transport used by scsynth.

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

    Definition Classes
    ConfigConfigLike
  51. val 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.

    Definition Classes
    ConfigConfigLike
  52. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. val 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.

    Definition Classes
    ConfigConfigLike
  56. val 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.

    Definition Classes
    ConfigConfigLike

Inherited from ConfigLike

Inherited from AnyRef

Inherited from Any

Ungrouped