kotlin-browser/web.codecs/VideoFrame

VideoFrame

open class VideoFrame(image: CanvasImageSource, init: VideoFrameInit = definedExternally) : CanvasImageSource, TexImageSource, GPUCopyExternalImageSource, Transferable, Serializable, JsCloseable(source)

The VideoFrame interface of the Web Codecs API represents a frame of a video.

MDN Reference

Constructors

VideoFrame

constructor(image: CanvasImageSource, init: VideoFrameInit = definedExternally)

constructor(data: AllowSharedBufferSource, init: VideoFrameBufferInit)

Properties

codedHeight

val codedHeight: Int

The codedHeight property of the VideoFrame interface returns the height of the VideoFrame in pixels, potentially including non-visible padding, and prior to considering potential ratio adjustments.

codedRect

val codedRect: DOMRectReadOnly?

The codedRect property of the VideoFrame interface returns a DOMRectReadOnly with the width and height matching VideoFrame.codedWidth and VideoFrame.codedHeight.

codedWidth

val codedWidth: Int

The codedWidth property of the VideoFrame interface returns the width of the VideoFrame in pixels, potentially including non-visible padding, and prior to considering potential ratio adjustments.

colorSpace

val colorSpace: VideoColorSpace

The colorSpace property of the VideoFrame interface returns a VideoColorSpace object representing the color space of the video.

displayHeight

val displayHeight: Int

The displayHeight property of the VideoFrame interface returns the height of the VideoFrame after applying aspect ratio adjustments.

displayWidth

val displayWidth: Int

The displayWidth property of the VideoFrame interface returns the width of the VideoFrame after applying aspect ratio adjustments.

duration

val duration: UInt53?

The duration property of the VideoFrame interface returns an integer indicating the duration of the video in microseconds.

format

val format: VideoPixelFormat?

The format property of the VideoFrame interface returns the pixel format of the VideoFrame.

timestamp

val timestamp: Int53

The timestamp property of the VideoFrame interface returns an integer indicating the timestamp of the video in microseconds.

visibleRect

val visibleRect: DOMRectReadOnly?

The visibleRect property of the VideoFrame interface returns a DOMRectReadOnly describing the visible rectangle of pixels for this VideoFrame.

Functions

allocationSize

fun allocationSize(options: VideoFrameCopyToOptions = definedExternally): Int

The allocationSize() method of the VideoFrame interface returns the number of bytes required to hold the video as filtered by options passed into the method.

clone

fun clone(): VideoFrame

The clone() method of the VideoFrame interface creates a new VideoFrame object referencing the same media resource as the original.

open override fun close()

The close() method of the VideoFrame interface clears all states and releases the reference to the media resource.

copyTo

inline suspend fun VideoFrame.copyTo(destination: AllowSharedBufferSource): ReadonlyArray<PlaneLayout>

inline suspend fun VideoFrame.copyTo(destination: AllowSharedBufferSource, options: VideoFrameCopyToOptions): ReadonlyArray<PlaneLayout>

The copyTo() method of the VideoFrame interface copies the contents of the VideoFrame to an ArrayBuffer.

copyToAsync

fun copyToAsync(destination: AllowSharedBufferSource, options: VideoFrameCopyToOptions = definedExternally): Promise<ReadonlyArray<PlaneLayout>>

The copyTo() method of the VideoFrame interface copies the contents of the VideoFrame to an ArrayBuffer.