Type Members

1.  sealed trait AsyncSend extends Send

   Identifies messages sent to the server which are executed asynchronously and reply with a form of done-message.

2.  final case class BufferAlloc(id: Int, numFrames: Int, numChannels: Int, completion: Option[Packet]) extends Message with HasCompletion with Product with Serializable

   The /b_alloc message tells the server to allocate memory for a buffer associated with its logical identifier.

   The /b_alloc message tells the server to allocate memory for a buffer associated with its logical identifier.

   See also

   Buffer#allocMsg

   BufferFree

   BufferAllocRead

   BufferAllocReadChannel

3.  final case class BufferAllocRead(id: Int, path: String, startFrame: Int, numFrames: Int, completion: Option[Packet]) extends Message with HasCompletion with Product with Serializable

   The /b_allocRead message tells the server to allocate memory for a buffer and read in a portion of an audio-file.

   The /b_allocRead message tells the server to allocate memory for a buffer and read in a portion of an audio-file. The number of channels and the sample-rate of the buffer are determined by that audio-file.

   id

   the identifier to use for the buffer. It must denote a currently un-allocated buffer and be greater than or equal to zero and less than the maximum number of buffers.

   path

   the path of the audio-file to read. Since the server is an independent process, this must resolve with respect to the server's current working directory. If the server is running on a remote node, the path will be resolved in the server's local file system.

   startFrame

   the offset in frames into the audio-file to begin reading from

   numFrames

   the number of frames to read which will be the size of the allocated buffer. The special value less than or equal to zero denotes that the number of frames available in the file from the given offset is used (the entire file will be read).

   See also

   Buffer#allocReadMsg

   BufferFree

   BufferAlloc

   BufferAllocReadChannel

   BufferRead

4.  final case class BufferAllocReadChannel(id: Int, path: String, startFrame: Int, numFrames: Int, channels: List[Int], completion: Option[Packet]) extends Message with HasCompletion with Product with Serializable

   The /b_allocReadChannel message tells the server to allocate memory for a buffer and read in a portion of an audio-file, selecting a subset of its channels.

   The /b_allocReadChannel message tells the server to allocate memory for a buffer and read in a portion of an audio-file, selecting a subset of its channels. The number of channels is given by the size of the channels argument, and the sample-rate of the buffer is determined by the audio-file.

   id

   the identifier to use for the buffer. It must denote a currently un-allocated buffer and be greater than or equal to zero and less than the maximum number of buffers.

   path

   the path of the audio-file to read. Since the server is an independent process, this must resolve with respect to the server's current working directory. If the server is running on a remote node, the path will be resolved in the server's local file system.

   startFrame

   the offset in frames into the audio-file to begin reading from

   numFrames

   the number of frames to read which will be the size of the allocated buffer. The special value of -1 denotes that the number of frames available in the file from the given offset is used (the entire file will be read).

   channels

   a sequence of channel indices to read. Zero corresponds to the first channel of the file.

   See also

   Buffer#allocReadChannelMsg

   BufferFree

   BufferAlloc

   BufferAllocRead

   BufferReadChannel

5.  final case class BufferClose(id: Int, completion: Option[Packet]) extends Message with HasCompletion with Product with Serializable

   The /b_close message ensures that a buffer closes an associated audio-file.

   The /b_close message ensures that a buffer closes an associated audio-file. This is a no-op if the buffer is not associated with an audio-file or if that file is already closed.

   See also

   Buffer#closeMsg

   BufferFree

   BufferAlloc

6.  final case class BufferFill(id: Int, ranges: FillRange*) extends Message with SyncCmd with Product with Serializable

   The /b_fill message sets individual ranges of samples of the buffer to given values.

   The /b_fill message sets individual ranges of samples of the buffer to given values.

   id

   the identifier of the buffer whose contents to write.

   ranges

   tuples which specify the offset into the buffer, the number of samples to overwrite and the value with which to overwrite.

   See also

   Buffer#fillMsg

   BufferSet

   BufferSetn

   BufferZero

   BufferGen

7.  final case class BufferFree(id: Int, completion: Option[Packet]) extends Message with HasCompletion with Product with Serializable

   The /b_free message frees a buffer on the server side.

   The /b_free message frees a buffer on the server side. The client side typically maintains a logical list of allocated buffer identifiers as well, so one should normally rely on the specific client side API to correctly free a buffer.

   See also

   Buffer#freeMsg

   BufferClose

   BufferAlloc

