VideoDecoder: Methode configure()

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 des VideoDecoder-Interfaces reiht eine Steuerungsnachricht ein, um den Videodecoder für das Decodieren von Chunks zu konfigurieren.

Syntax

js
configure(config)

Parameter

config

Ein Objekt mit den folgenden Mitgliedern:

codec

Ein String, der einen gültigen Codec-String enthält. Details zur Konstruktion von Codec-Strings finden Sie im Abschnitt "codecs" parameter.

description Optional

Ein ArrayBuffer, ein TypedArray oder ein DataView, das eine Sequenz von codecspezifischen Bytes enthält, allgemein als Extradata bekannt.

codedWidth Optional

Ein Integer, der die Breite des VideoFrame in Pixeln darstellt, einschließlich jeglicher nicht sichtbarer Auffüllungen, vor jeglichen Verhältnis-Anpassungen.

codedHeight Optional

Ein Integer, der die Höhe des VideoFrame in Pixeln darstellt, einschließlich jeglicher nicht sichtbarer Auffüllungen, vor jeglichen Verhältnis-Anpassungen.

displayAspectWidth Optional

Ein Integer, der die horizontale Dimension des VideoFrame in Pixeln bei Anzeige darstellt.

displayAspectHeight Optional

Ein Integer, der die vertikale Dimension des VideoFrame in Pixeln bei Anzeige darstellt.

colorSpace Optional

Ein Objekt, das ein VideoColorSpace darstellt, mit den folgenden Mitgliedern:

primaries

Ein String, der den Farbraum (gamut) der Videostichprobe angibt. Einer von:

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

Ein String, der die Übertragungscharakteristika angibt. Einer von:

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

Ein String, der einen Matrix-Koeffizienten angibt. Einer von:

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

Ein Hinweis auf die zu verwendende Hardwarebeschleunigungsmethode. Einer von:

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

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

Hinweis: Die Registrierungen im WebCodecs Codec Registry verlinken zu einer Spezifikation, die beschreibt, ob und wie das optionale Mitglied description befüllt werden sollte.

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 User-Agent keinen Codec bereitstellen kann, der dieses Profil decodieren kann.

Beispiele

Das folgende Beispiel erstellt einen neuen VideoDecoder und konfiguriert ihn mit dem Codec "vp8", 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

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
configure

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support