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 stellt eine Steuerungsanfrage in die Warteschlange, um den Videodecoder für das Decodieren von Chunks zu konfigurieren.

Syntax

js
configure(config)

Parameter

config

Ein Objekt, das die folgenden 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 von codecspezifischen Bytes enthält, allgemein bekannt als "extradata".

codedWidth Optional

Ein Integer, der die Breite des VideoFrame in Pixel angibt, einschließlich jeglicher nicht sichtbarer Auffüllung, vor jeder Verhältnis-Anpassung.

codedHeight Optional

Ein Integer, der die Höhe des VideoFrame in Pixel angibt, einschließlich jeglicher nicht sichtbarer Auffüllung, vor jeder Verhältnis-Anpassung.

displayAspectWidth Optional

Ein Integer, der die horizontale Dimension des VideoFrame in Pixel bei der Anzeige angibt.

displayAspectHeight Optional

Ein Integer, der die vertikale Dimension des VideoFrame in Pixel bei der Anzeige angibt.

colorSpace Optional

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

primaries

Ein String, der den Farbraum (gamut) des Videomusters darstellt. Eine Auswahl aus:

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

Ein String, der die Übertragungseigenschaften darstellt. Eine Auswahl aus:

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

Ein String, der einen Matrizenkoeffizienten darstellt. Eine Auswahl aus:

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

Ein Hinweis auf die zu verwendende Hardwarebeschleunigungsmethode. Eine Auswahl aus:

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

Ein Boolean. Wenn true, ist dies ein Hinweis darauf, dass der ausgewählte Decoder optimiert werden sollte, um die Anzahl der EncodedVideoChunk Objekte zu minimieren, die decodiert werden müssen, bevor ein VideoFrame ausgegeben wird.

flip Optional

Ein Boolean. Wenn true, wird eine horizontale Spiegelung angewendet. Standardmäßig false.

rotation Optional

Ein Integer, der die Drehung (0, 90, 180 oder 270) in Grad im Uhrzeigersinn darstellt. Standardmäßig 0. Beliebige Zahlen (einschließlich negativer) werden auf die nächste Vierteldrehung gerundet.

Hinweis: Die Registrierungen im WebCodecs Codec Registry verweisen auf eine Spezifikation, die darlegt, 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, aber der Benutzeragent keinen Codec bereitstellen kann, der dieses Profil decodieren 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