Type

VideoSampleTransformationDescription

A fully-resolved description of a video sample transformation, with all defaults and constraints baked in.

The order of operations must be:

1. Pixel aspect ratio normalization (always applied)
2. Rotation
3. Flip
4. Crop
5. Resize using fit

type VideoSampleTransformationDescription = {
	width: number;
	height: number;
	fit: 'fill' | 'contain' | 'cover';
	rotation: Rotation;
	flip: boolean;
	crop: CropRectangle;
	alpha: 'keep' | 'discard';
};

See Rotation and CropRectangle.

Used by

• registerVideoSampleTransformer()

Properties

width

width: number;

The width in pixels to resize the frames to.

height

height: number;

The height in pixels to resize the frames to.

fit

fit: 'fill' | 'contain' | 'cover';

The fitting algorithm.

• 'fill' will stretch the image to fill the entire box, potentially altering aspect ratio.
• 'contain' will contain the entire image within the box while preserving aspect ratio. This may lead to letterboxing.
• 'cover' will scale the image until the entire box is filled, while preserving aspect ratio.

rotation

rotation: Rotation;

The clockwise rotation by which to rotate the frames. Rotation is applied before flipping.

See Rotation.

flip

flip: boolean;

Whether to flip the frames horizontally (about the vertical axis). The flip is applied after rotation.

crop

crop: CropRectangle;

The rectangular region of the frames to crop to, clamped to the dimensions of the frame. Cropping is performed after rotation and flip but before resizing.

See CropRectangle.

alpha

alpha: 'keep' | 'discard';

Whether to discard or keep the transparency information of the video sample.