Skip to content
Experimental WebAPI

VideoFrame

Values

allocationSize

Read more on MDN

let allocationSize: (
  DomTypes.videoFrame,
  ~options: DomTypes.videoFrameCopyToOptions=?,
) => int

Parameters

DomTypes.videoFrame option< DomTypes.videoFrameCopyToOptions >

Return type

int

clone

Read more on MDN

let clone: DomTypes.videoFrame => DomTypes.videoFrame

Parameters

DomTypes.videoFrame

Return type

DomTypes.videoFrame

close

Read more on MDN

let close: DomTypes.videoFrame => unit

Parameters

DomTypes.videoFrame

Return type

unit

copyTo

Read more on MDN

let copyTo: (
  DomTypes.videoFrame,
  ~destination: ArrayBuffer.t,
  ~options: DomTypes.videoFrameCopyToOptions=?,
) => promise<array<DomTypes.planeLayout>>

Parameters

DomTypes.videoFrame Stdlib.ArrayBuffer.t option< DomTypes.videoFrameCopyToOptions >

Return type

promise< array< DomTypes.planeLayout > >

copyTo2

Read more on MDN

let copyTo2: (
  DomTypes.videoFrame,
  ~destination: ArrayBufferTypedArrayOrDataView.t,
  ~options: DomTypes.videoFrameCopyToOptions=?,
) => promise<array<DomTypes.planeLayout>>

Parameters

DomTypes.videoFrame ArrayBufferTypedArrayOrDataView.t option< DomTypes.videoFrameCopyToOptions >

Return type

promise< array< DomTypes.planeLayout > >

copyTo3

Read more on MDN

let copyTo3: (
  DomTypes.videoFrame,
  ~destination: DataView.t,
  ~options: DomTypes.videoFrameCopyToOptions=?,
) => promise<array<DomTypes.planeLayout>>

Parameters

DomTypes.videoFrame Stdlib.DataView.t option< DomTypes.videoFrameCopyToOptions >

Return type

promise< array< DomTypes.planeLayout > >

fromArrayBuffer

fromArrayBuffer(~data: ArrayBuffer.t, ~init: videoFrameBufferInit)

Creates a new VideoFrame from ArrayBuffer-backed pixel data.

let frame =
  VideoFrame.fromArrayBuffer(~data=myArrayBuffer, ~init=myVideoFrameBufferInit)

Read more on MDN

let fromArrayBuffer: (
  ~data: ArrayBuffer.t,
  ~init: DomTypes.videoFrameBufferInit,
) => DomTypes.videoFrame

Parameters

Stdlib.ArrayBuffer.t DomTypes.videoFrameBufferInit

Return type

DomTypes.videoFrame

fromDataView

fromDataView(~data: DataView.t, ~init: videoFrameBufferInit)

Creates a new VideoFrame from DataView-backed pixel data.

let frame =
  VideoFrame.fromDataView(~data=myDataView, ~init=myVideoFrameBufferInit)

Read more on MDN

let fromDataView: (
  ~data: DataView.t,
  ~init: DomTypes.videoFrameBufferInit,
) => DomTypes.videoFrame

Parameters

Stdlib.DataView.t DomTypes.videoFrameBufferInit

Return type

DomTypes.videoFrame

fromHTMLCanvasElement

fromHTMLCanvasElement(~image: HTMLCanvasElement.t, ~init: videoFrameInit=?)

Creates a new VideoFrame from an HTMLCanvasElement.

let frame = VideoFrame.fromHTMLCanvasElement(~image=myCanvasElement)

Read more on MDN

let fromHTMLCanvasElement: (
  ~image: DomTypes.htmlCanvasElement,
  ~init: DomTypes.videoFrameInit=?,
) => DomTypes.videoFrame

Parameters

DomTypes.htmlCanvasElement option< DomTypes.videoFrameInit >

Return type

DomTypes.videoFrame

fromHTMLImageElement

fromHTMLImageElement(~image: HTMLImageElement.t, ~init: videoFrameInit=?)

