Functions callable from luabutton functions, Getparameter( param ), Setparameter( param, value ) – Expert Sleepers Augustus Loop v2.4.1 User Manual

Page 52: Setothersparameter( id, param, value ), Getothersparameter( id, param )

Advertising
background image

Functions callable from luaButton functions

These functions should not be called from your createUI() function, but can be used within
functions invoked by any luaButton (see above) that you create.

getParameter( param )

Returns the value of the plug-in parameter. ‘param’ can either be the parameter name (as
used in all the control creation functions above) or the parameter ID (as returned from
getParameterID()). Using the ID is more efficient. Typically you would obtain the ID in the
createUI() function (which is only performed once) and then use it in the button function
(which can be called many times). E.g.

pitch = getParameter( “Pitch” )
pitch = getParameter( paramID_Pitch )

setParameter( param, value )

Sets the value of the plug-in parameter. See the description of getParameter() for the mean-
ing of ‘param’. E.g.

setParameter( “Pitch”, 12.0 )
setParameter( paramID_Pitch, 12.0 )

setOthersParameter( id, param, value )

As setParameter(), but sets the parameter on another instance of the plug-in, not necessar-
ily the one running the script. This allows you to control several instances of the plug-in
from a single GUI.

The ‘id’ is matched against the OSC Port Offset of the plug-ins. Any plug-in that matches
the id will have its parameter set.

Note that all the plug-ins must be loaded by the same host application. For controlling in-
stances of the plug-in loaded by other hosts, or running on other computers, use the
‘sendOSC’ command (below).

E.g.

setOthersParameter( 2, paramID_Pitch, 12.0 )

getOthersParameter( id, param )

As getParameter(), but gets the parameter from another instance of the plug-in. See
setOthersParameter() for a fuller explanation. E.g.

pitch = getOthersParameter( 2, paramID_Pitch )

Advertising