Interface VideoFrameBuffer

[[VideoFrameBuffer]] is an interface that can be used as input or output with VideoFrameProcessor. It must implement the method to return buffer as CanvasImageSource but the internal handle to the video frame buffer can be flexible.

interface VideoFrameBuffer {
    framerate: number;
    height: number;
    width: number;
    asCanvasElement(): OffscreenCanvas | HTMLCanvasElement;
    asCanvasImageSource(): Promise<CanvasImageSource>;
    asTransferable(): Promise<Transferable>;
    destroy(): void;
}

Implemented by

Properties

framerate height width

Methods

asCanvasElement? asCanvasImageSource asTransferable? destroy

Properties

framerate

framerate: number

The frame rate of the source in the [[VideoFrameBuffer]].

height

height: number

The height in pixels of the source in the [[VideoFrameBuffer]].

width

width: number

The width in pixels of the source in the [[VideoFrameBuffer]].

Methods

OptionalasCanvasElement

  • asCanvasElement(): OffscreenCanvas | HTMLCanvasElement

    Returns HTMLCanvasElement or OffscreenCanvas if the internal source can be transformed into one. Optional method. Returns null if the buffer is destroyed.

    Returns OffscreenCanvas | HTMLCanvasElement

asCanvasImageSource

  • asCanvasImageSource(): Promise<CanvasImageSource>

    Returns the buffer as CanvasImageSource which can be drawn on HTMLCanvasElement directly. If destroy is already called, asCanvasImageSource should reject.

    Returns Promise<CanvasImageSource>

OptionalasTransferable

  • asTransferable(): Promise<Transferable>

    Returns [[Transferable]] if the internal source can be transformed into one. Optional method. If destroy is already called, asTransferable should reject.

    Returns Promise<Transferable>

destroy

  • destroy(): void

    Explicitly destroys the source and intermediate buffers in [[VideoFrameBuffer]]. After destroy is called, this [[VideoFrameBuffer]] must be discarded. destroy is typically required to be called, when MediaStream, HTMLVideoElement and ImageData are passed in as initialization data.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods