VideoFrame: allocationSize() Methode

Limited availability

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

Hinweis: Dieses Feature ist verfügbar in Dedicated Web Workers.

Die allocationSize()-Methode der VideoFrame-Schnittstelle gibt die Anzahl der Bytes zurück, die erforderlich sind, um das Video zu speichern, gefiltert durch die in die Methode übergebenen Optionen.

Syntax

js
allocationSize()
allocationSize(options)

Parameter

options Optional

Ein Objekt, das Folgendes enthält:

rect Optional

Das Rechteck von Pixeln, das aus dem VideoFrame kopiert werden soll. Falls nicht angegeben, wird das visibleRect verwendet. Dies erfolgt im Format eines Wörterbuchobjekts, das enthält:

  • x: Die x-Koordinate.
  • y: Die y-Koordinate.
  • width: Die Breite des Rahmens.
  • height: Die Höhe des Rahmens.
layout Optional

Eine Liste, die folgende Werte für jede Ebene im VideoFrame enthält. Ebenen dürfen sich nicht überlappen. Falls nicht angegeben, werden die Ebenen dicht gepackt:

offset

Ein ganzzahliger Wert, der das Offset in Bytes angibt, ab dem die gegebene Ebene beginnt.

stride

Ein ganzzahliger Wert, der die Anzahl der Bytes, einschließlich Padding, angibt, die von jeder Zeile der Ebene verwendet werden.

format Optional

Ein Pixelformat für die Pixel-Daten im destination. Kann auf "RGBA", "RGBX", "BGRA", "BGRX" gesetzt werden. Falls nicht angegeben, wird das format verwendet.

colorSpace Optional

Gibt den Farbraum der Pixel-Daten im destination an. Kann auf "srgb" für den sRGB-Farbraum oder "display-p3" für den display-p3-Farbraum gesetzt werden. Nur anwendbar für RGB-Pixelformate. Falls nicht angegeben, wird "srgb" verwendet.

Rückgabewert

Ein ganzzahliger Wert, der die Anzahl der Bytes enthält, die benötigt werden, um den Rahmen gemäß den options zu speichern.

Beispiele

Im folgenden Beispiel wird die allocationSize für das Rechteck oben links mit den Abmessungen 800 mal 600 zurückgegeben.

js
const videoRect = {
  x: 0,
  y: 0,
  width: 800,
  height: 600,
};
let size = VideoFrame.allocationSize({ rect: videoRect });

Spezifikationen

Specification
WebCodecs
# dom-videoframe-allocationsize

Browser-Kompatibilität

BCD tables only load in the browser