AudioParamDescriptor

Das AudioParamDescriptor Wörterbuch der Web Audio API spezifiziert Eigenschaften für AudioParam-Objekte.

Es wird verwendet, um benutzerdefinierte AudioParams auf einem AudioWorkletNode zu erstellen. Wenn der zugrunde liegende AudioWorkletProcessor einen statischen Getter parameterDescriptors hat, dann wird das zurückgegebene Array von Objekten basierend auf diesem Wörterbuch intern vom AudioWorkletNode-Konstruktor verwendet, um die parameters-Eigenschaft entsprechend zu befüllen.

Instanz-Eigenschaften

name

Der String, der den Namen des AudioParam darstellt. Unter diesem Namen wird das AudioParam in der parameters-Eigenschaft des Knotens verfügbar sein, und unter diesem Namen wird die AudioWorkletProcessor.process-Methode die berechneten Werte dieses AudioParam erwerben.

automationRate Optional

Entweder "a-rate" oder "k-rate" String, der eine Automatisierungsrate dieses AudioParam darstellt. Standardwert ist "a-rate".

minValue Optional

Ein float, der den Mindestwert des AudioParam darstellt. Standardwert ist -3.4028235e38.

maxValue Optional

Ein float, der den Höchstwert des AudioParam darstellt. Standardwert ist 3.4028235e38.

defaultValue Optional

Ein float, der den Anfangswert des AudioParam darstellt. Standardwert ist 0.

Beispiele

Das untenstehende Codefragment zeigt einen Deskriptor dieses Typs, der von einer statischen parameterDescriptors-Methode zurückgegeben wird, die in einem benutzerdefinierten AudioWorkletProcessor definiert ist (dies ist Teil des ausführlicheren Beispiels in 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",
      },
    ];
  }

  // …
}

Spezifikationen

Specification
Web Audio API
# AudioParamDescriptor

Siehe auch