8.  final case class BufferGen(id: Int, command: Command) extends Message with AsyncSend with Product with Serializable

   The /b_gen message uses a dedicated command to generate or manipulate the buffer content.

   The /b_gen message uses a dedicated command to generate or manipulate the buffer content.

   id

   the identifier of the buffer whose contents to write.

   command

   the operation to carry out on the buffer, such as generating a waveform or copying the content

   See also

   Buffer#genMsg

   BufferSet

   BufferSetn

   BufferZero

   BufferFill

9.  final case class BufferGet(id: Int, index: Int*) extends Message with SyncQuery with Product with Serializable

   The /b_get message.

   The /b_get message.

   See also

   Buffer#getMsg

   BufferGetn

   BufferSet

10.  final case class BufferGetn(id: Int, ranges: Range*) extends Message with SyncQuery with Product with Serializable

    The /b_getn message.

    The /b_getn message.

    id

    the buffer identifier

    ranges

    the ranges of sample indices to obtain. For multi-channel buffers, this means if one wants to specify a particular range of frames, the frame indices must be multiplied by the number of channels

    See also

    Buffer#getnMsg

    BufferGet

    BufferSetn

11.  final case class BufferInfo(data: Data*) extends Message with Receive with Product with Serializable

    A /b_info message is received in reply to a /b_query message.

    A /b_info message is received in reply to a /b_query message.

    See also

    BufferQuery

12.  final case class BufferQuery(ids: Int*) extends Message with SyncQuery with Product with Serializable

    The /b_query messages requests a /b_info reply message from the server, providing information about the size and sample-rate of the specified buffers.

    The /b_query messages requests a /b_info reply message from the server, providing information about the size and sample-rate of the specified buffers.

    ids

    a sequence of buffer identifiers to query

    See also

    Buffer#queryMsg

13.  final case class BufferRead(id: Int, path: String, fileStartFrame: Int, numFrames: Int, bufStartFrame: Int, leaveOpen: Boolean, completion: Option[Packet]) extends Message with HasCompletion with Product with Serializable

    The /b_read message tells the server to read a portion of an audio-file into an existing buffer.

    The /b_read message tells the server to read a portion of an audio-file into an existing buffer.

    id

    the identifier of the buffer to read into.

    path

    the path of the audio-file to read.

    fileStartFrame

    the offset in frames into the audio-file to begin reading from

    numFrames

    the number of frames to read which will be the size of the allocated buffer. The special value of -1 denotes that as many frames are read as are available in the file or fit into the buffer.

    bufStartFrame

    the frame offset in the buffer to begin writing to.

    leaveOpen

    if true, leaves the file open for streaming with the DiskIn UGen.

    See also

    Buffer#readMsg

    BufferAllocRead

    BufferReadChannel

14.  final case class BufferReadChannel(id: Int, path: String, fileStartFrame: Int, numFrames: Int, bufStartFrame: Int, leaveOpen: Boolean, channels: List[Int], completion: Option[Packet]) extends Message with HasCompletion with Product with Serializable

    The /b_readChannel message tells the server to read a portion of an audio-file into an existing buffer, selecting a subset of the file's channels.

    The /b_readChannel message tells the server to read a portion of an audio-file into an existing buffer, selecting a subset of the file's channels.

    id

    the identifier of the buffer to read into.

    path

    the path of the audio-file to read.

    fileStartFrame

    the offset in frames into the audio-file to begin reading from

    numFrames

    the number of frames to read which will be the size of the allocated buffer. The special value of -1 denotes that as many frames are read as are available in the file or fit into the buffer.

    bufStartFrame

    the frame offset in the buffer to begin writing to.

    leaveOpen

    if true, leaves the file open for streaming with the DiskIn UGen.

    channels

    a sequence of channel indices to read. Zero corresponds to the first channel of the file.

    See also

    Buffer#readChannelMsg

    BufferAllocReadChannel

    BufferRead

15.  final case class BufferSet(id: Int, pairs: FillValue*) extends Message with SyncCmd with Product with Serializable

    The /b_set message sets individual samples of the buffer to given values.

    The /b_set message sets individual samples of the buffer to given values.

    id

    the identifier of the buffer whose contents to write.

    pairs

    pairs of sample offsets and sample values. The offsets are de-interleaved samples, so for multi-channel buffers, to address a particular frame, the frame index must be multiplied by the number of channels and offset by the channel to write into.

    See also

    Buffer#setMsg

    BufferSetn

    BufferFill

    BufferZero

    BufferGen

