Skip to content

🎥 Make videos programmatically with React

`@remotion/web-renderer`: Allow setting metadata

Jonny Burger99f487233252
diff --git a/packages/docs/docs/web-renderer/render-media-on-web.mdx b/packages/docs/docs/web-renderer/render-media-on-web.mdx
index 1648f59a15..37eca9f01d 100644
--- a/packages/docs/docs/web-renderer/render-media-on-web.mdx
+++ b/packages/docs/docs/web-renderer/render-media-on-web.mdx
@@ -209,6 +209,37 @@ _number_
The [audio sample rate](/docs/sample-rate) in Hz.
Default is `48000`.
+### `metadata?`<AvailableFrom v="4.0.517" />
+
+_object_ <TsType type="MetadataTags" source="mediabunny" href="https://mediabunny.dev/api/MetadataTags" />
+
+Metadata to embed in the output media. See [Mediabunny's metadata documentation](https://mediabunny.dev/guide/reading-media-files#reading-metadata-tags) for the available fields.
+
+```tsx twoslash title="Set output metadata"
+const Component: React.FC = () => null;
+
+// ---cut---
+import {renderMediaOnWeb} from '@remotion/web-renderer';
+
+await renderMediaOnWeb({
+ composition: {
+ component: Component,
+ durationInFrames: 100,
+ fps: 30,
+ width: 1920,
+ height: 1080,
+ id: 'my-composition',
+ },
+ metadata: {
+ title: 'My video',
+ artist: 'Remotion user',
+ comment: 'My comment',
+ },
+});
+```
+
+Remotion adds `Made with Remotion <version>` to the comment. If you pass a comment, it is appended after this text.
+
### `delayRenderTimeoutInMilliseconds?`
_number_
diff --git a/packages/web-renderer/src/render-media-on-web.tsx b/packages/web-renderer/src/render-media-on-web.tsx
index 3b55ded523..72d87674ac 100644
--- a/packages/web-renderer/src/render-media-on-web.tsx
+++ b/packages/web-renderer/src/render-media-on-web.tsx
@@ -1,4 +1,9 @@
-import {BufferTarget, StreamTarget, type StreamTargetChunk} from 'mediabunny';
+import {
+ BufferTarget,
+ StreamTarget,
+ type MetadataTags,
+ type StreamTargetChunk,
+} from 'mediabunny';
import type {CalculateMetadataFunction} from 'remotion';
import {Internals, type LogLevel} from 'remotion';
import {VERSION} from 'remotion/version';
@@ -140,6 +145,7 @@ type OptionalRenderMediaOnWebOptions<Schema extends $ZodObject> = {
scale: number;
sampleRate: number;
allowHtmlInCanvas: boolean;
+ metadata: MetadataTags | null;
};
export type RenderMediaOnWebOptions<
@@ -191,6 +197,7 @@ const internalRenderMediaOnWeb = async <
isProduction,
sampleRate,
allowHtmlInCanvas,
+ metadata,
}: InternalRenderMediaOnWebOptions<
Schema,
Props
@@ -423,8 +430,13 @@ const internalRenderMediaOnWeb = async <
target,
});
+ const defaultComment = `Made with Remotion ${VERSION}`;
outputWithCleanup.output.setMetadataTags({
- comment: `Made with Remotion ${VERSION}`,
+ ...(metadata ?? {}),
+ comment:
+ metadata?.comment === undefined
+ ? defaultComment
+ : `${defaultComment}; ${metadata.comment}`,
});
using throttledProgress = createThrottledProgressCallback(onProgress);
@@ -799,6 +811,7 @@ export const renderMediaOnWeb = <
isProduction: options.isProduction ?? true,
allowHtmlInCanvas: options.allowHtmlInCanvas ?? false,
sampleRate: options.sampleRate ?? 48000,
+ metadata: options.metadata ?? null,
}),
);
diff --git a/packages/web-renderer/src/test/render-media.test.tsx b/packages/web-renderer/src/test/render-media.test.tsx
index 51652fa358..dcca05d527 100644
--- a/packages/web-renderer/src/test/render-media.test.tsx
+++ b/packages/web-renderer/src/test/render-media.test.tsx
@@ -322,7 +322,7 @@ test(
},
);
-test('should include "Made with Remotion" metadata', async (t) => {
+test('should include custom metadata and "Made with Remotion"', async (t) => {
if (t.task.file.projectName === 'webkit') {
t.skip();
return;
@@ -340,6 +340,11 @@ test('should include "Made with Remotion" metadata', async (t) => {
durationInFrames: 5,
},
inputProps: {},
+ metadata: {
+ title: 'My video',
+ artist: 'Remotion user',
+ comment: 'My comment',
+ },
});
const blob = await result.getBlob();
@@ -350,7 +355,9 @@ test('should include "Made with Remotion" metadata', async (t) => {
});
const tags = await input.getMetadataTags();
- expect(tags.comment).toBe(`Made with Remotion ${VERSION}`);
+ expect(tags.title).toBe('My video');
+ expect(tags.artist).toBe('Remotion user');
+ expect(tags.comment).toBe(`Made with Remotion ${VERSION}; My comment`);
});
test('should not fire stale progress callbacks after render completes', async (t) => {