🎥 Make videos programmatically with React
`remotion`: Add `assetType` to `InteractivitySchema` (#11068)
Igor Samokhovetsef7c6ba261f7
diff --git a/packages/core/src/Img.tsx b/packages/core/src/Img.tsxindex 626a229b3a..b9128c4906 100644--- a/packages/core/src/Img.tsx+++ b/packages/core/src/Img.tsx@@ -444,6 +444,7 @@ const CanvasImageWithPrivateProps = CanvasImage as React.ComponentType<export const imgSchema = {src: {type: 'asset',+ assetType: 'image',default: undefined,description: 'Source',keyframable: false,diff --git a/packages/core/src/animated-image/AnimatedImage.tsx b/packages/core/src/animated-image/AnimatedImage.tsxindex e8793f4f3d..25a5086889 100644--- a/packages/core/src/animated-image/AnimatedImage.tsx+++ b/packages/core/src/animated-image/AnimatedImage.tsx@@ -49,6 +49,7 @@ import {resolveAnimatedImageSource} from './resolve-image-source';export const animatedImageSchema = {src: {type: 'asset',+ assetType: 'image',default: undefined,description: 'Source',keyframable: false,diff --git a/packages/core/src/canvas-image/CanvasImage.tsx b/packages/core/src/canvas-image/CanvasImage.tsxindex 581a471136..8fb113ef48 100644--- a/packages/core/src/canvas-image/CanvasImage.tsx+++ b/packages/core/src/canvas-image/CanvasImage.tsx@@ -44,6 +44,7 @@ import type {CanvasImageCanvasProps, CanvasImageProps} from './props.js';export const canvasImageSchema = {src: {type: 'asset',+ assetType: 'image',default: undefined,description: 'Source',keyframable: false,diff --git a/packages/core/src/interactivity-schema.ts b/packages/core/src/interactivity-schema.tsindex 247e2427e3..c3348c9030 100644--- a/packages/core/src/interactivity-schema.ts+++ b/packages/core/src/interactivity-schema.ts@@ -121,6 +121,7 @@ export type FontWeightFieldSchema = {export type AssetFieldSchema = {type: 'asset';+ assetType?: 'audio' | 'video' | 'image';default: string | undefined;description?: string;keyframable?: false;diff --git a/packages/core/src/test/Img.test.tsx b/packages/core/src/test/Img.test.tsxindex 19d2955d5c..397ab0b4dc 100644--- a/packages/core/src/test/Img.test.tsx+++ b/packages/core/src/test/Img.test.tsx@@ -408,6 +408,7 @@ test('Img with effects renders through the canvas image path', async () => {test('<Img> schema exposes src and crop but not fit', () => {expect(imgSchema.src).toEqual({type: 'asset',+ assetType: 'image',default: undefined,description: 'Source',keyframable: false,diff --git a/packages/core/src/test/canvas-image.test.tsx b/packages/core/src/test/canvas-image.test.tsxindex 5bdb1c6ac7..9d3079bdb1 100644--- a/packages/core/src/test/canvas-image.test.tsx+++ b/packages/core/src/test/canvas-image.test.tsx@@ -267,6 +267,7 @@ test('<CanvasImage> registers its canvas as the outline ref', async () => {test('<CanvasImage> schema exposes src and non-keyframable premounting fields', () => {expect(canvasImageSchema.src).toEqual({type: 'asset',+ assetType: 'image',default: undefined,description: 'Source',keyframable: false,diff --git a/packages/docs/docs/interactivity-schema.mdx b/packages/docs/docs/interactivity-schema.mdxindex 5c02ccded9..9b115ea107 100644--- a/packages/docs/docs/interactivity-schema.mdx+++ b/packages/docs/docs/interactivity-schema.mdx@@ -101,6 +101,29 @@ Shows an on/off control.Shows a color control. The value is a CSS color string.+### `asset`++Shows a control for selecting an asset source.++#### `assetType?`<AvailableFrom v="4.0.521" />++Set to `'audio'`, `'video'` or `'image'` to only show matching files when replacing this field's asset in Remotion Studio.++`assetType` describes the intended content. It does not inspect or validate the current value or remote URLs.++```ts twoslash title="schema.ts"+import type {InteractivitySchema} from 'remotion';++export const schema = {+ audioSrc: {+ type: 'asset',+ assetType: 'audio',+ default: 'https://example.com/audio.mp3',+ description: 'Audio source',+ },+} as const satisfies InteractivitySchema;+```+### `font-family`<AvailableFrom v="4.0.485" />Shows a font family control. The value is a CSS font family string.diff --git a/packages/media/src/audio/audio.tsx b/packages/media/src/audio/audio.tsxindex 102adcf324..9f112992ce 100644--- a/packages/media/src/audio/audio.tsx+++ b/packages/media/src/audio/audio.tsx@@ -20,6 +20,7 @@ const {validateMediaProps} = Internals;export const audioSchema: InteractivitySchema = {src: {type: 'asset',+ assetType: 'audio',default: undefined,description: 'Source',keyframable: false,diff --git a/packages/media/src/video/video.tsx b/packages/media/src/video/video.tsxindex b1ec516317..9046bf97ff 100644--- a/packages/media/src/video/video.tsx+++ b/packages/media/src/video/video.tsx@@ -26,6 +26,7 @@ const {export const videoSchema: InteractivitySchema = {src: {type: 'asset',+ assetType: 'video',default: undefined,description: 'Source',keyframable: false,diff --git a/packages/studio/src/components/InspectorSequenceSection.tsx b/packages/studio/src/components/InspectorSequenceSection.tsxindex 2c821bb69b..4fbacc2148 100644--- a/packages/studio/src/components/InspectorSequenceSection.tsx+++ b/packages/studio/src/components/InspectorSequenceSection.tsx@@ -36,7 +36,6 @@ import {isSmartCollapsibleInspectorGroup,} from './InspectorPanel/inspector-section-collapse';import {sectionHeaderRow, sectionHeaderTitle} from './InspectorPanel/styles';-import {getAssetSearchQueryForComponent} from './QuickSwitcher/asset-search';import {BORDER_RADIUS_SHORTHAND_KEY,getBorderRadiusConversion,@@ -355,9 +354,6 @@ export const InspectorSequenceSection: React.FC<{sequence.controls,runtimeValues,);- const assetSelectionInitialQuery = getAssetSearchQueryForComponent(- sequence.controls.componentIdentity,- );const getSourceAction = useCallback((src: string): InspectorSourceAction | null => {const linkInfo = getTimelineAssetLinkInfo(src);@@ -406,10 +402,9 @@ export const InspectorSequenceSection: React.FC<{const assetSelectionContextValue = useMemo(() => ({getSourceAction,- initialQuery: assetSelectionInitialQuery,sourceAction,}),- [assetSelectionInitialQuery, getSourceAction, sourceAction],+ [getSourceAction, sourceAction],);const getIsExpanded = useCallback(diff --git a/packages/studio/src/components/QuickSwitcher/asset-search.ts b/packages/studio/src/components/QuickSwitcher/asset-search.tsindex f0f0ffad74..e78f47e6f9 100644--- a/packages/studio/src/components/QuickSwitcher/asset-search.ts+++ b/packages/studio/src/components/QuickSwitcher/asset-search.ts@@ -1,8 +1,5 @@import type {StaticFile} from '../../api/get-static-files';-import {- getPreviewFileType,- type AssetFileType,-} from '../../helpers/get-preview-file-type';+import {getPreviewFileType} from '../../helpers/get-preview-file-type';const typeFilterRegex = /(^|\s)type:([^\s]+)/gi;@@ -39,22 +36,3 @@ export const filterAssetsByType = ({query: queryWithoutTypeFilters,};};--const componentAssetTypes: Record<string, AssetFileType> = {- 'dev.remotion.media.Audio': 'audio',- 'dev.remotion.media.Video': 'video',- 'dev.remotion.remotion.AnimatedImage': 'image',- 'dev.remotion.remotion.CanvasImage': 'image',- 'dev.remotion.remotion.Img': 'image',-};--export const getAssetSearchQueryForComponent = (- componentIdentity: string | null,-): string => {- if (componentIdentity === null) {- return '';- }-- const assetType = componentAssetTypes[componentIdentity];- return assetType ? `type:${assetType} ` : '';-};diff --git a/packages/studio/src/components/Timeline/TimelineAssetField.tsx b/packages/studio/src/components/Timeline/TimelineAssetField.tsxindex ea851ca425..2618011098 100644--- a/packages/studio/src/components/Timeline/TimelineAssetField.tsx+++ b/packages/studio/src/components/Timeline/TimelineAssetField.tsx@@ -40,17 +40,21 @@ const standaloneSourceActionStyle: React.CSSProperties = {width: 'auto',};+const assetTypeToAccept = {+ audio: 'audio/*',+ video: 'video/*',+ image: 'image/*',+} as const;+export type InspectorSourceAction = InspectorQuickActionProps;type AssetSelectionContextValue = {- readonly initialQuery: string;readonly getSourceAction: (src: string) => InspectorSourceAction | null;readonly sourceAction: InspectorSourceAction | null;};export const AssetSelectionContext = createContext<AssetSelectionContextValue>({getSourceAction: () => null,- initialQuery: '',sourceAction: null,});@@ -84,9 +88,9 @@ export const TimelineAssetField: React.FC<TimelineAssetFieldProps> = ({const {setSelectedModal} = useContext(SetSelectedModalContext);const staticFiles = useStaticFiles();- const {getSourceAction, initialQuery, sourceAction} = useContext(- AssetSelectionContext,- );+ const {getSourceAction, sourceAction} = useContext(AssetSelectionContext);+ const {assetType} = field.fieldSchema;+ const initialQuery = assetType ? `type:${assetType} ` : '';const inlineSourceAction = useMemo(() => {if (typeof effectiveValue === 'string') {return getSourceAction(effectiveValue);@@ -111,7 +115,10 @@ export const TimelineAssetField: React.FC<TimelineAssetFieldProps> = ({);const selectFile = useCallback(async () => {- const [file] = await pickFilesToImport({multiple: false});+ const [file] = await pickFilesToImport({+ multiple: false,+ accept: assetType ? assetTypeToAccept[assetType] : null,+ });if (!file) {return;}@@ -147,7 +154,7 @@ export const TimelineAssetField: React.FC<TimelineAssetFieldProps> = ({4000,);}- }, [onSelect, staticFiles]);+ }, [assetType, onSelect, staticFiles]);const openAssetSelection = useCallback(() => {setSelectedModal({diff --git a/packages/studio/src/components/import-assets.ts b/packages/studio/src/components/import-assets.tsindex 67c6a6c687..d6cf56d171 100644--- a/packages/studio/src/components/import-assets.ts+++ b/packages/studio/src/components/import-assets.ts@@ -616,15 +616,23 @@ const getAssetElementFromStaticAsset = async (return getAssetElementFromPath(assetPath);};-export const pickFilesToImport = ({- multiple = true,-}: {- readonly multiple?: boolean;-} = {}): Promise<File[]> => {+export const pickFilesToImport = (+ {+ multiple = true,+ accept,+ }: {+ readonly multiple?: boolean;+ readonly accept: string | null;+ } = {accept: null},+): Promise<File[]> => {return new Promise((resolve) => {const input = document.createElement('input');input.type = 'file';input.multiple = multiple;+ if (accept !== null) {+ input.accept = accept;+ }+input.style.display = 'none';let didResolve = false;diff --git a/packages/studio/src/helpers/get-preview-file-type.ts b/packages/studio/src/helpers/get-preview-file-type.tsindex 02ac438267..8bf797c5f3 100644--- a/packages/studio/src/helpers/get-preview-file-type.ts+++ b/packages/studio/src/helpers/get-preview-file-type.ts@@ -12,9 +12,28 @@ export const getPreviewFileType = (fileName: string | null): AssetFileType => {return 'other';}- const audioExtensions = ['mp3', 'wav', 'ogg', 'aac'];- const videoExtensions = ['mp4', 'avi', 'mkv', 'mov', 'webm'];- const imageExtensions = ['jpg', 'jpeg', 'png', 'apng', 'gif', 'bmp', 'webp'];+ const audioExtensions = ['mp3', 'wav', 'ogg', 'aac', 'm4a', 'flac'];+ const videoExtensions = [+ 'mp4',+ 'avi',+ 'mkv',+ 'mov',+ 'webm',+ 'm4v',+ 'ts',+ 'm2ts',+ 'm3u8',+ ];+ const imageExtensions = [+ 'jpg',+ 'jpeg',+ 'png',+ 'apng',+ 'gif',+ 'bmp',+ 'webp',+ 'svg',+ ];const fontExtensions = ['woff', 'woff2', 'ttf', 'otf', 'eot'];const fileExtension = fileName.split('.').pop()?.toLowerCase();diff --git a/packages/studio/src/test/quick-switcher-asset-search.test.ts b/packages/studio/src/test/quick-switcher-asset-search.test.tsdeleted file mode 100644index a330f30af9..0000000000--- a/packages/studio/src/test/quick-switcher-asset-search.test.ts+++ /dev/null@@ -1,82 +0,0 @@-import {expect, test} from 'bun:test';-import type {StaticFile} from '../api/get-static-files';-import {- filterAssetsByType,- getAssetSearchQueryForComponent,-} from '../components/QuickSwitcher/asset-search';--const assets: StaticFile[] = [- {- lastModified: 0,- name: 'audio/theme.mp3',- sizeInBytes: 1,- src: '/audio/theme.mp3',- },- {- lastModified: 0,- name: 'images/logo.png',- sizeInBytes: 1,- src: '/images/logo.png',- },- {- lastModified: 0,- name: 'videos/intro.mp4',- sizeInBytes: 1,- src: '/videos/intro.mp4',- },-];--test('filters quick switcher assets by type', () => {- const result = filterAssetsByType({- assets,- query: 'intro type:video clip',- });-- expect(result.query).toBe('intro clip');- expect(result.assets.map((asset) => asset.name)).toEqual([- 'videos/intro.mp4',- ]);-});--test('supports multiple asset type filters', () => {- const result = filterAssetsByType({- assets,- query: 'type:audio type:IMAGE',- });-- expect(result.query).toBe('');- expect(result.assets.map((asset) => asset.name)).toEqual([- 'audio/theme.mp3',- 'images/logo.png',- ]);-});--test('returns no assets for an unknown asset type', () => {- const result = filterAssetsByType({- assets,- query: 'type:spreadsheet',- });-- expect(result.query).toBe('');- expect(result.assets).toEqual([]);-});--test('gets an asset type query for interactive media components', () => {- expect(getAssetSearchQueryForComponent('dev.remotion.media.Video')).toBe(- 'type:video ',- );- expect(getAssetSearchQueryForComponent('dev.remotion.media.Audio')).toBe(- 'type:audio ',- );- expect(getAssetSearchQueryForComponent('dev.remotion.remotion.Img')).toBe(- 'type:image ',- );- expect(- getAssetSearchQueryForComponent('dev.remotion.remotion.AnimatedImage'),- ).toBe('type:image ');- expect(- getAssetSearchQueryForComponent('dev.remotion.remotion.CanvasImage'),- ).toBe('type:image ');- expect(getAssetSearchQueryForComponent('com.example.Custom')).toBe('');- expect(getAssetSearchQueryForComponent(null)).toBe('');-});diff --git a/packages/studio/src/test/quick-switcher-asset-search.test.tsx b/packages/studio/src/test/quick-switcher-asset-search.test.tsxnew file mode 100644index 0000000000..554f7f61f6--- /dev/null+++ b/packages/studio/src/test/quick-switcher-asset-search.test.tsx@@ -0,0 +1,183 @@+import {afterEach, expect, test} from 'bun:test';+import {cleanup, fireEvent, render, screen} from '@testing-library/react';+import type {AssetFieldSchema} from 'remotion';+import type {StaticFile} from '../api/get-static-files';+import {filterAssetsByType} from '../components/QuickSwitcher/asset-search';+import {TimelineAssetField} from '../components/Timeline/TimelineAssetField';+import {SetSelectedModalContext, type ModalState} from '../state/modals';++afterEach(cleanup);++const assets: StaticFile[] = [+ {+ lastModified: 0,+ name: 'audio/theme.mp3',+ sizeInBytes: 1,+ src: '/audio/theme.mp3',+ },+ {+ lastModified: 0,+ name: 'audio/podcast.m4a',+ sizeInBytes: 1,+ src: '/audio/podcast.m4a',+ },+ {+ lastModified: 0,+ name: 'audio/lossless.flac',+ sizeInBytes: 1,+ src: '/audio/lossless.flac',+ },+ {+ lastModified: 0,+ name: 'images/logo.png',+ sizeInBytes: 1,+ src: '/images/logo.png',+ },+ {+ lastModified: 0,+ name: 'images/vector.svg',+ sizeInBytes: 1,+ src: '/images/vector.svg',+ },+ {+ lastModified: 0,+ name: 'videos/intro.mp4',+ sizeInBytes: 1,+ src: '/videos/intro.mp4',+ },+ {+ lastModified: 0,+ name: 'videos/trailer.m4v',+ sizeInBytes: 1,+ src: '/videos/trailer.m4v',+ },+ {+ lastModified: 0,+ name: 'videos/stream.ts',+ sizeInBytes: 1,+ src: '/videos/stream.ts',+ },+ {+ lastModified: 0,+ name: 'videos/stream.m2ts',+ sizeInBytes: 1,+ src: '/videos/stream.m2ts',+ },+ {+ lastModified: 0,+ name: 'videos/playlist.m3u8',+ sizeInBytes: 1,+ src: '/videos/playlist.m3u8',+ },+];++test('filters quick switcher assets by type', () => {+ const result = filterAssetsByType({+ assets,+ query: 'intro type:video clip',+ });++ expect(result.query).toBe('intro clip');+ expect(result.assets.map((asset) => asset.name)).toEqual([+ 'videos/intro.mp4',+ 'videos/trailer.m4v',+ 'videos/stream.ts',+ 'videos/stream.m2ts',+ 'videos/playlist.m3u8',+ ]);+});++test('supports multiple asset type filters', () => {+ const result = filterAssetsByType({+ assets,+ query: 'type:audio type:IMAGE',+ });++ expect(result.query).toBe('');+ expect(result.assets.map((asset) => asset.name)).toEqual([+ 'audio/theme.mp3',+ 'audio/podcast.m4a',+ 'audio/lossless.flac',+ 'images/logo.png',+ 'images/vector.svg',+ ]);+});++test('returns no assets for an unknown asset type', () => {+ const result = filterAssetsByType({+ assets,+ query: 'type:spreadsheet',+ });++ expect(result.query).toBe('');+ expect(result.assets).toEqual([]);+});++test('an audio asset field includes only audio files', () => {+ const fieldSchema = {+ type: 'asset',+ assetType: 'audio',+ default: undefined,+ } satisfies AssetFieldSchema;+ let selectedModal: ModalState | null = null;++ render(+ <SetSelectedModalContext.Provider+ value={{+ setSelectedModal: (update) => {+ selectedModal =+ typeof update === 'function' ? update(selectedModal) : update;+ },+ }}+ >+ <TimelineAssetField+ field={{+ key: 'audioSrc',+ description: 'Audio source',+ typeName: 'asset',+ rowHeight: 22,+ fieldSchema,+ group: 'source',+ }}+ propStatus={{+ status: 'static',+ codeValue: undefined,+ keyframeDisplayOffsetAdjustment: null,+ }}+ effectiveValue={undefined}+ onSave={() => Promise.resolve()}+ onDragValueChange={() => undefined}+ onDragEnd={() => undefined}+ />+ </SetSelectedModalContext.Provider>,+ );++ fireEvent.click(screen.getByRole('button', {name: 'Change source'}));+ const modal = selectedModal as ModalState | null;+ if (modal?.type !== 'quick-switcher' || modal.assetSelection === null) {+ throw new Error('Expected asset Quick Switcher to open');+ }++ const result = filterAssetsByType({+ assets,+ query: modal.assetSelection.initialQuery,+ });++ expect(result.assets.map((asset) => asset.name)).toEqual([+ 'audio/theme.mp3',+ 'audio/podcast.m4a',+ 'audio/lossless.flac',+ ]);+});++test('an image asset filter includes SVG files', () => {+ const result = filterAssetsByType({+ assets,+ query: 'type:image ',+ });++ expect(result.assets.map((asset) => asset.name)).toEqual([+ 'images/logo.png',+ 'images/vector.svg',+ ]);+});