Scriptex

Scriptex

Scriptex is a metaplugin loader for the Scripter MIDI-FX runtime.

Constructor

new Scriptex(systemopt, apiopt, configurableopt)

Create a new Scripter instance.

See:
Parameters:
Name Type Attributes Default Description
system Object <optional>
Scripter

The integration environment to use.

api Map <optional>
new.target.API

The plugin integration API to use.

configurable Boolean <optional>
false

Define integration properties as configurable or not.

Members

(static) API :Map.<string, string>

The default Scripter/Scriptex integration fields and methods

Scripter Scriptex
PluginParameters params
NeedsTimingInfo needsTiming
ResetParameterDefaults needsDefaults
ParameterChanged onParam
ProcessMIDI onProcess
HandleMIDI onMidi
Reset onReset
Idle onIdle
Type:
  • Map.<string, string>

(static) SYSTEM :Object

A reference to Scripter.

NOTE: Spying/stubbing this property is useful for BDD/TDD tests.

See:
Type:
  • Object

Methods

deploy(plugin) → {Array.<string>}

Deploy a plugin to the Scripter runtime by integrating appropriate properties with the Scripter API.

See:
Parameters:
Name Type Description
plugin Object

The plugin instance to deploy.

Returns:
Type:
Array.<string>

An enumeration of the Scripter integration properties.