16.  final case class BufferSetn(id: Int, indicesAndValues: (Int, IndexedSeq[Float])*) extends Message with SyncCmd with Product with Serializable

    The /b_setn message sets individual ranges of samples of the buffer to given values.

    The /b_setn message sets individual ranges of samples of the buffer to given values.

    id

    the identifier of the buffer whose contents to write.

    indicesAndValues

    pairs of sample offsets and sequences of sample values. The offsets are de-interleaved samples, so for multi-channel buffers, to address a particular frame, the frame index must be multiplied by the number of channels and offset by the channel to write into.

    See also

    Buffer#setnMsg

    BufferSet

    BufferFill

    BufferZero

    BufferGen

17.  final case class BufferWrite(id: Int, path: String, fileType: AudioFileType, sampleFormat: SampleFormat, numFrames: Int, startFrame: Int, leaveOpen: Boolean, completion: Option[Packet]) extends Message with HasCompletion with Product with Serializable

    The /b_write message writes a portion of the buffer contents to an audio-file.

    The /b_write message writes a portion of the buffer contents to an audio-file.

    id

    the identifier of the buffer whose contents to write.

    path

    the path of the audio-file to write to.

    fileType

    the header format of the audio-file

    sampleFormat

    the sample resolution of the audio-file

    numFrames

    the number of frames to write. The special value of -1 denotes that the whole buffer content (or the remainder after the startFrame) is written out.

    startFrame

    the frame offset in the buffer to begin reading from

    leaveOpen

    if true, leaves the file open for streaming with the DiskOut UGen.

    See also

    Buffer#writeMsg

    BufferRead

18.  final case class BufferZero(id: Int, completion: Option[Packet]) extends Message with HasCompletion with Product with Serializable

    The /b_zero message clears the contents of a buffer (all samples will be zero).

    The /b_zero message clears the contents of a buffer (all samples will be zero).

    See also

    Buffer#zeroMsg

    BufferFill

    BufferSet

    BufferSetn

    BufferGen

19.  final case class ControlBusFill(ranges: FillRange*) extends Message with SyncCmd with Product with Serializable

    The /c_fill message.

    The /c_fill message.

    See also

    ControlBus#fillMsg

    ControlBusSet

    ControlBusSetn

20.  final case class ControlBusGet(index: Int*) extends Message with SyncQuery with Product with Serializable

    The /c_get message.

    The /c_get message.

    See also

    ControlBus#getMsg

    ControlBusGetn

    ControlBusSet

21.  final case class ControlBusGetn(ranges: Range*) extends Message with SyncQuery with Product with Serializable

    The /c_getn message.

    The /c_getn message.

    See also

    ControlBus#getnMsg

    ControlBusGet

    ControlBusSetn

22.  final case class ControlBusSet(pairs: FillValue*) extends Message with SyncCmd with Product with Serializable

    The /c_set message.

    The /c_set message.

    See also

    ControlBus#setMsg

    ControlBusSetn

    ControlBusGet

    ControlBusFill

23.  final case class ControlBusSetn(indicesAndValues: (Int, IndexedSeq[Float])*) extends Message with SyncCmd with Product with Serializable

    The /c_setn message.

    The /c_setn message.

    See also

    ControlBus#setnMsg

    ControlBusSet

    ControlBusGetn

    ControlBusFill

24.  final case class DumpOSC(mode: Dump) extends Message with SyncCmd with Product with Serializable

    The /dumpOSC message that selects how the server reports incoming OSC packets.

    The /dumpOSC message that selects how the server reports incoming OSC packets.

    Note: The OSC dump behavior of scsynth has long time been broken. It is recommended to use client-side only reporting, provided by the dumpOSC method of the Server class.

    See also

    Server#dumpOSC

25.  final case class Error(mode: Int) extends Message with SyncCmd with Product with Serializable

    Produces an /error message that selects how the server will report errors to the console.

26.  final case class GroupDeepFree(ids: Int*) extends Message with SyncCmd with Product with Serializable

    The /g_deepFree message.

27.  final case class GroupDumpTree(groups: (Int, Boolean)*) extends Message with SyncCmd with Product with Serializable

    The /g_dumpTree message.

28.  final case class GroupFreeAll(ids: Int*) extends Message with SyncCmd with Product with Serializable

    The /g_freeAll message.

