rex_tonejs_api

Plugin, ACE table, Discussion thread
Dependence: None
Introduction
Tone objects in a dictionary.
Usage
Sample capx
This plugin stores tone objects indexed by key. i.e. dictionary. Get definition of function interface in this document.
Create object
Call "Action:Create object" to create a tone object and store it in objects dictionary. The type name and parameters are listed in document.
Connect two objects
Call "Action:Connect" to connect the output of object A to the input of object B.
Call function
Call "Action:Call" to call function of a tone object. The function name and parameters are listed in document.
Set properties
Call one of these actions in "Property" category to set value of a property
  • Action:Set value
  • Action:Set boolean
  • Action:Set JSON
Or call "Action:Set JSON" in "Properties" category to set properties of a tone object.
Definition of properties of each tone object are listed in document.
Get property
Get value of a property by "Expression:Property", there are 2 formats in this expression.
  • "Expression:Property( objectName )" , get properties of default scheme
  • "Expression:Property( objectName, propertyName)" , get value of a property
Get return value
Sample capx
Get return value by "Expression:ReturnValue", there are 2 formats in this expression.
  • "Expression:ReturnValue( objectName )" , get return value of a tone object.
  • "Expression:ReturnValue( objectName , key )" , get value by key.
It returns JSON string if the result is an object, i.e array or dictionary.
Callback
Sample capx
Callback in this plugin is a string (tag) which will redirect to "Condition:Callback" with the same tag.
Parameters of callback
Sample capx
Parameters could be read by "Expression:Param", there are 2 formats in this expression.
  • "Expression:Param( index )" , get parameter by index, return JSON if this value is an object.
  • "Expression:Param( index , key )" , get property of the parameter object.
On suspended
Sample capx
Set property "Play in background" to "No" to
  • pause timeline (Tone.Transport)
  • mute output (Tone.Master)
when application is suspended.
Official save-load
This plugin does NOT support official save-load.

Debug panel
Tone objects are represented in { name: object type } pairs in "Objects" field.
Put a name in "Name" and press enter to get properties of this object in "Properties" field.