Description
This class is used to inspect much of the internal structure of SATIE, but also to get information on running synths, including current argument values. It is also possible to get basic info on SATIE's spatializers.
SATIE's introspection does not implement a method to list running synths, but relies on the user to keep track of the instantiated synths. Users can always query if one of the instatiated synths is playing or running by using isRunning or isPlaying methods. Also, check NodeWatcher for more information.
Class Methods
.new
Create a SatieIntrospection object, allowing further introspection requests to the correspondent SATIE renderer specified as argument. It is being used by Satie and is user-accessible via Satie: *inspector.
Arguments:
| satieContext |
A SATIE renderer. The created SatieIntrospection object will only be able to request information from that specific renderer. |
Instance Methods
.getCurrentConfig
Get SATIE's current configuration.
.getValue
Get a single argument value for a running SATIE Synth. Similar to the Synth get method, if an inexistent control value is provided, the method will return 0.0 as the answer. Invalid nodemane values will return empty dictionaries. This method should not be used to mapping control parameters in real time as, similar to the get method, it is based on OSCFunc and works assincronously.
Arguments:
| instanceName |
Source instance name used when the synth was created using the Satie: -makeSourceInstance method. |
| control |
The Synth Control (parameter) to be requested (expect a symbol). |
| group |
Group name used when the synth was created using the Satie: -makeSourceInstance method. |
.getDefValue
Get a single argument value for a running SATIE Synth. Similar to the Synth get method, if an inexistent control value is provided, the method will return 0.0 as the answer. Invalid nodemane values will return empty dictionaries. This method should not be used to mapping control parameters in real time as, similar to the get method, it is based on OSCFunc and works assincronously.
Arguments:
| nodename |
Synth reference/pointer. Accepts SATIE's sound instance references (Check examples on how to reference SATIE Synths). |
| control |
The Synth Control (parameter) to be requested (expect a symbol). |
.getAllValues
Get a list of arguments and values for a running SATIE Synth. This method returns only the control parameters atributed to that synth and does not include spatialization parameters. Similar to getValue, invalid nodemane values will return an error message. This method should not be used to mapping control parameters in real time as, similar to the get method, it is based on OSCFunc and works assincronously.
Arguments:
| instanceName |
Source instance name used when the synth was created using the Satie: -makeSourceInstance method. |
| group |
Group name used when the synth was created using the Satie: -makeSourceInstance method. |
.getSynthValues
Get all argument values for a running SATIE Synth. Similar to getValue, invalid nodemane values will return an error message. This method should not be used to mapping control parameters in real time as, similar to the get method, it is based on OSCFunc and works assincronously.
Arguments:
| instanceName |
Source instance name used when the synth was created using the Satie: -makeSourceInstance method. |
| returnFunction |
Optional: Function to be executed when the server answers the request. The dictionary containing all running synths and control parameters is passed as an argument to the evaluated function. |
.getAllSynths
Get all argument values for all running SATIE Synths. This method should not be used to mapping control parameters in real time as, similar to the get method, it is based on OSCFunc and works assincronously.
Arguments:
| returnFunction |
Optional: Function to be executed when the server answers the request. The dictionary containing all running synths and control parameters is passed as an argument to the evaluated function. |
.getSynthParameters
Get a list with all arguments for a running SATIE Synth. Different from getValue, invalid instanceName values will return an error message. This method relies on SATIE's SynthDef info and does not request information directly from the running Synth.
Arguments:
| instanceName |
Source instance name used when the synth was created using the Satie: -makeSourceInstance method. |
.getDefaultSynthParameters
Get all arguments and default values for a running SATIE Synth. Different from getValue, invalid nodemane values will return an error message. This method relies on SATIE's SynthDef info and does not request information directly from the running Synth.
Arguments:
| instanceName |
Source instance name used when the synth was created using the Satie: -makeSourceInstance method. |
.getSpeakerAngles
Get current spatializer's speaker angles. Returns a dictionary with the spatializer's name and speaker array.
.getSpatializerSpeakerAngles
Get all available spatializer's speaker angles. Returns a dictionary with the spatializer's name and speaker array.
Arguments:
| spatializerName |
Spatializer's name. Accepts Symbols or Strings. |
.getPluginList
Returns a dictionary audio plugins. Key is the type of plugin, value a Set of names.
.getPluginArguments
Returns an Array with argument and value pairs.
Arguments:
| plugin |
Name of the plugin. Accepts Symbols or Strings. |
.getPluginDescription
Returns the plugin description.
Arguments:
| plugin |
Name of the plugin. Accepts Symbols or Strings. |
.getPluginInfo
Returns a Dictionary with all plugin information.
Arguments:
| plugin |
Name of the plugin. Accepts Symbols or Strings. |
.getPluginInfoJSON
Returns all plugin information in JSON format.
Arguments:
| plugin |
Name of the plugin. Accepts Symbols or Strings. |
Examples
link::SATIE/Classes/SatieIntrospection::