29.  final case class GroupHead(groups: (Int, Int)*) extends Message with SyncCmd with Product with Serializable

    The /g_head message pair-wise places nodes at the head of groups.

    The /g_head message pair-wise places nodes at the head of groups.

    /g_head
      [
        Int - the id of the group at which head a node is to be placed (B)
        int - the id of the node to place (A)
      ] * N

    So that for each pair, node A is moved to the head of group B.

30.  final case class GroupNew(groups: Data*) extends Message with SyncCmd with Product with Serializable

    The /g_new message.

31.  final case class GroupQueryTree(groups: (Int, Boolean)*) extends Message with SyncQuery with Product with Serializable

    The /g_queryTree message.

32.  final case class GroupTail(groups: (Int, Int)*) extends Message with SyncCmd with Product with Serializable

    The /g_tail message pair-wise places nodes at the tail of groups.

    The /g_tail message pair-wise places nodes at the tail of groups.

    /g_tail
      [
        Int - the id of the group at which tail a node is to be placed (B)
        int - the id of the node to place (A)
      ] * N

    So that for each pair, node A is moved to the tail of group B.

33.  trait Handler extends AnyRef
34.  sealed trait HasCompletion extends AsyncSend
35.  sealed trait HasControlSet extends AnyRef
36.  final case class NodeAfter(groups: (Int, Int)*) extends Message with SyncCmd with Product with Serializable

    The /n_after message pair-wise places nodes after other nodes.

    The /n_after message pair-wise places nodes after other nodes.

    /n_after
      [
        Int - the id of the node to place (A)
        int - the id of the node after which the above is placed (B)
      ] * N

    So that for each pair, node A in the same group as node B, to execute immediately after node B.

37.  final case class NodeBefore(groups: (Int, Int)*) extends Message with SyncCmd with Product with Serializable

    The /n_before message pair-wise places nodes before other nodes.

    The /n_before message pair-wise places nodes before other nodes.

    /n_before
      [
        Int - the id of the node to place (A)
        int - the id of the node before which the above is placed (B)
      ] * N

    So that for each pair, node A in the same group as node B, to execute immediately before node B.

38.  sealed trait NodeChange extends Receive
39.  final case class NodeEnd(nodeId: Int, info: Data) extends Message with NodeChange with Product with Serializable
40.  final case class NodeFill(id: Int, data: ControlFillRange*) extends Message with SyncCmd with Product with Serializable

    The /n_fill message.

41.  final case class NodeFree(ids: Int*) extends Message with SyncCmd with Product with Serializable

    The /n_free message.

42.  final case class NodeGo(nodeId: Int, info: Data) extends Message with NodeChange with Product with Serializable
43.  final case class NodeInfo(nodeId: Int, info: Data) extends Message with NodeChange with Product with Serializable

    An /n_info message is received as a reply to an /n_query message.

    An /n_info message is received as a reply to an /n_query message.

    nodeId

    the identifier of the node for which information has been received

    info

    the information object describing the topological position of the node

    See also

    NodeQuery

44.  final case class NodeMap(id: Int, mappings: Single*) extends Message with SyncCmd with Product with Serializable

    The /n_map message.

45.  final case class NodeMapa(id: Int, mappings: Single*) extends Message with SyncCmd with Product with Serializable

    The /n_mapa message.

46.  final case class NodeMapan(id: Int, mappings: ControlABusMap*) extends Message with SyncCmd with Product with Serializable

    The /n_mapan message.

47.  final case class NodeMapn(id: Int, mappings: ControlKBusMap*) extends Message with SyncCmd with Product with Serializable

    The /n_mapn message.

48.  final case class NodeMove(nodeId: Int, info: Data) extends Message with NodeChange with Product with Serializable
49.  final case class NodeNoId(ids: Int*) extends Message with SyncCmd with Product with Serializable

    The /n_noid message.

50.  final case class NodeOff(nodeId: Int, info: Data) extends Message with NodeChange with Product with Serializable
51.  final case class NodeOn(nodeId: Int, info: Data) extends Message with NodeChange with Product with Serializable
52.  final case class NodeOrder(addAction: Int, targetId: Int, ids: Int*) extends Message with SyncCmd with Product with Serializable

    The /n_order message.

53.  final case class NodeQuery(ids: Int*) extends Message with SyncQuery with Product with Serializable

    The /n_query message.

54.  final case class NodeRun(nodes: (Int, Boolean)*) extends Message with SyncCmd with Product with Serializable

    The /n_run message.

55.  final case class NodeSet(id: Int, pairs: ControlSet*) extends Message with SyncCmd with HasControlSet with Product with Serializable

    The /n_set message.

