BaseAudioContext: createScriptProcessor()-Methode

Veraltet: Diese Funktion wird nicht mehr empfohlen. Obwohl einige Browser sie möglicherweise noch unterstützen, könnte sie bereits aus den relevanten Webstandards entfernt worden sein, in Kürze entfernt werden oder nur noch aus Kompatibilitätsgründen bestehen. Vermeiden Sie die Verwendung und aktualisieren Sie vorhandenen Code, falls möglich; siehe die Kompatibilitätstabelle am Ende dieser Seite, um Ihre Entscheidung zu unterstützen. Beachten Sie, dass diese Funktion jederzeit aufhören könnte zu funktionieren.

Die createScriptProcessor()-Methode der BaseAudioContext-Schnittstelle erstellt ein ScriptProcessorNode zur direkten Audioverarbeitung.

Hinweis: Diese Funktion wurde durch AudioWorklets und die AudioWorkletNode-Schnittstelle ersetzt.

Syntax

js
createScriptProcessor(bufferSize, numberOfInputChannels, numberOfOutputChannels)

Parameter

bufferSize

Die Puffergröße in Einheiten von Abtastrahmen. Wenn angegeben, muss die bufferSize einen der folgenden Werte haben: 256, 512, 1024, 2048, 4096, 8192, 16384. Wenn sie nicht angegeben wird oder der Wert 0 ist, wählt die Implementierung die beste Puffergröße für die gegebene Umgebung, die während der gesamten Lebensdauer des Knotens eine konstante Potenz von 2 sein wird.

Dieser Wert steuert, wie häufig das audioprocess-Ereignis ausgelöst wird und wie viele Abtastrahmen bei jedem Aufruf bearbeitet werden müssen. Niedrigere Werte für bufferSize führen zu einer geringeren (besseren) Latenz. Höhere Werte sind notwendig, um Audioausfälle und Störungen zu vermeiden. Es wird empfohlen, diese Puffergröße nicht anzugeben und die Implementierung eine gute Puffergröße auswählen zu lassen, um ein Gleichgewicht zwischen Latenz und Audioqualität zu erreichen.

numberOfInputChannels

Ganzzahl, die die Anzahl der Kanäle für den Eingang dieses Knotens angibt, standardmäßig 2. Werte bis zu 32 werden unterstützt.

numberOfOutputChannels

Ganzzahl, die die Anzahl der Kanäle für den Ausgang dieses Knotens angibt, standardmäßig 2. Werte bis zu 32 werden unterstützt.

Warnung: WebKit erfordert derzeit (Version 31), dass eine gültige bufferSize übergeben wird, wenn diese Methode aufgerufen wird.

Hinweis: Es ist ungültig, wenn sowohl numberOfInputChannels als auch numberOfOutputChannels null sind.

Rückgabewert

Beispiele

Hinzufügen von weißem Rauschen mit einem Script-Prozessor

Das folgende Beispiel zeigt, wie ein ScriptProcessorNode verwendet wird, um eine Spur, die über AudioContext.decodeAudioData() geladen wurde, zu verarbeiten. Dabei wird jedem Audiosample der Eingabespur ein wenig weißes Rauschen hinzugefügt und über den AudioDestinationNode abgespielt.

Für jeden Kanal und jeden Abtastrahmen verwendet der audioprocess-Ereignishandler des Skriptnodens das zugehörige audioProcessingEvent, um durch jeden Kanal des Eingabebuffers und jedes Sample in jedem Kanal zu schleifen und eine kleine Menge weißes Rauschen hinzuzufügen, bevor dieses Ergebnis in jedem Fall als Ausgabesample gesetzt wird.

js
const myScript = document.querySelector("script");
const myPre = document.querySelector("pre");
const playButton = document.querySelector("button");

// Create AudioContext and buffer source
let audioCtx;

async function init() {
  audioCtx = new AudioContext();
  const source = audioCtx.createBufferSource();

  // Create a ScriptProcessorNode with a bufferSize of 4096 and
  // a single input and output channel
  const scriptNode = audioCtx.createScriptProcessor(4096, 1, 1);

  // Load in an audio track using fetch() and decodeAudioData()
  try {
    const response = await fetch("viper.ogg");
    const arrayBuffer = await response.arrayBuffer();
    source.buffer = await audioCtx.decodeAudioData(arrayBuffer);
  } catch (err) {
    console.error(
      `Unable to fetch the audio file: ${name} Error: ${err.message}`,
    );
  }

  // Give the node a function to process audio events
  scriptNode.addEventListener("audioprocess", (audioProcessingEvent) => {
    // The input buffer is the song we loaded earlier
    let inputBuffer = audioProcessingEvent.inputBuffer;

    // The output buffer contains the samples that will be modified and played
    let outputBuffer = audioProcessingEvent.outputBuffer;

    // Loop through the output channels (in this case there is only one)
    for (let channel = 0; channel < outputBuffer.numberOfChannels; channel++) {
      let inputData = inputBuffer.getChannelData(channel);
      let outputData = outputBuffer.getChannelData(channel);

      // Loop through the 4096 samples
      for (let sample = 0; sample < inputBuffer.length; sample++) {
        // make output equal to the same as the input
        outputData[sample] = inputData[sample];

        // add noise to each output sample
        outputData[sample] += (Math.random() * 2 - 1) * 0.1;
      }
    }
  });

  source.connect(scriptNode);
  scriptNode.connect(audioCtx.destination);
  source.start();

  // When the buffer source stops playing, disconnect everything
  source.addEventListener("ended", () => {
    source.disconnect(scriptNode);
    scriptNode.disconnect(audioCtx.destination);
  });
}

// wire up play button
playButton.addEventListener("click", () => {
  if (!audioCtx) {
    init();
  }
});

Spezifikationen

Specification
Web Audio API
# dom-baseaudiocontext-createscriptprocessor

Browser-Kompatibilität

Siehe auch