VideoDecoder: configure()-Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist in Dedicated Web Workers verfügbar.

Die configure()-Methode der VideoDecoder-Schnittstelle platziert eine Steuerungsnachricht in die Warteschlange, um den Videodecoder für das Dekodieren von Abschnitten zu konfigurieren.

Syntax

js
configure(config)

Parameter

config

Ein Objekt, das folgende Mitglieder enthält:

codec

Ein String, der einen gültigen Codec-String enthält. Siehe "codecs"-Parameter für Details zur Konstruktion von Codec-Strings.

description Optional

Ein ArrayBuffer, ein TypedArray oder ein DataView, das eine Sequenz codec-spezifischer Bytes enthält, die oft als Extradata bekannt sind.

codedWidth Optional

Eine ganze Zahl, die die Breite des VideoFrame in Pixeln darstellt, einschließlich jeglicher nicht sichtbarer Polsterung, vor jeglichen Verhältnis-Anpassungen.

codedHeight Optional

Eine ganze Zahl, die die Höhe des VideoFrame in Pixeln darstellt, einschließlich jeglicher nicht sichtbarer Polsterung, vor jeglichen Verhältnis-Anpassungen.

displayAspectWidth Optional

Eine ganze Zahl, die die horizontale Dimension des VideoFrame in Pixeln bei der Anzeige darstellt.

displayAspectHeight Optional

Eine ganze Zahl, die die vertikale Dimension des VideoFrame in Pixeln bei der Anzeige darstellt.

colorSpace Optional

Ein Objekt, das einen VideoColorSpace darstellt, und die folgenden Mitglieder enthält:

primaries

Ein String, der den Farb-Gamut der Videoproben darstellt. Eine der Optionen:

  • "bt709"
  • "bt470bg"
  • "smpte170m"
transfer

Ein String, der die Transfer-Eigenschaften darstellt. Eine der Optionen:

  • "bt709"
  • "smpte170m"
  • "iec61966-2-1"
matrix

Ein String, der einen Matrixkoeffizienten darstellt. Eine der Optionen:

  • "rgb"
  • "bt709"
  • "bt470bg"
  • "smpte170m"
hardwareAcceleration Optional

Ein Hinweis auf die zu verwendende Methode der Hardwarebeschleunigung. Eine der Optionen:

  • "no-preference"
  • "prefer-hardware"
  • "prefer-software"
optimizeForLatency Optional

Ein Boolean. Wenn true, ist dies ein Hinweis, dass der ausgewählte Decoder optimiert werden soll, um die Anzahl der EncodedVideoChunk-Objekte, die vor der Ausgabe eines VideoFrame dekodiert werden müssen, zu minimieren.

Hinweis: Die Registrierungen im WebCodecs Codec Registry verlinken zu einer Spezifikation, die beschreibt, ob und wie das optionale description-Mitglied zu füllen ist.

Rückgabewert

Keiner (undefined).

Ausnahmen

TypeError

Wird ausgelöst, wenn das bereitgestellte config ungültig ist.

InvalidStateError DOMException

Wird ausgelöst, wenn der state "closed" ist.

NotSupportedError DOMException

Wird ausgelöst, wenn das bereitgestellte config gültig ist, der User Agent jedoch keinen Codec bereitstellen kann, der dieses Profil dekodieren kann.

Beispiele

Das folgende Beispiel erstellt einen neuen VideoDecoder und konfiguriert ihn mit dem "vp8" Codec, einer codedWidth von 640 Pixeln und einer codedHeight von 480 Pixeln.

js
const init = {
  output: handleFrame,
  error: (e) => {
    console.log(e.message);
  },
};

const config = {
  codec: "vp8",
  codedWidth: 640,
  codedHeight: 480,
};

let decoder = new VideoDecoder(init);
decoder.configure(config);

Spezifikationen

Specification
WebCodecs
# dom-videodecoder-configure

Browser-Kompatibilität

BCD tables only load in the browser