Skip to content

🎥 Make videos programmatically with React

Merge browser bundler and Canvas player examples

JonnyBurgerab02b63f2227
diff --git a/packages/player-example/README.md b/packages/player-example/README.md
index d2ac8dec2d..a71b9c334a 100644
--- a/packages/player-example/README.md
+++ b/packages/player-example/README.md
@@ -4,7 +4,7 @@
This is the internal Player testbed. Run `bun run dev` and choose an example.
-## Browser-compiled Player
+## Browser-compiled Canvas
The `/browser-bundler` example compiles a conventional virtual project with
`createBrowserBundler({enableFastRefresh: true})`. The host owns the source editor,
@@ -15,8 +15,10 @@ The same-origin preview iframe has a separate, prebundled **development** React,
React DOM, Remotion, and Player. Its bootstrap installs React Refresh before loading
React DOM, so Fast Refresh also works when the Next.js host is a production build.
The iframe calls `createBrowserBundleRuntime().applyBundle()` and keeps both its
-composition registration tree and Player mounted. Registered metadata is resolved
-reactively; compatible edits preserve video state, the paused frame, and playback.
+composition registration tree and `@remotion/canvas` instance mounted. The Canvas
+controller exposes the timeline layers mounted at the current frame and owns the
+selection UI next to the preview. Registered metadata is resolved reactively;
+compatible edits preserve video state, the paused frame, playback, and layer panel.
Hook-signature changes are left to React Refresh to reset.
`createBrowserCompositionObserver()` from `@remotion/browser-bundler/runtime`
diff --git a/packages/player-example/build-browser-bundler-preview.ts b/packages/player-example/build-browser-bundler-preview.ts
index 0c273780ee..87abc31d01 100644
--- a/packages/player-example/build-browser-bundler-preview.ts
+++ b/packages/player-example/build-browser-bundler-preview.ts
@@ -11,5 +11,5 @@ const result = await build({
});
if (!result.success) {
- throw new AggregateError(result.logs, 'Could not build the Player preview.');
+ throw new AggregateError(result.logs, 'Could not build the Canvas preview.');
}
diff --git a/packages/player-example/e2e/browser-bundler.test.ts b/packages/player-example/e2e/browser-bundler.test.ts
index 6ba30fe960..1c63a9be10 100644
--- a/packages/player-example/e2e/browser-bundler.test.ts
+++ b/packages/player-example/e2e/browser-bundler.test.ts
@@ -1,6 +1,6 @@
import {expect, test} from '@playwright/test';
-test('Fast Refresh preserves an isolated Player, video state and editor focus through live edits', async ({
+test('Fast Refresh preserves an isolated Canvas, video state and editor focus through live edits', async ({
page,
}) => {
const pageErrors: string[] = [];
@@ -8,9 +8,9 @@ test('Fast Refresh preserves an isolated Player, video state and editor focus th
await page.goto('/');
await page
- .getByRole('link', {name: 'Browser-compiled Player', exact: true})
+ .getByRole('link', {name: 'Browser-compiled Canvas', exact: true})
.click();
- const preview = page.frameLocator('iframe[title="Live Player preview"]');
+ const preview = page.frameLocator('iframe[title="Live Canvas preview"]');
const composition = preview.getByRole('region', {
name: 'Compiled composition',
});
@@ -26,6 +26,25 @@ test('Fast Refresh preserves an isolated Player, video state and editor focus th
await expect(
composition.getByText('1280 x 720 / 30 fps / 138 frames', {exact: true}),
).toBeVisible();
+ const mountedLayers = composition.getByRole('region', {
+ name: 'Mounted layers',
+ });
+ await expect(
+ mountedLayers.getByRole('heading', {name: 'Layers (5)'}),
+ ).toBeVisible();
+ await expect(
+ mountedLayers.getByRole('button', {name: /^Background/}),
+ ).toBeVisible();
+ await expect(mountedLayers.getByRole('button', {name: /^Orb/})).toBeVisible();
+ await expect(
+ mountedLayers.getByRole('button', {name: /^Content/}),
+ ).toBeVisible();
+ await mountedLayers.getByRole('button', {name: /^Content/}).click();
+ await expect(
+ composition
+ .getByRole('region', {name: 'Layer selection'})
+ .getByRole('heading', {name: 'Selection (1)'}),
+ ).toBeVisible();
await composition
.getByRole('button', {name: 'Clicks: 0', exact: true})
.click();
@@ -49,7 +68,7 @@ test('Fast Refresh preserves an isolated Player, video state and editor focus th
.click();
const pausedFrame = await frame.innerText();
- const editor = page.getByRole('textbox', {name: 'Video.tsx source'});
+ const editor = page.getByRole('textbox', {name: 'Video.tsx'});
const original = await editor.inputValue();
const compatibleEdit = original.replace(
'{title}',
@@ -67,6 +86,9 @@ test('Fast Refresh preserves an isolated Player, video state and editor focus th
).toBeVisible();
await expect(frame).toHaveText(pausedFrame);
await expect(playbackRate).toHaveText('1.5x');
+ await expect(
+ mountedLayers.getByRole('heading', {name: 'Layers (5)'}),
+ ).toBeVisible();
await expect(
composition.getByRole('button', {name: 'Play video', exact: true}),
).toBeVisible();
@@ -75,21 +97,15 @@ test('Fast Refresh preserves an isolated Player, video state and editor focus th
const typingSource = `${compatibleEdit}\n// Consecutive edits: `;
const status = page.getByRole('status');
await editor.fill(typingSource);
- await expect(status).toHaveText(
- 'BrowserDemo compiled successfully with Fast Refresh.',
- );
+ await expect(status).toHaveText('Up to date');
// Use the keyboard, not locator typing that would restore lost focus.
await page.keyboard.type('first', {delay: 80});
await expect(editor).toHaveValue(`${typingSource}first`);
- await expect(status).toHaveText(
- 'BrowserDemo compiled successfully with Fast Refresh.',
- );
+ await expect(status).toHaveText('Up to date');
await expect(editor).toBeFocused();
await page.keyboard.type(' second', {delay: 80});
await expect(editor).toHaveValue(`${typingSource}first second`);
- await expect(status).toHaveText(
- 'BrowserDemo compiled successfully with Fast Refresh.',
- );
+ await expect(status).toHaveText('Up to date');
await expect(editor).toBeFocused();
await expect(frame).toHaveText(pausedFrame);
@@ -184,14 +200,12 @@ test('Fast Refresh preserves an isolated Player, video state and editor focus th
await expect(frame).toHaveText(recoveryFrame);
await expect(playbackRate).toHaveText('1.5x');
- await page
- .getByRole('link', {name: 'All Player examples', exact: true})
- .click();
+ await page.getByRole('link', {name: 'Player examples', exact: true}).click();
await expect(
page.getByRole('heading', {name: 'Player examples', exact: true}),
).toBeVisible();
await page
- .getByRole('link', {name: 'Browser-compiled Player', exact: true})
+ .getByRole('link', {name: 'Browser-compiled Canvas', exact: true})
.click();
await expect(
composition.getByRole('heading', {
diff --git a/packages/player-example/pages/canvas.tsx b/packages/player-example/pages/canvas.tsx
deleted file mode 100644
index e8bb871d46..0000000000
--- a/packages/player-example/pages/canvas.tsx
+++ /dev/null
@@ -1,273 +0,0 @@
-import {
- Canvas,
- getCanvasSelectionItemKey,
- useCanvasController,
- useCanvasSelection,
- type CanvasSelectionItem,
- type SequenceNodePathInfo,
- type TimelineTrackData,
-} from '@remotion/canvas';
-import React, {useSyncExternalStore} from 'react';
-import {AbsoluteFill, Sequence, useCurrentFrame} from 'remotion';
-
-const CanvasComposition: React.FC = () => {
- const frame = useCurrentFrame();
-
- return (
- <AbsoluteFill
- style={{
- alignItems: 'center',
- backgroundColor: '#111827',
- color: 'white',
- fontFamily: 'sans-serif',
- justifyContent: 'center',
- }}
- >
- <Sequence name="Background" layout="none">
- <AbsoluteFill
- style={{
- background:
- 'linear-gradient(135deg, #111827 0%, #312e81 50%, #7c3aed 100%)',
- }}
- />
- </Sequence>
- {frame < 90 ? (
- <Sequence name="Intro card" durationInFrames={90}>
- <h1 style={{fontSize: 88}}>Canvas</h1>
- </Sequence>
- ) : null}
- {frame >= 60 ? (
- <Sequence name="Details" from={60} durationInFrames={120}>
- <div style={{fontSize: 54}}>Live timeline layers</div>
- </Sequence>
- ) : null}
- </AbsoluteFill>
- );
-};
-
-const getExampleNodePathInfo = (
- layer: TimelineTrackData,
-): SequenceNodePathInfo => {
- return (
- layer.nodePathInfo ?? {
- sequenceSubscriptionKey: {
- absolutePath: 'canvas-example',
- effectKeys: [],
- nodePath: ['sequence', layer.sequence.id],
- sequenceKeys: [],
- videoConfigValues: null,
- },
- auxiliaryKeys: [],
- index: 0,
- numberOfSequencesWithThisNodePath: 1,
- supportsEffects: layer.sequence.controls?.supportsEffects === true,
- }
- );
-};
-
-const CanvasPage: React.FC = () => {
- const controller = useCanvasController();
- const layers = useSyncExternalStore(
- controller.timeline.subscribe,
- controller.timeline.getSnapshot,
- controller.timeline.getSnapshot,
- );
- const selection = useCanvasSelection(controller.selection);
- const selectedKeys = new Set(
- selection.selectedItems.map(getCanvasSelectionItemKey),
- );
- const selectableLayers: CanvasSelectionItem[] = layers.map((layer) => ({
- type: 'sequence',
- nodePathInfo: getExampleNodePathInfo(layer),
- }));
-
- return (
- <main
- style={{
- fontFamily: 'sans-serif',
- margin: '40px auto',
- maxWidth: 1100,
- padding: '0 20px',
- }}
- >
- <h1>Canvas layers</h1>
- <p>
- This page renders <code>@remotion/canvas</code> and subscribes to the
- layers currently mounted in its Player.
- </p>
- <div
- style={{
- alignItems: 'start',
- display: 'grid',
- gap: 32,
- gridTemplateColumns: 'minmax(0, 2fr) minmax(240px, 1fr)',
- }}
- >
- <Canvas
- controller={controller}
- component={CanvasComposition}
- compositionWidth={1280}
- compositionHeight={720}
- durationInFrames={180}
- fps={30}
- controls
- acknowledgeRemotionLicense
- style={{width: '100%'}}
- />
- <div>
- <section
- style={{
- border: '1px solid #d1d5db',
- borderRadius: 8,
- padding: 20,
- }}
- >
- <h2 style={{marginTop: 0}}>Mounted layers ({layers.length})</h2>
- {layers.length === 0 ? (
- <p>No layers mounted.</p>
- ) : (
- <ol style={{paddingLeft: 24}}>
- {layers.map((layer) => {
- const nodePathInfo = getExampleNodePathInfo(layer);
- const layerSelection: CanvasSelectionItem = {
- type: 'sequence',
- nodePathInfo,
- };
- const opacitySelection: CanvasSelectionItem = {
- type: 'sequence-prop',
- nodePathInfo,
- key: 'style.opacity',
- };
- const easingSelection: CanvasSelectionItem = {
- type: 'easing',
- nodePathInfo: {
- ...nodePathInfo,
- auxiliaryKeys: ['controls', 'style.opacity'],
- },
- fromFrame: layer.sequence.from,
- toFrame: Math.min(
- layer.sequence.from + 30,
- layer.sequence.from + layer.sequence.duration,
- ),
- segmentIndex: 0,
- };
- const layerSelected = selectedKeys.has(
- getCanvasSelectionItemKey(layerSelection),
- );
- const opacitySelected = selectedKeys.has(
- getCanvasSelectionItemKey(opacitySelection),
- );
- const easingSelected = selectedKeys.has(
- getCanvasSelectionItemKey(easingSelection),
- );
-
- return (
- <li
- key={layer.sequence.id}
- style={{
- marginBottom: 16,
- paddingLeft: layer.depth * 16,
- }}
- >
- <button
- type="button"
- aria-pressed={layerSelected}
- onClick={(event) => {
- controller.selection.select(
- layerSelection,
- {
- shiftKey: event.shiftKey,
- toggleKey: event.metaKey || event.ctrlKey,
- },
- selectableLayers,
- );
- }}
- style={{
- backgroundColor: layerSelected ? '#ddd6fe' : 'white',
- border: '1px solid #d1d5db',
- borderRadius: 4,
- padding: '6px 8px',
- textAlign: 'left',
- width: '100%',
- }}
- >
- <strong>
- {layer.sequence.displayName ?? layer.sequence.type}
- </strong>
- <div style={{color: '#555', fontSize: 14}}>
- {layer.sequence.type} · frame {layer.sequence.from} ·{' '}
- {layer.sequence.duration} frames
- </div>
- </button>
- <div style={{display: 'flex', gap: 6, marginTop: 6}}>
- <button
- type="button"
- aria-pressed={opacitySelected}
- onClick={() =>
- controller.selection.select(
- opacitySelection,
- {shiftKey: false, toggleKey: true},
- [opacitySelection],
- )
- }
- >
- style.opacity
- </button>
- <button
- type="button"
- aria-pressed={easingSelected}
- onClick={() =>
- controller.selection.select(
- easingSelection,
- {shiftKey: false, toggleKey: true},
- [easingSelection],
- )
- }
- >
- Opacity easing
- </button>
- </div>
- </li>
- );
- })}
- </ol>
- )}
- </section>
- <section
- style={{
- border: '1px solid #d1d5db',
- borderRadius: 8,
- marginTop: 16,
- padding: 20,
- }}
- >
- <h2 style={{marginTop: 0}}>
- Selection ({selection.selectedItems.length})
- </h2>
- <p style={{fontSize: 14}}>
- Click a layer to replace the selection. Shift-click selects a
- contiguous range; Command/Ctrl-click toggles a layer. Property and
- easing buttons demonstrate different selection item types.
- </p>
- <button type="button" onClick={controller.selection.clear}>
- Clear selection
- </button>
- <pre
- style={{
- backgroundColor: '#f3f4f6',
- fontSize: 12,
- overflowX: 'auto',
- padding: 12,
- whiteSpace: 'pre-wrap',
- }}
- >
- {JSON.stringify(selection, null, 2)}
- </pre>
- </section>
- </div>
- </div>
- </main>
- );
-};
-
-export default CanvasPage;
diff --git a/packages/player-example/pages/index.tsx b/packages/player-example/pages/index.tsx
index 94cdada93e..382d0416ef 100644
--- a/packages/player-example/pages/index.tsx
+++ b/packages/player-example/pages/index.tsx
@@ -7,16 +7,11 @@ const examples = [
description:
'The original Player testbed with custom controls and thumbnails.',
},
- {
- href: '/canvas',
- name: 'Canvas layers',
- description: 'A Player with a live list of mounted timeline layers.',
- },
{
href: '/browser-bundler',
- name: 'Browser-compiled Player',
+ name: 'Browser-compiled Canvas',
description:
- 'Compile an editable virtual Remotion project and play a registered composition.',
+ 'Compile an editable virtual Remotion project and inspect its live Canvas layers.',
},
{
href: '/audio',
diff --git a/packages/player-example/public/browser-bundler-preview.html b/packages/player-example/public/browser-bundler-preview.html
index f22c2c9ad6..d5976d3ccb 100644
--- a/packages/player-example/public/browser-bundler-preview.html
+++ b/packages/player-example/public/browser-bundler-preview.html
@@ -3,18 +3,21 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
- <title>Live Player preview</title>
+ <title>Live Canvas preview</title>
<style>
+ html,
body {
+ height: 100%;
margin: 0;
font-family: sans-serif;
+ overflow: hidden;
}
</style>
<script defer src="/browser-bundler-preview.js"></script>
</head>
<body>
<main id="browser-bundler-preview">
- <p role="status">Loading the development Player preview…</p>
+ <p role="status">Loading the development Canvas preview…</p>
</main>
</body>
</html>
diff --git a/packages/player-example/src/BrowserBundlerExample.tsx b/packages/player-example/src/BrowserBundlerExample.tsx
index 50f48fbdcc..a5d047433a 100644
--- a/packages/player-example/src/BrowserBundlerExample.tsx
+++ b/packages/player-example/src/BrowserBundlerExample.tsx
@@ -8,7 +8,7 @@ import React, {useCallback, useEffect, useRef, useState} from 'react';
import type {BrowserBundlerPreview} from './browser-bundler-preview/bridge';
const initialSource = `import React, {useState} from 'react';
-import {AbsoluteFill, useCurrentFrame, useVideoConfig} from 'remotion';
+import {AbsoluteFill, Sequence, useCurrentFrame, useVideoConfig} from 'remotion';
import {Orb} from './Orb';
export const Video: React.FC<{title: string; accent: string}> = ({title, accent}) => {
@@ -21,18 +21,25 @@ export const Video: React.FC<{title: string; accent: string}> = ({title, accent}
backgroundColor: '#0f172a', color: 'white', fontFamily: 'sans-serif',
justifyContent: 'center', padding: 80,
}}>
- <Orb accent={accent} />
- <div style={{position: 'relative', transform: \`translateY(\${Math.sin(frame / fps) * 12}px)\`}}>
- <h1 style={{fontSize: 76, margin: 0}}>{title}</h1>
- <p style={{fontSize: 28, color: accent}}>Frame {frame} of {durationInFrames}</p>
- <button type="button" style={{fontSize: 28, padding: '8px 16px'}}
- onClick={(event) => {
- event.stopPropagation();
- setClicks((value) => value + 1);
- }}>
- Clicks: {clicks}
- </button>
- </div>
+ <Sequence name="Background" layout="none">
+ <AbsoluteFill style={{background: 'linear-gradient(135deg, #0f172a, #312e81)'}} />
+ </Sequence>
+ <Sequence name="Orb" layout="none">
+ <Orb accent={accent} />
+ </Sequence>
+ <Sequence name="Content" layout="none">
+ <div style={{position: 'relative', transform: \`translateY(\${Math.sin(frame / fps) * 12}px)\`}}>
+ <h1 style={{fontSize: 76, margin: 0}}>{title}</h1>
+ <p style={{fontSize: 28, color: accent}}>Frame {frame} of {durationInFrames}</p>
+ <button type="button" style={{fontSize: 28, padding: '8px 16px'}}
+ onClick={(event) => {
+ event.stopPropagation();
+ setClicks((value) => value + 1);
+ }}>
+ Clicks: {clicks}
+ </button>
+ </div>
+ </Sequence>
</AbsoluteFill>
);
};
@@ -175,7 +182,7 @@ export const BrowserBundlerExample: React.FC = () => {
if (!iframe) {
setState({
type: 'error',
- message: 'The Player preview iframe is missing.',
+ message: 'The Canvas preview iframe is missing.',
});
return;
}
@@ -233,7 +240,7 @@ export const BrowserBundlerExample: React.FC = () => {
});
loadTimeout = window.setTimeout(
() =>
- failPreview(new Error('Timed out while loading the Player preview.')),
+ failPreview(new Error('Timed out while loading the Canvas preview.')),
30_000,
);
const onLoad = () => {
@@ -248,7 +255,7 @@ export const BrowserBundlerExample: React.FC = () => {
if (loaded) {
failPreview(
new Error(
- 'The Player preview reloaded. Reload this page to reconnect.',
+ 'The Canvas preview reloaded. Reload this page to reconnect.',
),
);
return;
@@ -259,7 +266,7 @@ export const BrowserBundlerExample: React.FC = () => {
if (!initialize) {
failPreview(
new Error(
- 'Could not load the development Player preview. Run "bun run make" in packages/player-example and reload this page.',
+ 'Could not load the development Canvas preview. Run "bun run make" in packages/player-example and reload this page.',
),
);
return;
@@ -280,7 +287,7 @@ export const BrowserBundlerExample: React.FC = () => {
.catch(failPreview);
};
const onError = () =>
- failPreview(new Error('The Player preview iframe failed to load.'));
+ failPreview(new Error('The Canvas preview iframe failed to load.'));
iframe.addEventListener('load', onLoad);
iframe.addEventListener('error', onError);
iframe.src = '/browser-bundler-preview.html';
@@ -295,7 +302,7 @@ export const BrowserBundlerExample: React.FC = () => {
}
iframe.removeEventListener('load', onLoad);
iframe.removeEventListener('error', onError);
- rejectPreview(new Error('The Player preview was disposed.'));
+ rejectPreview(new Error('The Canvas preview was disposed.'));
try {
previewRuntime?.dispose();
} finally {
@@ -314,82 +321,150 @@ export const BrowserBundlerExample: React.FC = () => {
return (
<main
style={{
+ backgroundColor: '#0b0d12',
+ color: '#e5e7eb',
+ display: 'flex',
+ flexDirection: 'column',
fontFamily: 'sans-serif',
- margin: '40px auto',
- maxWidth: 1000,
- padding: '0 20px',
+ height: '100vh',
+ overflow: 'hidden',
}}
>
- <Link href="/">All Player examples</Link>
- <h1>Browser-compiled Player</h1>
- <p>
- A virtual Remotion project calls <code>registerRoot()</code>. This page
- selects <code>BrowserDemo</code> and uses its registered component,
- default props, and calculated metadata in a Player.
- </p>
- <p>
- Edits use React Fast Refresh to preserve component state and playback.
- The persistent preview iframe bundles its own development React, even
- when this page uses production React. Only run code you trust: this
- same-origin iframe is not a security sandbox.
- </p>
- <div>
- <label htmlFor="browser-video-source">
- <strong>Video.tsx source</strong>
- </label>
- <textarea
- id="browser-video-source"
- value={source}
- onChange={(event) => {
- const nextSource = event.target.value;
- setSource(nextSource);
- void compile(nextSource);
+ <header
+ style={{
+ alignItems: 'center',
+ borderBottom: '1px solid #2b303b',
+ display: 'flex',
+ flex: '0 0 56px',
+ gap: 16,
+ padding: '0 18px',
+ }}
+ >
+ <Link href="/" style={{color: '#9ca3af', fontSize: 13}}>
+ Player examples
+ </Link>
+ <div style={{borderLeft: '1px solid #374151', height: 24}} />
+ <div>
+ <h1 style={{fontSize: 16, margin: 0}}>Browser-compiled Canvas</h1>
+ <div style={{color: '#9ca3af', fontSize: 12}}>
+ Fast Refresh · live layers
+ </div>
+ </div>
+ <p
+ role="status"
+ aria-live="polite"
+ style={{
+ backgroundColor: state.type === 'error' ? '#3f1515' : '#172033',
+ border: `1px solid ${state.type === 'error' ? '#7f1d1d' : '#293958'}`,
+ borderRadius: 999,
+ color: state.type === 'error' ? '#fecaca' : '#bfdbfe',
+ fontSize: 12,
+ margin: '0 0 0 auto',
+ padding: '5px 10px',
}}
- rows={17}
- spellCheck={false}
+ >
+ {state.type === 'loading'
+ ? (progress ?? 'Compiling…')
+ : state.type === 'ready'
+ ? 'Up to date'
+ : 'Compilation failed'}
+ </p>
+ </header>
+ <div
+ style={{
+ display: 'grid',
+ flex: 1,
+ gridTemplateColumns: 'minmax(280px, 36%) minmax(0, 1fr)',
+ minHeight: 0,
+ }}
+ >
+ <section
+ aria-label="Code editor"
style={{
- boxSizing: 'border-box',
- display: 'block',
- fontFamily: 'monospace',
- fontSize: 13,
- lineHeight: 1.5,
- margin: '8px 0 12px',
- padding: 12,
- width: '100%',
+ borderRight: '1px solid #2b303b',
+ display: 'flex',
+ flexDirection: 'column',
+ minHeight: 0,
}}
- />
- </div>
- <p role="status" aria-live="polite">
- {state.type === 'loading'
- ? (progress ?? 'Compiling the virtual project...')
- : state.type === 'ready'
- ? 'BrowserDemo compiled successfully with Fast Refresh.'
- : 'Compilation or preview failed.'}
- </p>
- {warnings.length > 0 ? (
- <section aria-label="Compiler warnings">
- <h2>Warnings</h2>
- <ul>
- {warnings.map((warning, index) => (
- <li key={`${index}-${warning}`}>
- <pre style={{whiteSpace: 'pre-wrap'}}>{warning}</pre>
- </li>
- ))}
- </ul>
+ >
+ <label
+ htmlFor="browser-video-source"
+ style={{
+ backgroundColor: '#141820',
+ borderBottom: '1px solid #2b303b',
+ color: '#cbd5e1',
+ fontFamily: 'monospace',
+ fontSize: 12,
+ padding: '10px 14px',
+ }}
+ >
+ Video.tsx
+ </label>
+ <textarea
+ id="browser-video-source"
+ value={source}
+ wrap="off"
+ onChange={(event) => {
+ const nextSource = event.target.value;
+ setSource(nextSource);
+ void compile(nextSource);
+ }}
+ spellCheck={false}
+ style={{
+ backgroundColor: '#0f131a',
+ border: 0,
+ boxSizing: 'border-box',
+ color: '#dbeafe',
+ flex: 1,
+ fontFamily: 'monospace',
+ fontSize: 13,
+ lineHeight: 1.55,
+ minHeight: 0,
+ outline: 0,
+ padding: 16,
+ resize: 'none',
+ width: '100%',
+ }}
+ />
+ {warnings.length > 0 || state.type === 'error' ? (
+ <div
+ style={{
+ backgroundColor: '#171116',
+ borderTop: '1px solid #4c1d24',
+ maxHeight: '30%',
+ overflow: 'auto',
+ padding: '10px 14px',
+ }}
+ >
+ {warnings.map((warning, index) => (
+ <pre
+ key={`${index}-${warning}`}
+ style={{fontSize: 11, margin: 0, whiteSpace: 'pre-wrap'}}
+ >
+ {warning}
+ </pre>
+ ))}
+ {state.type === 'error' ? (
+ <pre
+ role="alert"
+ style={{color: '#fca5a5', fontSize: 11, margin: 0}}
+ >
+ {state.message}
+ </pre>
+ ) : null}
+ </div>
+ ) : null}
</section>
- ) : null}
- {state.type === 'error' ? (
- <pre role="alert" style={{color: '#b91c1c', whiteSpace: 'pre-wrap'}}>
- {state.message}
- </pre>
- ) : null}
- {/* eslint-disable-next-line @remotion/warn-native-media-tag */}
- <iframe
- ref={iframeRef}
- title="Live Player preview"
- allow="autoplay; fullscreen"
- style={{border: 0, width: '100%', aspectRatio: '1280 / 840'}}
- />
+ <section aria-label="Preview" style={{minHeight: 0, minWidth: 0}}>
+ {/* eslint-disable-next-line @remotion/warn-native-media-tag */}
+ <iframe
+ ref={iframeRef}
+ title="Live Canvas preview"
+ allow="autoplay; fullscreen"
+ style={{border: 0, display: 'block', height: '100%', width: '100%'}}
+ />
+ </section>
+ </div>
</main>
);
};
diff --git a/packages/player-example/src/browser-bundler-preview/entry.ts b/packages/player-example/src/browser-bundler-preview/entry.ts
index ff46fa78ed..0524a378ef 100644
--- a/packages/player-example/src/browser-bundler-preview/entry.ts
+++ b/packages/player-example/src/browser-bundler-preview/entry.ts
@@ -14,7 +14,7 @@ window.remotionBrowserBundlerPreview = initialize;
void initialize.catch((error: unknown) => {
const message = document.createElement('p');
message.setAttribute('role', 'alert');
- message.textContent = `Could not load the Player preview: ${
+ message.textContent = `Could not load the Canvas preview: ${
error instanceof Error ? error.message : String(error)
}`;
document.body.replaceChildren(message);
diff --git a/packages/player-example/src/browser-bundler-preview/runtime.tsx b/packages/player-example/src/browser-bundler-preview/runtime.tsx
index b4dc10aee2..ce2b181e9a 100644
--- a/packages/player-example/src/browser-bundler-preview/runtime.tsx
+++ b/packages/player-example/src/browser-bundler-preview/runtime.tsx
@@ -3,42 +3,269 @@ import {
createBrowserCompositionObserver,
type BrowserComposition,
} from '@remotion/browser-bundler/runtime';
-import {Player} from '@remotion/player';
-import React, {useEffect} from 'react';
+import {
+ Canvas,
+ getCanvasSelectionItemKey,
+ useCanvasController,
+ useCanvasSelection,
+ type CanvasSelectionItem,
+ type SequenceNodePathInfo,
+ type TimelineTrackData,
+} from '@remotion/canvas';
+import React, {useEffect, useSyncExternalStore} from 'react';
import {createRoot} from 'react-dom/client';
import type {CreateBrowserBundlerPreview} from './bridge';
+const getExampleNodePathInfo = (
+ layer: TimelineTrackData,
+): SequenceNodePathInfo => {
+ return (
+ layer.nodePathInfo ?? {
+ sequenceSubscriptionKey: {
+ absolutePath: 'browser-bundler-example',
+ effectKeys: [],
+ nodePath: ['sequence', layer.sequence.id],
+ sequenceKeys: [],
+ videoConfigValues: null,
+ },
+ auxiliaryKeys: [],
+ index: 0,
+ numberOfSequencesWithThisNodePath: 1,
+ supportsEffects: layer.sequence.controls?.supportsEffects === true,
+ }
+ );
+};
+
const Preview: React.FC<{
readonly composition: BrowserComposition;
readonly revision: number;
readonly onReady: (revision: number) => void;
}> = ({composition: preview, revision, onReady}) => {
+ const controller = useCanvasController();
+ const layers = useSyncExternalStore(
+ controller.timeline.subscribe,
+ controller.timeline.getSnapshot,
+ controller.timeline.getSnapshot,
+ );
+ const selection = useCanvasSelection(controller.selection);
+ const selectedKeys = new Set(
+ selection.selectedItems.map(getCanvasSelectionItemKey),
+ );
+ const selectableLayers: CanvasSelectionItem[] = layers.map((layer) => ({
+ type: 'sequence',
+ nodePathInfo: getExampleNodePathInfo(layer),
+ }));
+
useEffect(() => onReady(revision), [onReady, preview, revision]);
return (
- <section aria-label="Compiled composition">
- <p>
+ <section
+ aria-label="Compiled composition"
+ style={{
+ backgroundColor: '#0b0d12',
+ color: '#e5e7eb',
+ display: 'grid',
+ gridTemplateRows: '40px minmax(0, 1fr) 250px',
+ height: '100vh',
+ overflow: 'hidden',
+ }}
+ >
+ <p
+ style={{
+ alignItems: 'center',
+ backgroundColor: '#141820',
+ borderBottom: '1px solid #2b303b',
+ color: '#9ca3af',
+ display: 'flex',
+ fontSize: 12,
+ margin: 0,
+ padding: '0 14px',
+ }}
+ >
{preview.width} x {preview.height} / {preview.fps} fps /{' '}
{preview.durationInFrames} frames
</p>
- <Player
- component={preview.component}
- inputProps={preview.props}
- compositionWidth={preview.width}
- compositionHeight={preview.height}
- fps={preview.fps}
- durationInFrames={preview.durationInFrames}
- controls
- alwaysShowControls
- showPlaybackRateControl
- spaceKeyToPlayOrPause={false}
- loop
- acknowledgeRemotionLicense
- errorFallback={({error}) => (
- <p role="alert">Could not play the composition: {error.message}</p>
+ <div
+ style={{
+ alignItems: 'center',
+ backgroundColor: '#080a0f',
+ display: 'flex',
+ justifyContent: 'center',
+ minHeight: 0,
+ overflow: 'hidden',
+ padding: 20,
+ }}
+ >
+ <Canvas
+ controller={controller}
+ component={preview.component}
+ inputProps={preview.props}
+ compositionWidth={preview.width}
+ compositionHeight={preview.height}
+ fps={preview.fps}
+ durationInFrames={preview.durationInFrames}
+ controls
+ alwaysShowControls
+ showPlaybackRateControl
+ spaceKeyToPlayOrPause={false}
+ loop
+ acknowledgeRemotionLicense
+ errorFallback={({error}) => (
+ <p role="alert">Could not play the composition: {error.message}</p>
+ )}
+ style={{maxHeight: '100%', maxWidth: '100%', width: '100%'}}
+ />
+ </div>
+ <section
+ aria-label="Mounted layers"
+ style={{
+ backgroundColor: '#12161e',
+ borderTop: '1px solid #2b303b',
+ display: 'flex',
+ flexDirection: 'column',
+ minHeight: 0,
+ }}
+ >
+ <header
+ style={{
+ alignItems: 'center',
+ borderBottom: '1px solid #2b303b',
+ display: 'flex',
+ flex: '0 0 42px',
+ padding: '0 14px',
+ }}
+ >
+ <h2 style={{fontSize: 13, margin: 0}}>Layers ({layers.length})</h2>
+ <section
+ aria-label="Layer selection"
+ style={{
+ alignItems: 'center',
+ display: 'flex',
+ gap: 8,
+ marginLeft: 'auto',
+ }}
+ >
+ <h2
+ style={{
+ color: '#9ca3af',
+ fontSize: 12,
+ fontWeight: 400,
+ margin: 0,
+ }}
+ >
+ Selection ({selection.selectedItems.length})
+ </h2>
+ <button
+ type="button"
+ onClick={controller.selection.clear}
+ style={{
+ backgroundColor: '#1f2937',
+ border: '1px solid #374151',
+ borderRadius: 4,
+ color: '#d1d5db',
+ fontSize: 11,
+ padding: '3px 8px',
+ }}
+ >
+ Clear
+ </button>
+ </section>
+ </header>
+ {layers.length === 0 ? (
+ <p style={{color: '#9ca3af', fontSize: 12, padding: '0 14px'}}>
+ No layers mounted.
+ </p>
+ ) : (
+ <ol
+ style={{
+ listStyle: 'none',
+ margin: 0,
+ overflow: 'auto',
+ padding: 0,
+ }}
+ >
+ {layers.map((layer) => {
+ const nodePathInfo = getExampleNodePathInfo(layer);
+ const layerSelection: CanvasSelectionItem = {
+ type: 'sequence',
+ nodePathInfo,
+ };
+ const layerSelected = selectedKeys.has(
+ getCanvasSelectionItemKey(layerSelection),
+ );
+
+ return (
+ <li
+ key={layer.sequence.id}
+ style={{borderBottom: '1px solid #242a34'}}
+ >
+ <button
+ type="button"
+ aria-pressed={layerSelected}
+ onClick={(event) => {
+ controller.selection.select(
+ layerSelection,
+ {
+ shiftKey: event.shiftKey,
+ toggleKey: event.metaKey || event.ctrlKey,
+ },
+ selectableLayers,
+ );
+ }}
+ style={{
+ alignItems: 'center',
+ backgroundColor: layerSelected
+ ? '#242c48'
+ : 'transparent',
+ border: 0,
+ color: '#e5e7eb',
+ display: 'grid',
+ fontSize: 11,
+ gridTemplateColumns: 'minmax(100px, 26%) minmax(0, 1fr)',
+ padding: '4px 14px',
+ textAlign: 'left',
+ width: '100%',
+ }}
+ >
+ <strong style={{paddingLeft: layer.depth * 12}}>
+ {layer.sequence.displayName ?? layer.sequence.type}
+ </strong>
+ <div
+ style={{
+ backgroundColor: '#0b0f16',
+ borderRadius: 3,
+ height: 22,
+ overflow: 'hidden',
+ position: 'relative',
+ }}
+ >
+ <div
+ style={{
+ alignItems: 'center',
+ backgroundColor: layerSelected
+ ? '#6366f1'
+ : '#374151',
+ borderRadius: 3,
+ boxSizing: 'border-box',
+ display: 'flex',
+ height: '100%',
+ left: `${(Math.max(0, layer.sequence.from) / preview.durationInFrames) * 100}%`,
+ padding: '0 7px',
+ position: 'absolute',
+ whiteSpace: 'nowrap',
+ width: `${(Math.min(layer.sequence.duration, preview.durationInFrames) / preview.durationInFrames) * 100}%`,
+ }}
+ >
+ frame {layer.sequence.from} · {layer.sequence.duration}f
+ </div>
+ </div>
+ </button>
+ </li>
+ );
+ })}
+ </ol>
)}
- style={{width: '100%'}}
- />
+ </section>
</section>
);
};
@@ -48,7 +275,7 @@ export const createBrowserBundlerPreview: CreateBrowserBundlerPreview = ({
}) => {
const container = document.getElementById('browser-bundler-preview');
if (!container) {
- throw new Error('The Player preview container was not found.');
+ throw new Error('The Canvas preview container was not found.');
}
const runtime = createBrowserBundleRuntime();
@@ -110,7 +337,7 @@ export const createBrowserBundlerPreview: CreateBrowserBundlerPreview = ({
window.removeEventListener('pagehide', dispose);
if (pending) {
window.clearTimeout(pending.timeout);
- pending.reject(new Error('The Player preview was disposed.'));
+ pending.reject(new Error('The Canvas preview was disposed.'));
pending = null;
}
@@ -129,12 +356,12 @@ export const createBrowserBundlerPreview: CreateBrowserBundlerPreview = ({
return {
applyBundle: async (bundle) => {
if (disposed) {
- throw new Error('The Player preview was disposed.');
+ throw new Error('The Canvas preview was disposed.');
}
const RegisteredRoot = await runtime.applyBundle(bundle);
if (disposed) {
- throw new Error('The Player preview was disposed.');
+ throw new Error('The Canvas preview was disposed.');
}
revision++;
diff --git a/packages/player-example/tsconfig.json b/packages/player-example/tsconfig.json
index 30cbbd8c72..aaa0f7547a 100644
--- a/packages/player-example/tsconfig.json
+++ b/packages/player-example/tsconfig.json
@@ -3,7 +3,6 @@
"./src/**/*",
"./pages/index.tsx",
"./pages/player.tsx",
- "./pages/canvas.tsx",
"./pages/browser-bundler.tsx"
],
"compilerOptions": {