AudioScheduledSourceNode: stop() Methode

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2021.

Die stop()-Methode von AudioScheduledSourceNode plant das Stoppen der Wiedergabe eines Klangs zu einer angegebenen Zeit. Wenn keine Zeit angegeben wird, stoppt der Klang sofort.

Jedes Mal, wenn Sie stop() auf demselben Knoten aufrufen, ersetzt die angegebene Zeit jede zuvor geplante Stoppzeit, die noch nicht eingetreten ist. Wenn der Knoten bereits gestoppt wurde, hat diese Methode keine Wirkung.

Hinweis: Wenn eine geplante Stoppzeit vor der geplanten Startzeit des Knotens auftritt, beginnt der Knoten nie zu spielen.

Syntax

js
stop()
stop(when)

Parameter

when Optional

Die Zeit in Sekunden, zu der der Klang aufhören soll zu spielen. Dieser Wert wird im selben Zeitkoordinatensystem angegeben, das der AudioContext für sein currentTime-Attribut verwendet. Wenn Sie diesen Parameter weglassen, einen Wert von 0 angeben oder einen negativen Wert übergeben, wird die Wiedergabe des Klangs sofort gestoppt.

Rückgabewert

Keiner (undefined).

Ausnahmen

InvalidStateNode DOMException

Wird ausgelöst, wenn der Knoten nicht gestartet wurde, indem start() aufgerufen wurde.

RangeError

Wird ausgelöst, wenn der für when angegebene Wert negativ ist.

Beispiele

Dieses Beispiel zeigt das Starten eines Oszillatorknotens, der geplant ist, sofort zu beginnen, und nach einer Sekunde zu stoppen. Die Stoppzeit wird bestimmt, indem die aktuelle Zeit des Audiokontexts von AudioContext.currentTime genommen und 1 Sekunde hinzugefügt wird.

js
context = new AudioContext();
osc = context.createOscillator();
osc.connect(context.destination);

/* Let's play a sine wave for one second. */

osc.start();
osc.stop(context.currentTime + 1);

Spezifikationen

Specification
Web Audio API
# dom-audioscheduledsourcenode-stop

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch