SatiePlugin

Extension

Description

This is a base class for SATIE plugins. It is used by SatiePlugins.

SATIE plugins (sources, effects, spatializers, etc.) reside in structured plugin directories. The directory structure is as follows (names are case-sensitive):

plugins/

• sources/
  • some_source_plugin.scd
  • another_source_plugin.scd
  • etc.

• effects/
  • some_effect_plugin.scd
  • etc.

• hoa/
• mappers/
• monitoring/
• postprocessors/
• spatializers/

By default, SATIE searches for plugins in two locations defined in SatieConfiguration: -satieRoot and SatieConfiguration: -satieUserSupportDir. Other plugin directories can be loaded via the method SatieConfiguration: -loadPluginDir.

Plugins must reside in one of the sub-folders of the plugin directory. Plugins are defined inside their individual .scd files. The format of a plugin file is as follows:// Mandatory "fields" of a plugin: // name (a Symbol) ~name = \pluginName; // description ~description = "Short description of plugin's purpose or functionality"; // Channel layout, either \mono or \ambi ~channelLayout = \mono; // function definition ~function = {| sfreq = 200 | // note, that the plugin should not contain an Out UGen. FSinOsc.ar(sfreq) }; // optional setup function ~setup = { |satieInstance| }

Class Methods

.new