getAvailableModels()v4.0.523

Returns metadata for the models supported by separateVideoLayers().

models.ts
import {getAvailableModels} from '@remotion/video-matting';

const models = getAvailableModels();
console.log(models);

Name	Purpose	WebGPU download size	Status
modnet	People	25.9 MB	Default
ben2-base	General foreground subjects	219.1 MB	Experimental and higher-resource

The modnet model is Apache-2.0 licensed. The ben2-base model is the MIT-licensed BEN2 Base export.

The modelId values identify these upstream Hugging Face models for provenance. Runtime files are downloaded from immutable paths on remotion.media and are byte-identical to files from the pinned upstream revisions.

Return value

Returns an array with the following properties:

name

The model name accepted by APIs in this package.

modelId

The upstream Hugging Face model identifier. This is provenance metadata, not the runtime download location.

purpose

A short description of the subjects the model is intended to separate.

webGpuDownloadSize

The total size in bytes of all runtime files downloaded for WebGPU.

Compatibility

Browsers			Environments
Chrome	Firefox	Safari	Client-side rendering	Server-side rendering	Player	Studio

See also

• isVideoMattingModelCached()
• loadVideoMattingModel()
• removeVideoMattingModel()