AudioWorkletProcessor: parameterDescriptors static property
The read-onlyparameterDescriptors property of anAudioWorkletProcessor-derived class is astatic getter,which returns an iterable ofAudioParamDescriptor-based objects.
The property is not a part of theAudioWorkletProcessorinterface, but, if defined, it is called internally by theAudioWorkletProcessor constructor to create a list of customAudioParam objects in theparameters property of the associatedAudioWorkletNode.
Defining the getter is optional.
In this article
Value
An iterable ofAudioParamDescriptor-based objects. The properties ofthese objects are as follows:
nameThe string which represents the name of the
AudioParam. Under this name theAudioParamwill be available in theparametersproperty of the node, and under this name theAudioWorkletProcessor.processmethod will acquire the calculated values of thisAudioParam.automationRateOptionalEither
"a-rate", or"k-rate"string which represents an automation rate of thisAudioParam. Defaults to"a-rate".minValueOptionalA
floatwhich represents minimum value of theAudioParam. Defaults to-3.4028235e38.maxValueOptionalA
floatwhich represents maximum value of theAudioParam. Defaults to3.4028235e38.defaultValueOptionalA
floatwhich represents initial value of theAudioParam. Defaults to0.
Examples
SeeAudioWorkletNode.parameters for example code showing how to add staticparameterDescriptors getter to a customAudioWorkletProcessor.
Specifications
| Specification |
|---|
| Web Audio API> # audioworkletprocess-callback-parameters> |