Abstract class

VideoSampleResource

Abstract base class for custom video sample resources. Implement this class to provide custom backing for VideoSample instances.

Subclasses

• AvFrameVideoSampleResource

Used by

• ConversionVideoOptions.process
• new VideoSample()
• VideoTransformOptions.process

Methods

close()

close(): void;

Closes this resource, releasing held resources. Called automatically when the last VideoSample using this resource is closed.

getCodedHeight()

getCodedHeight(): number;

Returns the height of the frame in pixels.

getCodedWidth()

getCodedWidth(): number;

Returns the width of the frame in pixels.

getColorSpace()

getColorSpace(): VideoSampleColorSpace;

Returns the color space of the frame.

See VideoSampleColorSpace.

getDataPlanes()

getDataPlanes(): MaybePromise<VideoDataPlane[]>;

Returns the data planes that hold the video data for this sample. The returned planes and data must be in the format returned by getFormat().

See MaybePromise and VideoDataPlane.

getFormat()

getFormat(): VideoSamplePixelFormat | null;

Returns the internal pixel format in which the frame is stored. See pixel formats

See VideoSamplePixelFormat.

getSquarePixelHeight()

getSquarePixelHeight(): number;

Returns the height of the frame in square pixels, respecting pixel aspect ratio.

getSquarePixelWidth()

getSquarePixelWidth(): number;

Returns the width of the frame in square pixels, respecting pixel aspect ratio.

toRgbSample()

toRgbSample(
	init: SetRequired<VideoSampleInit, 'timestamp'>,
	colorSpace: PredefinedColorSpace,
): MaybePromise<VideoSample>;

Returns a new RGB VideoSample that contains the same content as this sample. The provided init object must be used to set the metadata of this new video sample. When converting from a non-RGB format to RGB, the conversion must respect colorSpace.

See SetRequired, VideoSampleInit, and MaybePromise.