56.  final case class NodeSetn(id: Int, pairs: ControlSet*) extends Message with SyncCmd with HasControlSet with Product with Serializable

    The /n_setn message.

57.  final case class NodeTrace(ids: Int*) extends Message with SyncCmd with Product with Serializable

    The /n_trace message.

58.  final case class ParGroupNew(groups: Data*) extends Message with SyncCmd with Product with Serializable

    The /p_new message.

59.  trait Receive extends ServerMessage

    Identifies messages returned by SuperCollider server.

60.  trait Responder extends Handler
61.  sealed trait Send extends ServerMessage

    Identifies messages sent to the SuperCollider server.

62.  sealed trait ServerMessage extends AnyRef

    Identifies messages received or sent by the SuperCollider server.

63.  final case class ServerNotify(on: Boolean) extends Message with AsyncSend with Product with Serializable

    The /notify messages registers or de-registers a client with respect to receiving reply messages from the server.

    The /notify messages registers or de-registers a client with respect to receiving reply messages from the server.

    Booting or connecting a server through the regular API automatically handles and does not require the explicit use of this message.

    on

    if true, the client is registered, if false it is de-registered.

64.  final case class StatusReply(numUGens: Int, numSynths: Int, numGroups: Int, numDefs: Int, avgCPU: Float, peakCPU: Float, sampleRate: Double, actualSampleRate: Double) extends Message with Receive with Product with Serializable
65.  final case class Sync(id: Int) extends Message with AsyncSend with Product with Serializable

    Represents a /sync message, which is queued with the asynchronous messages on the server, and which, when executed, triggers a corresponding /synced reply message (i.e.

    Represents a /sync message, which is queued with the asynchronous messages on the server, and which, when executed, triggers a corresponding /synced reply message (i.e. with the same id)

    id

    an arbitrary identifier which can be used to match the corresponding reply message. typically the id is incremented by 1 for each /sync message sent out.

66.  trait SyncCmd extends SyncSend

    Identifies command messages sent to the server which are executed synchronously and do not return a message.

67.  trait SyncQuery extends SyncSend

    Identifies query messages sent to the server which are executed synchronously and produce a reply message.

68.  sealed trait SyncSend extends Send

    Identifies messages sent to the server which are executed synchronously.

69.  final case class Synced(id: Int) extends Message with Receive with Product with Serializable

    Represents a /synced message, a reply from the server acknowledging that all asynchronous operations up to the corresponding /sync message (i.e.

    Represents a /synced message, a reply from the server acknowledging that all asynchronous operations up to the corresponding /sync message (i.e. with the same id) have been completed

70.  final case class SynthDefFree(names: String*) extends Message with SyncCmd with Product with Serializable

    The /d_free message.

71.  final case class SynthDefLoad(path: String, completion: Option[Packet]) extends Message with HasCompletion with Product with Serializable

    The /d_load message.

    The /d_load message.

    path

    the path to the file that stores the definition. This can be a pattern like "synthdefs/perc-*"

    See also

    SynthDef.loadMsg

72.  final case class SynthDefLoadDir(path: String, completion: Option[Packet]) extends Message with HasCompletion with Product with Serializable

    The /d_loadDir message tells the server to load all synth definitions within a directory.

    The /d_loadDir message tells the server to load all synth definitions within a directory.

    See also

    SynthDef.loadDirMsg

73.  final case class SynthDefRecv(bytes: ByteBuffer, completion: Option[Packet]) extends Message with HasCompletion with Product with Serializable

    The /d_recv message.

74.  final case class SynthGet(id: Int, controls: Any*) extends Message with SyncQuery with Product with Serializable

    The /s_get message.

75.  final case class SynthGetn(id: Int, controls: (Any, Int)*) extends Message with SyncQuery with Product with Serializable

    The /s_getn message.

76.  final case class SynthNew(defName: String, id: Int, addAction: Int, targetId: Int, controls: ControlSet*) extends Message with SyncCmd with HasControlSet with Product with Serializable

    The /s_new message.

77.  final case class Timeout() extends RuntimeException with Product with Serializable
78.  final case class Trigger(nodeId: Int, trig: Int, value: Float) extends Message with Receive with Product with Serializable

    The /tr message send from a SendTrig UGen.

79.  final case class UGenCommand(nodeId: Int, ugenIdx: Int, command: String, rest: Any*) extends Message with SyncCmd with Product with Serializable

    The /u_cmd message allows one to send UGen specific commands.