VideoFrame:allocationSize() 方法

Baseline 2024
新推出

自 2024 年 9 月起,此功能已可在最新裝置和瀏覽器版本上使用。此功能可能無法在舊裝置或瀏覽器上使用。

注意:此功能在 專用 Web Workers 中可用。

allocationSize() 方法是 VideoFrame 介面的一個方法,它返回透過傳遞給該方法的選項過濾後,儲存影片所需的位元組數。

語法

js
allocationSize()
allocationSize(options)

引數

options 可選

一個包含以下內容的 *)

rect 可選

要從 VideoFrame 中複製的畫素矩形。如果未指定,將使用 visibleRect。其格式為一個包含以下內容的字典物件:

  • x:x 座標。
  • y:y 座標。
  • width:幀的寬度。
  • height:幀的高度。
layout 可選

一個列表,包含 VideoFrame 中每個平面的以下值。平面可能不會重疊。如果未指定,平面將緊密打包。

offset

一個整數,表示給定平面開始的偏移量(以位元組為單位)。

stride(步幅)

一個整數,表示平面中每一行使用的位元組數,包括填充。

format 可選

destination 中畫素資料的畫素格式。可以設定為 "RGBA""RGBX""BGRA""BGRX"。如果未指定,將使用 format

colorSpace 可選

指定 destination 中畫素資料的顏色空間。可以設定為 "srgb"(用於 sRGB 顏色空間)或 "display-p3"(用於 display-p3 顏色空間)。僅適用於 RGB 畫素格式。如果未指定,將使用 "srgb"

返回值

一個整數,包含根據 options 指定的儲存該幀所需的位元組數。

示例

在以下示例中,將返回位於左上角、尺寸為 800 x 600 的矩形的 allocationSize

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

規範

規範
WebCodecs
# dom-videoframe-allocationsize

瀏覽器相容性