SynthSnapshot:
Filter:
NodeSnapshot/Classes (extension) | Server

SynthSnapshot
ExtensionExtension

A snapshot of the state of a synth on the server

Description

A SynthSnapshot describes a Synth on the server.

WARNING: SynthSnapshot metadata is built using information from SynthDescLib, looked-up via name of the synth reported by the server. If the registered SynthDef differs from the one running on the server, this may be incorrect.

Instance Methods

.asSynth

Returns:

A Synth representing the synth described by this snapshot. It does not create the synth on the server, nor does it guarantee it is still runnung on the server.

.outputs

Returns:

An Array of IODesc's representing the outputs of the synth. These are only present if a SynthDesc can be found for the synth.

.outBusses

Returns:

An Array of Bus's representing the busses being output to by the synth. These are only present if a SynthDesc can be found for the synth.

.desc

Returns:

A SynthDesc for the synth, if one can be found.

.defName

Returns:

The name of the SynthDef, as reported by the server.

.controls

Returns:

An Dictionary mapping NamedControl names to values of those controls at the time of the snapshot.

Examples

helpfile source: HelpSource/Classes/SynthSnapshot.schelp
link::NodeSnapshot/Classes/SynthSnapshot::