Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Excerpt
Panel

setParameter(nameOrID, value)

Description

Function to set the value of a parameter. The parameter can be

identified

determined 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.

Info

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.

...

name or ID. The function will have no effect if the parameter does not exist.

Available in: Controller, Processor.

Arguments

nameOrIDThe name or ID of the parameter

...

.string or number
valueThe value that you want to set.

Example

Code Block
--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

The new value must match the data type of the parameter.

Example

Excerpt Include
Working with Parameters
Working with Parameters
nopaneltrue

Panel

See Also: getParameter, getParameterNormalized, setParameterNormalized, hasParameter