🎥 Make videos programmatically with React
Deprecate public Media Parser and WebCodecs APIs in JSDoc
Jonny Burger610ec87f67e4
diff --git a/packages/media-parser/src/containers/m3u/select-stream.ts b/packages/media-parser/src/containers/m3u/select-stream.tsindex 9b7b3d6e84..e2515c74a8 100644--- a/packages/media-parser/src/containers/m3u/select-stream.ts+++ b/packages/media-parser/src/containers/m3u/select-stream.ts@@ -52,6 +52,9 @@ export const selectAssociatedPlaylists = async ({return selectedStreams;};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const defaultSelectM3uAssociatedPlaylists: SelectM3uAssociatedPlaylistsFn =({associatedPlaylists}) => {if (associatedPlaylists.length === 1) {@@ -84,6 +87,9 @@ export const selectStream = async ({return Promise.resolve(selectedStream);};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const defaultSelectM3uStreamFn: SelectM3uStreamFn = ({streams}) => {return Promise.resolve(streams[0].id);};diff --git a/packages/media-parser/src/controller/media-parser-controller.ts b/packages/media-parser/src/controller/media-parser-controller.tsindex d0201a769d..36cb95af29 100644--- a/packages/media-parser/src/controller/media-parser-controller.ts+++ b/packages/media-parser/src/controller/media-parser-controller.ts@@ -37,6 +37,9 @@ export type MediaParserController = {};};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const mediaParserController = (): MediaParserController => {const abortController = new AbortController();const emitter = new MediaParserEmitter();diff --git a/packages/media-parser/src/download-and-parse-media.ts b/packages/media-parser/src/download-and-parse-media.tsindex 002d7fa5d5..907de30bb9 100644--- a/packages/media-parser/src/download-and-parse-media.ts+++ b/packages/media-parser/src/download-and-parse-media.ts@@ -7,6 +7,9 @@ import {Log} from './log';import type {DownloadAndParseMedia} from './options';import {webReader} from './web';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const downloadAndParseMedia: DownloadAndParseMedia = async (options) => {if (!options) {return Promise.reject(diff --git a/packages/media-parser/src/errors.ts b/packages/media-parser/src/errors.tsindex 6e43a7658c..2a384b4b9a 100644--- a/packages/media-parser/src/errors.ts+++ b/packages/media-parser/src/errors.ts@@ -102,6 +102,9 @@ export class MediaParserAbortError extends Error {}}+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const hasBeenAborted = (error: unknown,): error is MediaParserAbortError => {diff --git a/packages/media-parser/src/readers/from-node.ts b/packages/media-parser/src/readers/from-node.tsindex c0d0b4b17d..063603ecc0 100644--- a/packages/media-parser/src/readers/from-node.ts+++ b/packages/media-parser/src/readers/from-node.ts@@ -7,6 +7,9 @@ import type {ReadWholeAsText,} from './reader';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const nodeReadContent: ReadContent = async ({src,range,@@ -104,6 +107,9 @@ export const nodeReadContent: ReadContent = async ({}};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const nodeReadWholeAsText: ReadWholeAsText = (src) => {if (typeof src !== 'string') {throw new Error('src must be a string when using `nodeReader`');@@ -112,6 +118,9 @@ export const nodeReadWholeAsText: ReadWholeAsText = (src) => {return promises.readFile(src, 'utf8');};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const nodeCreateAdjacentFileSource: CreateAdjacentFileSource = (relativePath,src,@@ -131,6 +140,9 @@ export const nodeCreateAdjacentFileSource: CreateAdjacentFileSource = (return result;};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const nodeReader: MediaParserReaderInterface = {read: nodeReadContent,readWholeAsText: nodeReadWholeAsText,diff --git a/packages/media-parser/src/readers/universal.ts b/packages/media-parser/src/readers/universal.tsindex 899986cdc4..44e09cb64f 100644--- a/packages/media-parser/src/readers/universal.ts+++ b/packages/media-parser/src/readers/universal.ts@@ -16,6 +16,9 @@ import {} from './from-web-file';import type {MediaParserReaderInterface} from './reader';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const universalReader: MediaParserReaderInterface = {read: (params) => {if (params.src instanceof Blob) {diff --git a/packages/media-parser/src/readers/web.ts b/packages/media-parser/src/readers/web.tsindex 17110d99b7..3a39b76303 100644--- a/packages/media-parser/src/readers/web.ts+++ b/packages/media-parser/src/readers/web.ts@@ -11,6 +11,9 @@ import {} from './from-web-file';import type {MediaParserReaderInterface} from './reader';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const webReader: MediaParserReaderInterface = {read: (params) => {if (params.src instanceof Blob) {diff --git a/packages/media-parser/src/server-worker.module.ts b/packages/media-parser/src/server-worker.module.tsindex 451c06d908..64d061e75c 100644--- a/packages/media-parser/src/server-worker.module.ts+++ b/packages/media-parser/src/server-worker.module.ts@@ -2,6 +2,9 @@ import type {Options, ParseMediaFields} from './fields';import type {ParseMediaOnWorker, ParseMediaOnWorkerOptions} from './options';import {parseMediaOnWorkerImplementation} from './parse-media-on-worker-entry';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const parseMediaOnServerWorker: ParseMediaOnWorker = <F extends Options<ParseMediaFields>,>(diff --git a/packages/media-parser/src/server-worker.ts b/packages/media-parser/src/server-worker.tsindex a40fb8f691..75b8adf564 100644--- a/packages/media-parser/src/server-worker.ts+++ b/packages/media-parser/src/server-worker.ts@@ -2,6 +2,9 @@ import type {ParseMediaOnWorker} from './options';export type {ParseMediaOnWorker, ParseMediaOnWorkerOptions} from './options';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const parseMediaOnServerWorker: ParseMediaOnWorker = () => {throw new Error('parseMediaOnServerWorker is not available in CJS mode. Load this function using ESM to use it.',diff --git a/packages/media-parser/src/worker.module.ts b/packages/media-parser/src/worker.module.tsindex 676548caf4..b0008801e8 100644--- a/packages/media-parser/src/worker.module.ts+++ b/packages/media-parser/src/worker.module.ts@@ -12,6 +12,9 @@ export {} from './errors';export type {ParseMediaOnWorker, ParseMediaOnWorkerOptions} from './options';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const parseMediaOnWebWorker: ParseMediaOnWorker = <F extends Options<ParseMediaFields>,>(diff --git a/packages/media-parser/src/worker.ts b/packages/media-parser/src/worker.tsindex a73ddb53a6..50c22a44d4 100644--- a/packages/media-parser/src/worker.ts+++ b/packages/media-parser/src/worker.ts@@ -10,6 +10,9 @@ import type {ParseMediaOnWorker} from './options';export type {ParseMediaOnWorker, ParseMediaOnWorkerOptions} from './options';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const parseMediaOnWebWorker: ParseMediaOnWorker = () => {throw new Error('parseMediaOnWebWorker is not available in CJS mode. Load this function using ESM to use it.',diff --git a/packages/media-parser/src/writers/node.ts b/packages/media-parser/src/writers/node.tsindex 38d845ef7b..b5505a69ea 100644--- a/packages/media-parser/src/writers/node.ts+++ b/packages/media-parser/src/writers/node.ts@@ -93,6 +93,9 @@ const createContent = (filename: string): CreateContent => {};};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const nodeWriter = (path: string) => {return {createContent: createContent(path)};};diff --git a/packages/webcodecs/src/audio-encoder.ts b/packages/webcodecs/src/audio-encoder.tsindex 653eec9391..a21ee9c07f 100644--- a/packages/webcodecs/src/audio-encoder.ts+++ b/packages/webcodecs/src/audio-encoder.ts@@ -26,6 +26,9 @@ export type AudioEncoderInit = {onNewAudioSampleRate: (sampleRate: number) => void;};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const createAudioEncoder = ({onChunk,onError,diff --git a/packages/webcodecs/src/can-copy-audio-track.ts b/packages/webcodecs/src/can-copy-audio-track.tsindex 574bb05ff4..d9701ae45a 100644--- a/packages/webcodecs/src/can-copy-audio-track.ts+++ b/packages/webcodecs/src/can-copy-audio-track.ts@@ -6,6 +6,9 @@ import type {ConvertMediaAudioCodec} from './get-available-audio-codecs';import type {ConvertMediaContainer} from './get-available-containers';import {isSameAudioCodec} from './is-different-video-codec';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const canCopyAudioTrack = ({inputCodec,outputContainer,diff --git a/packages/webcodecs/src/can-copy-video-track.ts b/packages/webcodecs/src/can-copy-video-track.tsindex 3b6b525758..f260e799b3 100644--- a/packages/webcodecs/src/can-copy-video-track.ts+++ b/packages/webcodecs/src/can-copy-video-track.ts@@ -9,6 +9,9 @@ import type {ResizeOperation} from './resizing/mode';import {normalizeVideoRotation} from './rotate-and-resize-video-frame';import {calculateNewDimensionsFromRotateAndScale} from './rotation';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const canCopyVideoTrack = ({outputContainer,rotationToApply,diff --git a/packages/webcodecs/src/can-reencode-audio-track.ts b/packages/webcodecs/src/can-reencode-audio-track.tsindex a778f2ac7d..8ad62d12f1 100644--- a/packages/webcodecs/src/can-reencode-audio-track.ts+++ b/packages/webcodecs/src/can-reencode-audio-track.ts@@ -3,6 +3,9 @@ import {getAudioDecoderConfig} from './audio-decoder-config';import {getAudioEncoderConfig} from './audio-encoder-config';import type {ConvertMediaAudioCodec} from './get-available-audio-codecs';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const canReencodeAudioTrack = async ({track,audioCodec,diff --git a/packages/webcodecs/src/can-reencode-video-track.ts b/packages/webcodecs/src/can-reencode-video-track.tsindex 75824d8818..cf0fe7813a 100644--- a/packages/webcodecs/src/can-reencode-video-track.ts+++ b/packages/webcodecs/src/can-reencode-video-track.ts@@ -5,6 +5,9 @@ import {calculateNewDimensionsFromRotateAndScale} from './rotation';import {getVideoDecoderConfigWithHardwareAcceleration} from './video-decoder-config';import {getVideoEncoderConfig} from './video-encoder-config';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const canReencodeVideoTrack = async ({videoCodec,track,diff --git a/packages/webcodecs/src/convert-audiodata.ts b/packages/webcodecs/src/convert-audiodata.tsindex 813494ddcd..da1457cd48 100644--- a/packages/webcodecs/src/convert-audiodata.ts+++ b/packages/webcodecs/src/convert-audiodata.ts@@ -17,6 +17,7 @@ export type ConvertAudioDataOptions = {/*** Converts an `AudioData` object to a new `AudioData` object with a different sample rate or format.* @see [Documentation](https://remotion.dev/docs/webcodecs/convert-audiodata)+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny*/export const convertAudioData = ({audioData,diff --git a/packages/webcodecs/src/convert-media.ts b/packages/webcodecs/src/convert-media.tsindex 5557cc935e..a68e372477 100644--- a/packages/webcodecs/src/convert-media.ts+++ b/packages/webcodecs/src/convert-media.ts@@ -75,6 +75,9 @@ export type ConvertMediaOnAudioData = (options: {track: MediaParserAudioTrack;}) => Promise<AudioData> | AudioData;+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const convertMedia = async function <F extends Options<ParseMediaFields>,>({diff --git a/packages/webcodecs/src/create-audio-decoder.ts b/packages/webcodecs/src/create-audio-decoder.tsindex f8d3175313..6ee9eb61a4 100644--- a/packages/webcodecs/src/create-audio-decoder.ts+++ b/packages/webcodecs/src/create-audio-decoder.ts@@ -203,6 +203,9 @@ export const internalCreateAudioDecoder = async ({};};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const createAudioDecoder = ({track,onFrame,diff --git a/packages/webcodecs/src/create-video-decoder.ts b/packages/webcodecs/src/create-video-decoder.tsindex 80a386cceb..5817d6ce84 100644--- a/packages/webcodecs/src/create-video-decoder.ts+++ b/packages/webcodecs/src/create-video-decoder.ts@@ -169,6 +169,9 @@ export const internalCreateVideoDecoder = async ({};};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const createVideoDecoder = ({onFrame,onError,diff --git a/packages/webcodecs/src/default-on-audio-track-handler.ts b/packages/webcodecs/src/default-on-audio-track-handler.tsindex 35ca5bbb5a..97aaa322a5 100644--- a/packages/webcodecs/src/default-on-audio-track-handler.ts+++ b/packages/webcodecs/src/default-on-audio-track-handler.ts@@ -7,6 +7,9 @@ import type {const DEFAULT_BITRATE = 128_000;+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const defaultOnAudioTrackHandler: ConvertMediaOnAudioTrackHandler =async ({track,diff --git a/packages/webcodecs/src/default-on-video-track-handler.ts b/packages/webcodecs/src/default-on-video-track-handler.tsindex 15f7a0d401..eeef786499 100644--- a/packages/webcodecs/src/default-on-video-track-handler.ts+++ b/packages/webcodecs/src/default-on-video-track-handler.ts@@ -5,6 +5,9 @@ import type {VideoOperation,} from './on-video-track-handler';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const defaultOnVideoTrackHandler: ConvertMediaOnVideoTrackHandler =async ({track,diff --git a/packages/webcodecs/src/extract-frames-on-web-worker.ts b/packages/webcodecs/src/extract-frames-on-web-worker.tsindex 4bd7b50ebb..03fca49d4f 100644--- a/packages/webcodecs/src/extract-frames-on-web-worker.ts+++ b/packages/webcodecs/src/extract-frames-on-web-worker.ts@@ -18,6 +18,9 @@ export type ExtractFramesOnWebWorker = (options: ExtractFramesOnWebWorkerProps,) => Promise<void>;+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const extractFramesOnWebWorker: ExtractFramesOnWebWorker = (options: ExtractFramesOnWebWorkerProps,) => {diff --git a/packages/webcodecs/src/extract-frames.ts b/packages/webcodecs/src/extract-frames.tsindex dc173b6ee6..a37392f93f 100644--- a/packages/webcodecs/src/extract-frames.ts+++ b/packages/webcodecs/src/extract-frames.ts@@ -15,6 +15,9 @@ export type ExtractFramesProps = {export type ExtractFrames = (options: ExtractFramesProps) => Promise<void>;+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const extractFrames: ExtractFrames = (options: ExtractFramesProps) => {return internalExtractFrames({...options,diff --git a/packages/webcodecs/src/get-available-audio-codecs.ts b/packages/webcodecs/src/get-available-audio-codecs.tsindex 0588fd5d66..52f02674f9 100644--- a/packages/webcodecs/src/get-available-audio-codecs.ts+++ b/packages/webcodecs/src/get-available-audio-codecs.ts@@ -2,6 +2,9 @@ import type {ConvertMediaContainer} from './get-available-containers';// eslint-disable-next-line @typescript-eslint/no-unused-varsconst availableAudioCodecs = ['opus', 'aac', 'wav'] as const;+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const getAvailableAudioCodecs = ({container,}: {diff --git a/packages/webcodecs/src/get-available-containers.ts b/packages/webcodecs/src/get-available-containers.tsindex acfca789ea..b7e10a8c8e 100644--- a/packages/webcodecs/src/get-available-containers.ts+++ b/packages/webcodecs/src/get-available-containers.ts@@ -1,6 +1,9 @@export const availableContainers = ['webm', 'mp4', 'wav'] as const;export type ConvertMediaContainer = (typeof availableContainers)[number];+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const getAvailableContainers = (): readonly ConvertMediaContainer[] => {return availableContainers;};diff --git a/packages/webcodecs/src/get-available-video-codecs.ts b/packages/webcodecs/src/get-available-video-codecs.tsindex 7e79910962..f9f986977b 100644--- a/packages/webcodecs/src/get-available-video-codecs.ts+++ b/packages/webcodecs/src/get-available-video-codecs.ts@@ -3,6 +3,9 @@ import type {ConvertMediaContainer} from './get-available-containers';export const availableVideoCodecs = ['vp8', 'vp9', 'h264', 'h265'] as const;export type ConvertMediaVideoCodec = (typeof availableVideoCodecs)[number];+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const getAvailableVideoCodecs = ({container,}: {diff --git a/packages/webcodecs/src/get-default-audio-codec.ts b/packages/webcodecs/src/get-default-audio-codec.tsindex 6d3e7d776d..32e4cb951d 100644--- a/packages/webcodecs/src/get-default-audio-codec.ts+++ b/packages/webcodecs/src/get-default-audio-codec.ts@@ -1,6 +1,9 @@import type {ConvertMediaAudioCodec} from './get-available-audio-codecs';import type {ConvertMediaContainer} from './get-available-containers';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const getDefaultAudioCodec = ({container,}: {diff --git a/packages/webcodecs/src/get-default-video-codec.ts b/packages/webcodecs/src/get-default-video-codec.tsindex c6f3069e1c..f7543cd9f3 100644--- a/packages/webcodecs/src/get-default-video-codec.ts+++ b/packages/webcodecs/src/get-default-video-codec.ts@@ -1,6 +1,9 @@import type {ConvertMediaContainer} from './get-available-containers';import type {ConvertMediaVideoCodec} from './get-available-video-codecs';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const getDefaultVideoCodec = ({container,}: {diff --git a/packages/webcodecs/src/get-partial-audio-data.ts b/packages/webcodecs/src/get-partial-audio-data.tsindex eba4960549..80d8fec504 100644--- a/packages/webcodecs/src/get-partial-audio-data.ts+++ b/packages/webcodecs/src/get-partial-audio-data.ts@@ -81,6 +81,9 @@ export type GetPartialAudioDataProps = {signal: AbortSignal;};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const getPartialAudioData = async ({src,fromSeconds,diff --git a/packages/webcodecs/src/rotate-and-resize-video-frame.ts b/packages/webcodecs/src/rotate-and-resize-video-frame.tsindex 32323610a5..19f3f84eee 100644--- a/packages/webcodecs/src/rotate-and-resize-video-frame.ts+++ b/packages/webcodecs/src/rotate-and-resize-video-frame.ts@@ -8,6 +8,9 @@ export const normalizeVideoRotation = (rotation: number) => {return ((rotation % 360) + 360) % 360;};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const rotateAndResizeVideoFrame = ({frame,rotation,diff --git a/packages/webcodecs/src/video-encoder.ts b/packages/webcodecs/src/video-encoder.tsindex 18d7e3d235..61b87972aa 100644--- a/packages/webcodecs/src/video-encoder.ts+++ b/packages/webcodecs/src/video-encoder.ts@@ -17,6 +17,9 @@ export type WebCodecsVideoEncoder = {ioSynchronizer: IoSynchronizer;};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const createVideoEncoder = ({onChunk,onError,diff --git a/packages/webcodecs/src/webcodecs-controller.ts b/packages/webcodecs/src/webcodecs-controller.tsindex aa56c99183..4b1e72739f 100644--- a/packages/webcodecs/src/webcodecs-controller.ts+++ b/packages/webcodecs/src/webcodecs-controller.ts@@ -16,6 +16,9 @@ export type WebCodecsController = {};};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const webcodecsController = (): WebCodecsController => {const controller = mediaParserController();diff --git a/packages/webcodecs/src/writers/buffer.ts b/packages/webcodecs/src/writers/buffer.tsindex 3545615bd6..bf6d1e41fd 100644--- a/packages/webcodecs/src/writers/buffer.ts+++ b/packages/webcodecs/src/writers/buffer.ts@@ -1,6 +1,9 @@import type {WriterInterface} from '@remotion/media-parser';import {createContent} from './buffer-implementation/writer';+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const bufferWriter: WriterInterface = {createContent,};diff --git a/packages/webcodecs/src/writers/web-fs.ts b/packages/webcodecs/src/writers/web-fs.tsindex bcd4414abd..08f1d9990d 100644--- a/packages/webcodecs/src/writers/web-fs.ts+++ b/packages/webcodecs/src/writers/web-fs.ts@@ -72,10 +72,16 @@ const createContent: CreateContent = async ({filename}) => {return writer;};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const webFsWriter: WriterInterface = {createContent,};+/**+ * @deprecated Use Mediabunny instead: https://www.remotion.dev/docs/mediabunny+ */export const canUseWebFsWriter = async () => {if (!('storage' in navigator)) {return false;