AudioParamDescriptor
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("Web Audio API")}}
The **AudioParamDescriptor** dictionary of the Web Audio API specifies properties for {{domxref("AudioParam")}} objects.
It is used to create custom AudioParams 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.
Instance properties
name- : The string which represents the name of the
AudioParam. Under this name theAudioParamwill 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 thisAudioParam. automationRate{{optional_inline}}- : Either [
"a-rate"](/en-US/docs/Web/API/AudioParam#a-rate), or ["k-rate"](/en-US/docs/Web/API/AudioParam#k-rate) string which represents an automation rate of thisAudioParam. Defaults to"a-rate". minValue{{optional_inline}}- : A
floatwhich represents minimum value of theAudioParam. Defaults to-3.4028235e38. maxValue{{optional_inline}}- : A
floatwhich represents maximum value of theAudioParam. Defaults to3.4028235e38. defaultValue{{optional_inline}}- : A
floatwhich represents initial value of theAudioParam. Defaults to0.
Examples
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",
},
];
}
// …
}Specifications
{{Specifications}}
See also
- Web Audio API
- Using the Web Audio API