AudioParamDescriptor

Web Audio API 中的 AudioParamDescriptor 字典用于指定 AudioParam 对象的属性。

它用于在 AudioWorkletNode 上创建自定义 AudioParam。如果底层 AudioWorkletProcessor 具有 parameterDescriptors 静态 getter,那么基于此字典返回的对象数组将由 AudioWorkletNode 构造函数在内部使用,以相应地填充其 parameters 属性。

实例属性

name

代表 AudioParam 名称的字符串。在此名称下,AudioParam 将可在节点的 parameters 属性中访问,并且在此名称下,AudioWorkletProcessor.process 方法将获取此 AudioParam 的计算值。

automationRate 可选

表示此 AudioParam 的自动化速率的 "a-rate""k-rate" 字符串。默认为 "a-rate"

minValue 可选

代表 AudioParam 最小值的 float。默认为 -3.4028235e38

maxValue 可选

代表 AudioParam 最大值的 float。默认为 3.4028235e38

defaultValue 可选

代表 AudioParam 初始值的 float。默认为 0

示例

下面的代码片段展示了一个在此类型中定义的描述符,它是由自定义 AudioWorkletProcessor 中定义的静态 parameterDescriptors 方法返回的(这是 AudioWorkletNode.parameters 中更完整示例的一部分)。

js
// white-noise-processor.js
class WhiteNoiseProcessor extends AudioWorkletProcessor {
  static get parameterDescriptors() {
    return [
      {
        name: "customGain",
        defaultValue: 1,
        minValue: 0,
        maxValue: 1,
        automationRate: "a-rate",
      },
    ];
  }

  // …
}

规范

规范
Web Audio API
# AudioParamDescriptor

另见