diff --git a/files/en-us/web/api/audioparamdescriptor/index.html b/files/en-us/web/api/audioparamdescriptor/index.html index 5eef33af9791a57..98f9232c4dbf7a1 100644 --- a/files/en-us/web/api/audioparamdescriptor/index.html +++ b/files/en-us/web/api/audioparamdescriptor/index.html @@ -13,7 +13,7 @@ ---
The AudioParamDescriptor
dictionary of the Web Audio API specifies properties for an {{domxref("AudioParam")}} objects. It is used to create custom AudioParam
s on an {{domxref("AudioWorkletNode")}}. If the underlying {{domxref("AudioWorkletProcessor")}} has a {{domxref("AudioWorkletProcessor.parameterDescriptors", "parameterDescriptors")}} static getter, then the returned array of objects based on this dictionary is used internally by AudioWorkletNode
constructor to populate its {{domxref("AudioWorkletNode.parameters", "parameters")}} property accordingly.
+
The AudioParamDescriptor
dictionary of the Web Audio API specifies properties for {{domxref("AudioParam")}} objects. It is used to create custom AudioParam
s on an {{domxref("AudioWorkletNode")}}. If the underlying {{domxref("AudioWorkletProcessor")}} has a {{domxref("AudioWorkletProcessor.parameterDescriptors", "parameterDescriptors")}} static getter, then the returned array of objects based on this dictionary is used internally by AudioWorkletNode
constructor to populate its {{domxref("AudioWorkletNode.parameters", "parameters")}} property accordingly.
The code fragment below shows a descriptor of this type being returned by a static {{domxref("AudioWorkletProcessor.parameterDescriptors", "parameterDescriptors")}} method defined in a custom AudioWorkletProcessor
(this is part of the more complete example in AudioWorkletNode.parameters).
// white-noise-processor.js +class WhiteNoiseProcessor extends AudioWorkletProcessor { + static get parameterDescriptors () { + return [{ + name: 'customGain', + defaultValue: 1, + minValue: 0, + maxValue: 1, + automationRate: 'a-rate' + }] + } + +... +}+ +
{{Compat("api.AudioParamDescriptor")}}
+ +An iterable of {{domxref("AudioParamDescriptor")}}-based objects. The properties of - these objects are as follows: {{page("/en-US/docs/Web/API/AudioParamDescriptor", - "Properties")}}
+ these objects are as follows: + +name
AudioParam
. Under this name the AudioParam
will be available in the {{domxref("AudioWorkletNode.parameters", "parameters")}} property of the node, and under this name the {{domxref("AudioWorkletProcessor.process")}} method will acquire the calculated values of this AudioParam
.automationRate
{{optional_inline}}"a-rate"
, or "k-rate"
string which represents an automation rate of this AudioParam
. Defaults to "a-rate"
.minValue
{{optional_inline}}float
which represents minimum value of the AudioParam
. Defaults to -3.4028235e38
.maxValue
{{optional_inline}}float
which represents maximum value of the AudioParam
. Defaults to 3.4028235e38
.defaultValue
{{optional_inline}}float
which represents initial value of the AudioParam
. Defaults to 0
.