🎥 Make videos programmatically with React
Align video matting model discovery API
JonnyBurgerdc8ae0fcaff5
diff --git a/packages/docs/docs/video-matting/get-available-video-matting-models.mdx b/packages/docs/docs/video-matting/get-available-models.mdxsimilarity index 85%rename from packages/docs/docs/video-matting/get-available-video-matting-models.mdxrename to packages/docs/docs/video-matting/get-available-models.mdxindex 1a81b745a0..dc889a9205 100644--- a/packages/docs/docs/video-matting/get-available-video-matting-models.mdx+++ b/packages/docs/docs/video-matting/get-available-models.mdx@@ -1,17 +1,17 @@----image: /generated/articles-docs-video-matting-get-available-video-matting-models.png-title: getAvailableVideoMattingModels()+image: /generated/articles-docs-video-matting-get-available-models.png+title: getAvailableModels()crumb: '@remotion/video-matting'----# getAvailableVideoMattingModels()<AvailableFrom v="4.0.523" />+# getAvailableModels()<AvailableFrom v="4.0.523" />Returns metadata for the models supported by [`separateVideoLayers()`](/docs/video-matting/separate-video-layers).```ts twoslash title="models.ts"-import {getAvailableVideoMattingModels} from '@remotion/video-matting';+import {getAvailableModels} from '@remotion/video-matting';-const models = getAvailableVideoMattingModels();+const models = getAvailableModels();console.log(models);```diff --git a/packages/docs/docs/video-matting/index.mdx b/packages/docs/docs/video-matting/index.mdxindex 39974bb19b..143a0390f2 100644--- a/packages/docs/docs/video-matting/index.mdx+++ b/packages/docs/docs/video-matting/index.mdx@@ -53,4 +53,4 @@ The browser must also be able to decode the input video and encode VP9 with alph## License-The package is MIT licensed. Downloaded model weights retain the licenses listed under [`getAvailableVideoMattingModels()`](/docs/video-matting/get-available-video-matting-models).+The package is MIT licensed. Downloaded model weights retain the licenses listed under [`getAvailableModels()`](/docs/video-matting/get-available-models).diff --git a/packages/docs/docs/video-matting/is-video-matting-model-cached.mdx b/packages/docs/docs/video-matting/is-video-matting-model-cached.mdxindex 2ba9cfad63..a39d561519 100644--- a/packages/docs/docs/video-matting/is-video-matting-model-cached.mdx+++ b/packages/docs/docs/video-matting/is-video-matting-model-cached.mdx@@ -20,7 +20,7 @@ const downloaded = await isVideoMattingModelCached({### model-One of the names returned by [`getAvailableVideoMattingModels()`](/docs/video-matting/get-available-video-matting-models).+One of the names returned by [`getAvailableModels()`](/docs/video-matting/get-available-models).## Return value@@ -32,5 +32,5 @@ A `Promise<boolean>` resolving to `true` if every required model file is cached.## See also-- [`getAvailableVideoMattingModels()`](/docs/video-matting/get-available-video-matting-models)+- [`getAvailableModels()`](/docs/video-matting/get-available-models)- [`loadVideoMattingModel()`](/docs/video-matting/load-video-matting-model)diff --git a/packages/docs/docs/video-matting/load-video-matting-model.mdx b/packages/docs/docs/video-matting/load-video-matting-model.mdxindex 3c2b2c6b5f..d7696bd31e 100644--- a/packages/docs/docs/video-matting/load-video-matting-model.mdx+++ b/packages/docs/docs/video-matting/load-video-matting-model.mdx@@ -25,7 +25,7 @@ console.log(result.alreadyLoaded);### model-One of the names returned by [`getAvailableVideoMattingModels()`](/docs/video-matting/get-available-video-matting-models).+One of the names returned by [`getAvailableModels()`](/docs/video-matting/get-available-models).### onProgress?diff --git a/packages/docs/docs/video-matting/separate-video-layers.mdx b/packages/docs/docs/video-matting/separate-video-layers.mdxindex b72c47bf31..8820e180f7 100644--- a/packages/docs/docs/video-matting/separate-video-layers.mdx+++ b/packages/docs/docs/video-matting/separate-video-layers.mdx@@ -42,7 +42,7 @@ The video matting model to use. Default: `modnet`.`modnet` is optimized for people. `ben2-base` supports more general foreground subjects, but is experimental and requires substantially more memory and a WebGPU adapter with `shader-f16` support.-Use [`getAvailableVideoMattingModels()`](/docs/video-matting/get-available-video-matting-models) to inspect the available models.+Use [`getAvailableModels()`](/docs/video-matting/get-available-models) to inspect the available models.### audio?@@ -213,6 +213,6 @@ Both layers are WebM files encoded with VP9. The foreground preserves alpha. Aud## See also-- [`getAvailableVideoMattingModels()`](/docs/video-matting/get-available-video-matting-models)+- [`getAvailableModels()`](/docs/video-matting/get-available-models)- [`loadVideoMattingModel()`](/docs/video-matting/load-video-matting-model)- [`canUseVideoMatting()`](/docs/video-matting/can-use-video-matting)diff --git a/packages/docs/docs/video-matting/table-of-contents.tsx b/packages/docs/docs/video-matting/table-of-contents.tsxindex caa142f92a..dc42596af2 100644--- a/packages/docs/docs/video-matting/table-of-contents.tsx+++ b/packages/docs/docs/video-matting/table-of-contents.tsx@@ -9,8 +9,8 @@ export const TableOfContents: React.FC = () => {<strong>canUseVideoMatting()</strong><div>Check whether a model is supported</div></TOCItem>- <TOCItem link="/docs/video-matting/get-available-video-matting-models">- <strong>getAvailableVideoMattingModels()</strong>+ <TOCItem link="/docs/video-matting/get-available-models">+ <strong>getAvailableModels()</strong><div>List models and their download sizes</div></TOCItem><TOCItem link="/docs/video-matting/is-video-matting-model-cached">diff --git a/packages/docs/sidebars.ts b/packages/docs/sidebars.tsindex 2d31d03478..6425703542 100644--- a/packages/docs/sidebars.ts+++ b/packages/docs/sidebars.ts@@ -953,7 +953,7 @@ const sidebars: SidebarsConfig = {},items: ['video-matting/can-use-video-matting',- 'video-matting/get-available-video-matting-models',+ 'video-matting/get-available-models','video-matting/is-video-matting-model-cached','video-matting/load-video-matting-model','video-matting/separate-video-layers',diff --git a/packages/docs/src/data/articles.ts b/packages/docs/src/data/articles.tsindex dc8eeb1ddf..5ee03b5da5 100644--- a/packages/docs/src/data/articles.ts+++ b/packages/docs/src/data/articles.ts@@ -8472,13 +8472,13 @@ export const articles = [slug: 'video-matting/dispose-video-matting-model',},{- id: 'video-matting/get-available-video-matting-models',- title: 'getAvailableVideoMattingModels()',- relativePath: 'docs/video-matting/get-available-video-matting-models.mdx',- compId: 'articles-docs-video-matting-get-available-video-matting-models',+ id: 'video-matting/get-available-models',+ title: 'getAvailableModels()',+ relativePath: 'docs/video-matting/get-available-models.mdx',+ compId: 'articles-docs-video-matting-get-available-models',crumb: '@remotion/video-matting',noAi: false,- slug: 'video-matting/get-available-video-matting-models',+ slug: 'video-matting/get-available-models',},{id: 'video-matting/index',diff --git a/packages/docs/static/generated/articles-docs-video-matting-get-available-models.png b/packages/docs/static/generated/articles-docs-video-matting-get-available-models.pngnew file mode 100644index 0000000000..4d43c7898aBinary files /dev/null and b/packages/docs/static/generated/articles-docs-video-matting-get-available-models.png differdiff --git a/packages/docs/static/generated/articles-docs-video-matting-get-available-video-matting-models.png b/packages/docs/static/generated/articles-docs-video-matting-get-available-video-matting-models.pngdeleted file mode 100644index a4cd0b2899..0000000000Binary files a/packages/docs/static/generated/articles-docs-video-matting-get-available-video-matting-models.png and /dev/null differdiff --git a/packages/example/src/VideoMatting/index.tsx b/packages/example/src/VideoMatting/index.tsxindex 844131ead7..cbeffaadcc 100644--- a/packages/example/src/VideoMatting/index.tsx+++ b/packages/example/src/VideoMatting/index.tsx@@ -1,6 +1,6 @@import {canUseVideoMatting,- getAvailableVideoMattingModels,+ getAvailableModels,separateVideoLayers,type VideoMattingModel,} from '@remotion/video-matting';@@ -16,7 +16,7 @@ const formatMegabytes = (bytes: number) => {};export const VideoMatting = () => {- const models = useMemo(() => getAvailableVideoMattingModels(), []);+ const models = useMemo(() => getAvailableModels(), []);const [file, setFile] = useState<File | null>(null);const [isProcessing, setIsProcessing] = useState(false);const [selectedModel, setSelectedModel] =diff --git a/packages/video-matting/src/index.ts b/packages/video-matting/src/index.tsindex 24db7959c3..6bb3fbde92 100644--- a/packages/video-matting/src/index.ts+++ b/packages/video-matting/src/index.ts@@ -19,7 +19,7 @@ export type {} from './load-video-matting-model';export {isVideoMattingModelCached} from './is-video-matting-model-cached';export type {IsVideoMattingModelCachedOptions} from './is-video-matting-model-cached';-export {getAvailableVideoMattingModels} from './models';+export {getAvailableModels} from './models';export type {VideoMattingModel, VideoMattingModelInfo} from './models';export type {VideoLayerOutput,diff --git a/packages/video-matting/src/models.ts b/packages/video-matting/src/models.tsindex 42f7b77190..a5565ee1dd 100644--- a/packages/video-matting/src/models.ts+++ b/packages/video-matting/src/models.ts@@ -41,7 +41,7 @@ const HOSTED_MODEL_IDS: Record<VideoMattingModel, string> = {'ben2-base': 'ben2-base-v1',};-export const getAvailableVideoMattingModels = (): VideoMattingModelInfo[] => {+export const getAvailableModels = (): VideoMattingModelInfo[] => {return VIDEO_MATTING_MODELS.map((model) => {const {revision: _revision,diff --git a/packages/video-matting/src/test/model-runtime.test.ts b/packages/video-matting/src/test/model-runtime.test.tsindex e043e66410..4b5ef181d8 100644--- a/packages/video-matting/src/test/model-runtime.test.ts+++ b/packages/video-matting/src/test/model-runtime.test.ts@@ -320,12 +320,9 @@ test('coalesces initialization and defers disposal until active work is done', a});test('loads every public model from its immutable hosted model ID', async () => {- const {- disposeVideoMattingModel,- getAvailableVideoMattingModels,- loadVideoMattingModel,- } = await import('../index');- const models = getAvailableVideoMattingModels();+ const {disposeVideoMattingModel, getAvailableModels, loadVideoMattingModel} =+ await import('../index');+ const models = getAvailableModels();for (const model of models) {await loadVideoMattingModel({model: model.name});diff --git a/packages/video-matting/src/test/models.test.ts b/packages/video-matting/src/test/models.test.tsindex 10a297ef53..7ae4a99503 100644--- a/packages/video-matting/src/test/models.test.ts+++ b/packages/video-matting/src/test/models.test.ts@@ -3,13 +3,10 @@ import {canUseVideoMatting,VideoMattingUnsupportedReason,} from '../can-use-video-matting';-import {- getAvailableVideoMattingModels,- getVideoMattingModelInfo,-} from '../models';+import {getAvailableModels, getVideoMattingModelInfo} from '../models';test('returns public metadata without mutable internal model settings', () => {- const models = getAvailableVideoMattingModels();+ const models = getAvailableModels();expect(models).toEqual([{@@ -27,7 +24,7 @@ test('returns public metadata without mutable internal model settings', () => {]);models[0].purpose = 'general';- expect(getAvailableVideoMattingModels()[0].purpose).toBe('person');+ expect(getAvailableModels()[0].purpose).toBe('person');});test('rejects unsupported runtime model values', () => {