de.sciss.synth.message
Type members
Classlikes
Identifies messages sent to the server which are executed asynchronously and reply with a form of done-message.
Identifies messages sent to the server which are executed asynchronously and reply with a form of done-message.
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
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.
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.
- Value Params
- 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.
- 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).
- 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
- See also
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.
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.
- Value Params
- channels
a sequence of channel indices to read. Zero corresponds to the first channel of the 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.
- 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).- 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
- See also
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.
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
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.
- Value Params
- 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
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.
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
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.
- Value Params
- command
the operation to carry out on the buffer, such as generating a waveform or copying the content
- id
the identifier of the buffer whose contents to write.
- See also
- Companion
- object
The /b_getn
message.
The /b_getn
message.
- Value Params
- 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
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
- Companion
- object
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.
- Value Params
- ids
a sequence of buffer identifiers to query
- See also
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.
- Value Params
- bufStartFrame
the frame offset in the buffer to begin writing to.
- fileStartFrame
the offset in frames into the audio-file to begin reading from
- id
the identifier of the buffer to read into.
- leaveOpen
if
true
, leaves the file open for streaming with the DiskIn UGen.- 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.- path
the path of the audio-file to read.
- See also
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.
- Value Params
- bufStartFrame
the frame offset in the buffer to begin writing to.
- channels
a sequence of channel indices to read. Zero corresponds to the first channel of the file.
- fileStartFrame
the offset in frames into the audio-file to begin reading from
- id
the identifier of the buffer to read into.
- leaveOpen
if
true
, leaves the file open for streaming with the DiskIn UGen.- 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.- path
the path of the audio-file to read.
- See also
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.
- Value Params
- 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
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.
- Value Params
- 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
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.
- Value Params
- fileType
the header format of the audio-file
- id
the identifier of the buffer whose contents to write.
- leaveOpen
if
true
, leaves the file open for streaming with the DiskOut UGen.- numFrames
the number of frames to write. The special value of
-1
denotes that the whole buffer content (or the remainder after thestartFrame
) is written out.- path
the path of the audio-file to write to.
- sampleFormat
the sample resolution of the audio-file
- startFrame
the frame offset in the buffer to begin reading from
- See also
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
The /c_setn
message.
The /c_setn
message.
- See also
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
Produces an /error
message that selects how the server will report errors to the console.
Produces an /error
message that selects how the server will report errors to the console.
- Companion
- object
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.
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.
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.
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.
The /n_move
message is received from the server when a node has changed its position in the tree.
The /n_move
message is received from the server when a node has changed its position in the tree.
- See also
- Companion
- class
The /n_set
message.
The /n_set
message.
The /n_setn
message.
The /n_setn
message.
Identifies messages returned by SuperCollider server.
Identifies messages returned by SuperCollider server.
Identifies messages sent to the SuperCollider server.
Identifies messages sent to the SuperCollider server.
Identifies messages received or sent by the SuperCollider server.
Identifies messages received or sent by the SuperCollider server.
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.
- Value Params
- on
if
true
, the client is registered, iffalse
it is de-registered.
The /quit
message tells the server to shut down.
The /quit
message tells the server to shut down.
- See also
The /status
message that queries the current statistics from the server.
The /status
message that queries the current statistics from the server.
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)
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)
- Value Params
- 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.
Identifies command messages sent to the server which are executed synchronously and do not return a message.
Identifies command messages sent to the server which are executed synchronously and do not return a message.
Identifies query messages sent to the server which are executed synchronously and produce a reply message.
Identifies query messages sent to the server which are executed synchronously and produce a reply message.
Identifies messages sent to the server which are executed synchronously.
Identifies messages sent to the server which are executed synchronously.
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
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
The /d_load
message.
The /d_load
message.
- Value Params
- path
the path to the file that stores the definition. This can be a pattern like
"synthdefs/perc-*"
- See also
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
The /d_recv
message.
The /d_recv
message.
The /s_new
message.
The /s_new
message.
The /u_cmd
message allows one to send UGen specific commands.
The /u_cmd
message allows one to send UGen specific commands.