Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 26 Next »

setParameter(nameOrID, value)

Description

Function to set the value of a parameter. The parameter can be identified by ID or name. The identification by name needs more computing time and might be a disadvantage for timing critical scripts. To optimize your script, you can retrieve the ID of a parameter with getParameterDefinition during the initialization of the script and use this instead. If the parameter doesn't exist, nothing will happen.

The type of the new value must fit to the type of the parameter.

If a parameter is modified by a relative quick control, the audio/MIDI processing part of a module actually receives the modified value, while the UI still shows the original unmodified value. setParameter will only affect the original value, and the quick control modification is still applied before passing it to the processing part.

If you call setParameter on a parameter of the script module itself (e.g. using 'this:setParameter("param",value)') from within the processing, the global variable associated with the parameter will not be changed immediately, but will receive the quick control modified value in the next processing block.

Available in: Controller, Processor.

Arguments

nameOrIDThe name or ID of the parameter you want to set.
valueThe value you want to set.

Example

-- set the value of the Level parameter of the parent layer
function onLoadIntoSlot()
    this.parent:setParameter("Level", 0) -- set via name
    this.parent:setParameter(38, 0) -- set via ID
end

See Also: getParameter

  • No labels