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

另見