Creates a new VideoFrame from an HTMLImageElement.

let frame = VideoFrame.fromHTMLImageElement(~image=myImageElement)

Read more on MDN

let fromHTMLImageElement: (
  ~image: DomTypes.htmlImageElement,
  ~init: DomTypes.videoFrameInit=?,
) => DomTypes.videoFrame

Parameters

DomTypes.htmlImageElement option< DomTypes.videoFrameInit >

Return type

DomTypes.videoFrame

fromHTMLVideoElement

fromHTMLVideoElement(~image: HTMLVideoElement.t, ~init: videoFrameInit=?)

Creates a new VideoFrame from an HTMLVideoElement.

let frame = VideoFrame.fromHTMLVideoElement(~image=myVideoElement)

Read more on MDN

let fromHTMLVideoElement: (
  ~image: DomTypes.htmlVideoElement,
  ~init: DomTypes.videoFrameInit=?,
) => DomTypes.videoFrame

Parameters

DomTypes.htmlVideoElement option< DomTypes.videoFrameInit >

Return type

DomTypes.videoFrame

fromImageBitmap

fromImageBitmap(~image: ImageBitmap.t, ~init: videoFrameInit=?)

Creates a new VideoFrame from an ImageBitmap.

let frame = VideoFrame.fromImageBitmap(~image=myImageBitmap)

Read more on MDN

let fromImageBitmap: (
  ~image: CanvasTypes.imageBitmap,
  ~init: DomTypes.videoFrameInit=?,
) => DomTypes.videoFrame

Parameters

CanvasTypes.imageBitmap option< DomTypes.videoFrameInit >

Return type

DomTypes.videoFrame

fromOffscreenCanvas

fromOffscreenCanvas(~image: OffscreenCanvas.t, ~init: videoFrameInit=?)

Creates a new VideoFrame from an OffscreenCanvas.

let frame = VideoFrame.fromOffscreenCanvas(~image=myOffscreenCanvas)

Read more on MDN

let fromOffscreenCanvas: (
  ~image: CanvasTypes.offscreenCanvas,
  ~init: DomTypes.videoFrameInit=?,
) => DomTypes.videoFrame

Parameters

CanvasTypes.offscreenCanvas option< DomTypes.videoFrameInit >

Return type

DomTypes.videoFrame

fromSVGImageElement

fromSVGImageElement(~image: SVGImageElement.t, ~init: videoFrameInit=?)

Creates a new VideoFrame from an SVGImageElement.

let frame = VideoFrame.fromSVGImageElement(~image=mySvgImageElement)

Read more on MDN

let fromSVGImageElement: (
  ~image: DomTypes.svgImageElement,
  ~init: DomTypes.videoFrameInit=?,
) => DomTypes.videoFrame

Parameters

DomTypes.svgImageElement option< DomTypes.videoFrameInit >

Return type

DomTypes.videoFrame

fromTypedArray

fromTypedArray(~data: TypedArray.t<'t>, ~init: videoFrameBufferInit)

Creates a new VideoFrame from typed-array-backed pixel data.

let frame =
  VideoFrame.fromTypedArray(~data=myTypedArray, ~init=myVideoFrameBufferInit)

Read more on MDN

let fromTypedArray: (
  ~data: TypedArray.t<'t>,
  ~init: DomTypes.videoFrameBufferInit,
) => DomTypes.videoFrame

Parameters

Stdlib.TypedArray.t DomTypes.videoFrameBufferInit

Return type

DomTypes.videoFrame

fromVideoFrame

fromVideoFrame(~image: VideoFrame.t, ~init: videoFrameInit=?)

Creates a new VideoFrame from another VideoFrame.

let frame = VideoFrame.fromVideoFrame(~image=otherFrame)

Read more on MDN

let fromVideoFrame: (
  ~image: DomTypes.videoFrame,
  ~init: DomTypes.videoFrameInit=?,
) => DomTypes.videoFrame

Parameters

DomTypes.videoFrame option< DomTypes.videoFrameInit >

Return type

DomTypes.videoFrame