VSTPlugin : MultiOutUGen : UGen : AbstractFunction : Object

Extension

The UGen inputs for the plugin to process.

Possible types:

• a single UGen (= mono)VSTPlugin.ar(SinOsc.ar(200));

• an Array of UGens (= stereo/multichannel)VSTPlugin.ar([ SinOsc.ar(100), SinOsc.ar(200) ]);

• nil (= no input, e.g. VST instruments).
• an Array Ref (= multi-bus, see below)

Multiple input busses

Some VST3 plugins have multiple input busses. If you pass an Array of UGens, they will be automatically distributed over several busses.

___

Alternatively, you can pass a Ref to an Array of inputs. This allows you to pick a subset of channels for each bus. Also, you can skip a bus with 0 or nil.// bus 0: 2ch, bus 1: -, bus 2: 1ch VSTPlugin.ar(`[ [ SinOsc.ar(100), SinOsc.ar(200) ], nil, SinOsc.ar(300) ]);

The number of output channels.

In the simple case, this is a fixed number greater than 0.

The result is either a single OutputProxy (mono) or an Array of OutputProxies (stereo/multichannel), just like a regular MultiOutUGen.// mono output, returns a VSTPlugin VSTPlugin.ar(numOut: 1); // stereo output, returns [ OutputProxy, OutputProxy ] VSTPlugin.ar(numOutput: 2);

Multiple output busses

If the plugin has multiple output busses, the UGen outputs will be automatically distributed over several busses.

___

Alternatively, you can pass a Ref to an Array of channel numbers. This allows you to pick a subset of channels for each bus. Also, you can skip a bus with 0 or nil.

The result is an Array of output busses, where each bus is an Array of OutputProxy.

change the bypass state. If bypass is non-zero, then processing is suspended and each input is passed straight to its corresponding output.

An optional Array of parameter controls in pairs of index and value. Both can be automated.// 'p1' controls parameter 1. // 'p2' controls a parameter whose index can be set dynamically with 'idx'. SynthDef(\test, { arg in, p1, p2, idx; var sig = VSTPlugin.ar(In.ar(in, 2), 1, params: [1, p1, idx, p2]); Out.ar(0, sig); });

You can set the index to a negative value to "unmap" the parameter.

You can automate parameters with either control and audio rate UGens, but the latter is more CPU expensive and only makes sense if the plugin actually supports sample accurate automation (some, but not all VST3 plugins).

A Symbol which uniquely identifies the UGen within the SynthDef, so it can be found by VSTPluginController.

An optional VSTPluginDesc instance; the plugin must have been successfully probed (e.g. with VSTPlugin: *search).

Alternatively, you can provide a plugin key as a Symbol, in which case the VSTPluginDesc will be taken from the default Server's plugin dictionary.

If you know in advance which VST plugin you want to load, this allows you to use parameter names instead of indices( SynthDef(\chorus, { arg bus; // 'GChorus' is a shortcut for VSTPlugin.plugins['GChorus'] var sig = VSTPlugin.ar(In.ar(bus, 2), 2, params: [Depth: 0.5, Mix: 0.9], info: 'GChorus'); ReplaceOut.ar(bus, sig); }).add; )

Also, you can omit the path argument when opening plugins:~fx = VSTPluginController(Synth(\chorus)).open; // will open 'GChorus'

Run the plugin with a certain block size (in samples). The default is nil (= no reblocking).

Some plugins run more efficiently with larger blocksizes. (This is generally true for bridged/sandboxed plugins.) Instead of globally changing the Server block size, you can selectively reblock VSTPlugin instances.

the Server. If this is nil, the default Server is assumed.

the Server. If nil, the default Server is assumed.

whether the Array should be sorted alphabetically (by name).

the Server. If nil, the default Server is assumed.

the Server. If nil, the default Server is assumed.

The server to scan for plugins. If nil, the default Server is used.

an (optional) Array of custom plugin directories.

If nil, the standard VST search paths are used:

an (optional) Event with advanced search options.

• \save (Boolean)

  write results to the cache file (default: true).

• \parallel (Boolean)

  probe plugins in parallel (default: true).

  This can be significantly faster, but it can also make your computer almost unresponsive for the duration of the search because of the full CPU utilization.

• \timeout (Float)

  the number of seconds to wait for a single plugin before it is regarded as being stuck and ignored; default is nil (= no timeout).

• \exclude (Array)

  a list of directories or files to exclude from the search.

Example:VSTPlugin.search(options: ( timeout: 20, parallel: false, save: false, exclude: [ "/plugin/dir/a", "/plugin/dir/b" ]))

post a message for each found plugin.

The message contains the file path, name and probe result ("ok" or error message).

The wait time between OSC messages.

-1 allows an OSC roundtrip between packets.

0 is not safe with UDP, but is probably ok with TCP.

a function to be called after the search has finished.

(see above)

(see above)

(see above)

a) nil: don't write search results (the default)

a) String: name of a temp file where the search results should be written to.

b) Buffer or bufnum: the plugin will fill the Buffer on the Server, the Client can then read the data (each float representing a single byte) and free the Buffer. The Buffer should be initially empty!

the Server. If nil, the default Server is assumed.

the Server. If this is nil, the default Server is assumed.

whether you want to also remove the cache file.

(see above)