Skip to content

TypeScript SDK Reference / CapturedFrame

Interface: CapturedFrame ​

Represents a captured video frame with methods to access the image data. Used for processing video frames in the vital sign analysis pipeline.

Properties ​

height ​

height: number

Height of the captured frame in pixels.


timestamp ​

timestamp: number

Timestamp when the frame was captured.


width ​

width: number

Width of the captured frame in pixels.

Methods ​

getCanvas() ​

getCanvas(): Promise<HTMLCanvasElement>

Get a canvas element containing the captured frame.

Returns ​

Promise<HTMLCanvasElement>


getImageBitmap() ​

getImageBitmap(): Promise<ImageBitmap>

Get an ImageBitmap of the captured frame (transferable).

Returns ​

Promise<ImageBitmap>


getImageData() ​

getImageData(): Promise<ImageData>

Get the image data of the captured frame.

Returns ​

Promise<ImageData>