SynthDef

final case class SynthDef(name: String, graph: UGenGraph)
Companion
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def debugDump(): Unit

Prints a string representation of this definition to the console output for debugging purposes.

Prints a string representation of this definition to the console output for debugging purposes.

A d_free message.

A d_free message.

def hexDump(version: Int): Unit

Prints a hexadecimal dump of the encoded synth def to the console output for debugging purposes.

Prints a hexadecimal dump of the encoded synth def to the console output for debugging purposes.

A d_load message with default directory location and without completion package.

A d_load message with default directory location and without completion package.

See also
def loadMsg(dir: String, completion: Optional[Packet]): SynthDefLoad

A d_load message with an optional completion package.

A d_load message with an optional completion package.

Value Params
dir

the directory in which the synth-definition is found. The synth-definition is assumed to be in a file with name and extension. this must match with the dir parameter of the write method call.

A d_recv message without completion package.

A d_recv message without completion package.

def recvMsg(completion: Optional[Packet], version: Int): SynthDefRecv

A d_recv message.

A d_recv message.

Value Params
completion

optional completion package

version

file version, must be 1 or 2

def toBytes(version: Int): ByteBuffer

Encodes the synth-definition into a byte-buffer ready to be sent to the server or written to a file.

Encodes the synth-definition into a byte-buffer ready to be sent to the server or written to a file.

Returns

A newly allocated buffer filled with a fully contained synth-definition file (magic cookie header, following by this one definition). The buffer is read-only with position zero and limit set to the size of the buffer.

override def toString: String
Definition Classes
Any
def write(dir: String, overwrite: Boolean): Unit

Writes this synth-definition into a file. The file name is the name of the definition followed by the default extension.

Writes this synth-definition into a file. The file name is the name of the definition followed by the default extension.

Value Params
dir

the path of the directory in which the file will be created

overwrite

if true (default), an existing file will be overwritten, if false if the file already exists, this method exists without writing anything.

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product