AudioParamDescriptor

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

Es wird genutzt, 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 seine parameters-Eigenschaft entsprechend zu füllen.

Instanzeigenschaften

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 Methode AudioWorkletProcessor.process die berechneten Werte dieses AudioParam abrufen.

automationRate Optional

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

minValue Optional

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

maxValue Optional

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

defaultValue Optional

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

Beispiele

Das folgende Codefragment zeigt einen Deskriptor dieses Typs, der von einer statischen parameterDescriptors-Methode eines benutzerdefinierten AudioWorkletProcessor zurückgegeben wird (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

No specification found

No specification data found for api.AudioParamDescriptor.
Check for problems with this page or contribute a missing spec_url to mdn/browser-compat-data. Also make sure the specification is included in w3c/browser-specs.

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch