remotion 4.0.0-alpha.4 → 4.0.0-alpha4

package/LICENSE.md

@@ -1,34 +1,34 @@
 # Remotion License
 
-Depending on the type of your legal entity, you are granted permission to use Remotion for your project. Individuals and small companies are allowed to use Remotion create videos for free (even commercial), while a company license is required for for-profit organisations of a certain size. This two-tier system was designed to ensure funding for this project while still allowing the source code to be available and the program to be free for most. Read below for the exact terms of use.
+Depending on the type of your legal entity, you are granted permission to use Remotion for your project. Individuals and small companies are allowed to use Remotion to create videos for free (even commercial), while a company license is required for for-profit organizations of a certain size. This two-tier system was designed to ensure funding for this project while still allowing the source code to be available and the program to be free for most. Read below for the exact terms of use.
 
 - [Free license](#free-license)
 - [Company license](#company-license)
 
 ## Free license
 
-Copyright © 2022 [Jonny Burger](https://jonny.io)
+Copyright © 2023 [Remotion](https://www.remotion.dev/)
 
 ### Eligibility
 
 You are eligible to use Remotion for free if you are:
 
 - an individual
-- a for-profit organisation with up to 3 employees
-- a non-profit or not-for-profit organisation
+- a for-profit organization with up to 3 employees
+- a non-profit or not-for-profit organization
 - evaluating whether Remotion is a good fit, and are not yet using it in a commercial way
 
 ### Allowed use cases
 
-Permission is hereby granted, free of charge, to any person eligible for the "Free license", to use the software non-commercially or commercially for the purpose of creating videos and images and to modify and the software to their own liking, for the purpose of fulfilling their custom use case or to contribute bug fixes or improvements back to Remotion.
+Permission is hereby granted, free of charge, to any person eligible for the "Free license", to use the software non-commercially or commercially for the purpose of creating videos and images and to modify the software to their own liking, for the purpose of fulfilling their custom use case or to contribute bug fixes or improvements back to Remotion.
 
 ### Disallowed use cases
 
-It is not allowed to copy or modify Remotion code for the purpose of selling, renting, licensing, relicensing, sublicensing your own derivate of Remotion.
+It is not allowed to copy or modify Remotion code for the purpose of selling, renting, licensing, relicensing, or sublicensing your own derivate of Remotion.
 
 ### Warranty notice
 
-The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the author or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
+The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the author or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
 
 ### Support
 
@@ -36,6 +36,6 @@ Support is provided on a best-we-can-do basis via GitHub Issues and Discord.
 
 ## Company license
 
-You are required to obtain a company license to use Remotion if you are not within the group of entities eligible for a free license. This license will enable you to use Remotion for the allowed use cases specified in the free license, and give you access to prioritized support.
+You are required to obtain a company license to use Remotion if you are not within the group of entities eligible for a free license. This license will enable you to use Remotion for the allowed use cases specified in the free license, and give you access to prioritized support (read the [Support Policy](/docs/support)).
 
 Visit [companies.remotion.dev](https://companies.remotion.dev) for pricing and to buy a license.

package/README.md

@@ -1,15 +1,19 @@
 <p align="center">
   <a href="https://github.com/remotion-dev/logo">
-    <img src="https://github.com/remotion-dev/logo/raw/main/withtitle/element-0.png">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://github.com/remotion-dev/logo/raw/main/animated-logo-banner-dark.gif">
+      <img alt="Animated Remotion Logo" src="https://github.com/remotion-dev/logo/raw/main/animated-logo-banner-light.gif">
+    </picture>
   </a>
 </p>
 
-[![Discord Shield](https://discordapp.com/api/guilds/809501355504959528/widget.png?style=shield)](https://remotion.dev/discord)
-[![NPM Version](http://img.shields.io/npm/v/remotion.svg?style=flat)](https://www.npmjs.org/package/remotion)
-[![NPM Downloads](https://img.shields.io/npm/dm/remotion.svg?style=flat)](https://npmcharts.com/compare/remotion?minimal=true)
-[![Install Size](https://packagephobia.now.sh/badge?p=remotion)](https://packagephobia.now.sh/result?p=remotion)
+[![Discord Shield](https://img.shields.io/discord/809501355504959528?color=000000&label=Discord&logo=fdgssdf)](https://remotion.dev/discord)
+[![NPM Version](https://img.shields.io/npm/v/remotion.svg?style=flat&color=black)](https://www.npmjs.org/package/remotion)
+[![NPM Downloads](https://img.shields.io/npm/dm/remotion.svg?style=flat&color=black&label=Downloads)](https://npmcharts.com/compare/remotion?minimal=true)
+[![Open Bounties](https://img.shields.io/endpoint?url=https%3A%2F%2Fconsole.algora.io%2Fapi%2Fshields%2Fremotion%2Fbounties%3Fstatus%3Dopen&style=flat&color=black&labelColor=grey&label=Open+Bounties)](https://github.com/remotion-dev/remotion/issues?q=is%3Aopen+label%3A%22%F0%9F%92%8E+Bounty%22+sort%3Aupdated-desc)
+<a href="https://twitter.com/remotion"><img src="https://img.shields.io/twitter/follow/remotion?label=Twitter&color=black" alt="Twitter"></a>
 
-Remotion is a suite of libraries building a foundation for **creating videos programmatically using React.**
+Remotion is a framework for **creating videos programmatically using React.**
 
 ## Why create videos in React?
 
@@ -17,35 +21,42 @@ Remotion is a suite of libraries building a foundation for **creating videos pro
 - **Leverage programming**: Use variables, functions, APIs, math and algorithms to create new effects
 - **Leverage React**: Reusable components, Powerful composition, Fast Refresh, Package ecosystem
 
-## Example videos
-
-- **Remotion Trailer** [Watch](https://www.youtube.com/watch?v=gwlDorikqgY) • [Source code](https://github.com/remotion-dev/trailer) • The announcement video for Remotion was written in Remotion itself!
-- **AnySticker Welcome Video** [Watch](https://www.youtube.com/watch?v=Y0SNPeTz09w) • [Source code](https://github.com/JonnyBurger/anysticker-tutorials) • An in-app explainer video for my app AnySticker.
-- **Spotify Wrapped Recreated** [Watch](https://twitter.com/JNYBGR/status/1360269270526136320) • [Tutorial](https://www.youtube.com/watch?v=I-y_5H9-3gk) • [Source code](https://github.com/JonnyBurger/remotion-wrapped) • A recreation of Spotify Wrapped where you can override all text and images via command line.
-- **"Game changer or no game changer" intro** [Watch](https://youtu.be/ga_xAZo9m7k?t=61) • [Source code](https://github.com/JonnyBurger/gamechanger-or-no-gamechanger-intro) • An intro for a quiz show I did with William Candillon.
-- **"The X in MDX" talk** [Watch](https://twitter.com/pomber/status/1359556846688886789) • [Source code](https://github.com/pomber/record-talk-with-remotion) • A re-recording of [this talk](https://www.youtube.com/watch?v=xEu3t-KJVVg) using Remotion.
-- **Redesigning the Scatterplot** [Watch](https://twitter.com/BrooksLybrand/status/1371547875109445635) • [Source code](https://github.com/brookslybrand/redesigning-scatterplots) • An animated section of Edward R. Tufte's book [The Visual Display of Quantitative Information](https://www.amazon.com/Visual-Display-Quantitative-Information/dp/0961392142/ref=sr_1_1?crid=3HQZSBUUROV09&dchild=1&keywords=the+visual+display+of+quantitative+information&qid=1615907320&sprefix=the+visual+disp%2Caps%2C190&sr=8-1).
-- **News Podcast Maker** [Watch](https://www.youtube.com/watch?v=Mwo5iNlWryg) • [Source code](https://github.com/FelippeChemello/podcast-maker/) • A fully automated News Podcast Maker.
-
-Feel free to pull request your creations!
+## Created with Remotion
+
+<table>
+<tr>
+<td align="center">
+<img style="width: 290px" src="packages/docs/static/img/fireship-quick.gif" />
+<p>"This video was made with code" <em>- Fireship</em> <a href="https://youtu.be/deg8bOoziaE">Watch</a> • <a href="https://github.com/wcandillon/remotion-fireship">Source</a></p>
+</td>
+<td align="center">
+<img style="width: 240px" src="packages/docs/static/img/unwrapped-2022.gif" />
+<p>GitHub Unwrapped - Personalized Year in Review <a href="https://www.githubunwrapped.com">Try</a> • <a href="https://github.com/remotion-dev/github-unwrapped-2022">Source</a></p>
+</td>
+<td align="center">
+<em>View more in the <a href="https://remotion.dev/showcase">Remotion Showcase</a>!</em>
+</td>
+</tr>
+</table>
 
 ## Get started
 
-If you already have Yarn and FFMPEG installed, type
+If you already have Node.JS installed, type
 
 ```console
-yarn create video
+npm init video
 ```
 
 to get started. Otherwise, read the [installation page](https://www.remotion.dev/docs/) in the documentation.
 
 ## Documentation
 
-Head to [**remotion.dev**](https://www.remotion.dev) to learn the in and outs of Remotion!
+Documentation: [**remotion.dev/docs**](https://www.remotion.dev/docs)  
+API Reference: [**remotion.dev/api**](https://www.remotion.dev/api)
 
 ## License
 
-Be aware of that Remotion has a special license and requires obtaining a company license in some cases. Read the [LICENSE](LICENSE.md) documentation for more information.
+Be aware of that Remotion has a special license and requires obtaining a company license in some cases. Read the [LICENSE](LICENSE.md) page for more information.
 
 ## Contributing
 

package/dist/cjs/AbsoluteFill.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+/**
+ * @description An absolutely positioned <div> element with 100% width, height, and a column flex style
+ * @see [Documentation](https://www.remotion.dev/docs/absolute-fill)
+ */
+export declare const AbsoluteFill: React.ForwardRefExoticComponent<Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "key" | keyof React.HTMLAttributes<HTMLDivElement>> & React.RefAttributes<HTMLDivElement>>;

package/dist/{AbsoluteFill.js → cjs/AbsoluteFill.js}

@@ -3,11 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbsoluteFill = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = require("react");
-/**
- * An absolutely positioned <div> element with 100% width, height, and a column flex style
- * @link https://www.remotion.dev/docs/absolute-fill
- */
-const AbsoluteFill = (props) => {
+const AbsoluteFillRefForwarding = (props, ref) => {
     const { style, ...other } = props;
     const actualStyle = (0, react_1.useMemo)(() => {
         return {
@@ -23,6 +19,10 @@ const AbsoluteFill = (props) => {
             ...style,
         };
     }, [style]);
-    return (0, jsx_runtime_1.jsx)("div", { style: actualStyle, ...other });
+    return (0, jsx_runtime_1.jsx)("div", { ref: ref, style: actualStyle, ...other });
 };
-exports.AbsoluteFill = AbsoluteFill;
+/**
+ * @description An absolutely positioned <div> element with 100% width, height, and a column flex style
+ * @see [Documentation](https://www.remotion.dev/docs/absolute-fill)
+ */
+exports.AbsoluteFill = (0, react_1.forwardRef)(AbsoluteFillRefForwarding);

package/dist/cjs/Clipper.d.ts

@@ -0,0 +1,7 @@
+import type React from 'react';
+export declare const Clipper: React.FC<{
+    width: number;
+    height: number;
+    x: number;
+    y: number;
+}>;

package/dist/cjs/Clipper.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Clipper = void 0;
+const react_1 = require("react");
+const NativeLayers_js_1 = require("./NativeLayers.js");
+const Clipper = ({ height, width, x, y }) => {
+    const { setClipRegion } = (0, react_1.useContext)(NativeLayers_js_1.NativeLayersContext);
+    (0, react_1.useEffect)(() => {
+        setClipRegion((c) => {
+            if (c === 'hide') {
+                throw new Error('Cannot render <Clipper>, because another <Null> is already rendered');
+            }
+            if (c === null) {
+                return { height, width, x, y };
+            }
+            throw new Error('Cannot render <Clipper>, because another component clipping the region was already rendered (most likely <Clipper>)');
+        });
+        return () => {
+            setClipRegion(null);
+        };
+    }, [height, setClipRegion, width, x, y]);
+    return null;
+};
+exports.Clipper = Clipper;

package/dist/{Composition.d.ts → cjs/Composition.d.ts}

@@ -1,4 +1,4 @@
-import type { ComponentType } from 'react';
+import type { ComponentType, PropsWithChildren } from 'react';
 import React from 'react';
 declare type LooseComponentType<T> = ComponentType<T> | ((props: T) => React.ReactNode);
 export declare type CompProps<T> = {
@@ -18,5 +18,10 @@ declare type CompositionProps<T> = StillProps<T> & {
     fps: number;
     durationInFrames: number;
 };
+/**
+ * @description This component is used to register a video to make it renderable and make it show in the sidebar, in dev mode.
+ * @see [Documentation](https://www.remotion.dev/docs/composition)
+ */
 export declare const Composition: <T>({ width, height, fps, durationInFrames, id, defaultProps, ...compProps }: CompositionProps<T>) => React.ReactPortal | null;
+export declare const ClipComposition: React.FC<PropsWithChildren>;
 export {};

package/dist/cjs/Composition.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClipComposition = exports.Composition = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const react_dom_1 = require("react-dom");
+const AbsoluteFill_js_1 = require("./AbsoluteFill.js");
+const CanUseRemotionHooks_js_1 = require("./CanUseRemotionHooks.js");
+const CompositionManager_js_1 = require("./CompositionManager.js");
+const input_props_js_1 = require("./config/input-props.js");
+const delay_render_js_1 = require("./delay-render.js");
+const Folder_js_1 = require("./Folder.js");
+const get_environment_js_1 = require("./get-environment.js");
+const internals_js_1 = require("./internals.js");
+const loading_indicator_js_1 = require("./loading-indicator.js");
+const NativeLayers_js_1 = require("./NativeLayers.js");
+const nonce_js_1 = require("./nonce.js");
+const portal_node_js_1 = require("./portal-node.js");
+const use_lazy_component_js_1 = require("./use-lazy-component.js");
+const use_video_js_1 = require("./use-video.js");
+const validate_composition_id_js_1 = require("./validation/validate-composition-id.js");
+const validate_dimensions_js_1 = require("./validation/validate-dimensions.js");
+const validate_duration_in_frames_js_1 = require("./validation/validate-duration-in-frames.js");
+const validate_fps_js_1 = require("./validation/validate-fps.js");
+const Fallback = () => {
+    (0, react_1.useEffect)(() => {
+        const fallback = (0, delay_render_js_1.delayRender)('Waiting for Root component to unsuspend');
+        return () => (0, delay_render_js_1.continueRender)(fallback);
+    }, []);
+    return null;
+};
+/**
+ * @description This component is used to register a video to make it renderable and make it show in the sidebar, in dev mode.
+ * @see [Documentation](https://www.remotion.dev/docs/composition)
+ */
+const Composition = ({ width, height, fps, durationInFrames, id, defaultProps, ...compProps }) => {
+    const { registerComposition, unregisterComposition } = (0, react_1.useContext)(CompositionManager_js_1.CompositionManager);
+    const video = (0, use_video_js_1.useVideo)();
+    const lazy = (0, use_lazy_component_js_1.useLazyComponent)(compProps);
+    const nonce = (0, nonce_js_1.useNonce)();
+    const environment = (0, get_environment_js_1.useRemotionEnvironment)();
+    const canUseComposition = (0, react_1.useContext)(internals_js_1.Internals.CanUseRemotionHooks);
+    if (canUseComposition) {
+        if (environment === 'player-development' ||
+            environment === 'player-production') {
+            throw new Error('<Composition> was mounted inside the `component` that was passed to the <Player>. See https://remotion.dev/docs/wrong-composition-mount for help.');
+        }
+        throw new Error('<Composition> mounted inside another composition. See https://remotion.dev/docs/wrong-composition-mount for help.');
+    }
+    const { folderName, parentName } = (0, react_1.useContext)(Folder_js_1.FolderContext);
+    (0, react_1.useEffect)(() => {
+        // Ensure it's a URL safe id
+        if (!id) {
+            throw new Error('No id for composition passed.');
+        }
+        (0, validate_composition_id_js_1.validateCompositionId)(id);
+        (0, validate_dimensions_js_1.validateDimension)(width, 'width', 'of the <Composition/> component');
+        (0, validate_dimensions_js_1.validateDimension)(height, 'height', 'of the <Composition/> component');
+        (0, validate_duration_in_frames_js_1.validateDurationInFrames)({
+            durationInFrames,
+            component: 'of the <Composition/> component',
+            allowFloats: false,
+        });
+        (0, validate_fps_js_1.validateFps)(fps, 'as a prop of the <Composition/> component', false);
+        registerComposition({
+            durationInFrames,
+            fps,
+            height,
+            width,
+            id,
+            folderName,
+            component: lazy,
+            defaultProps,
+            nonce,
+            parentFolderName: parentName,
+        });
+        return () => {
+            unregisterComposition(id);
+        };
+    }, [
+        durationInFrames,
+        fps,
+        height,
+        lazy,
+        id,
+        folderName,
+        defaultProps,
+        registerComposition,
+        unregisterComposition,
+        width,
+        nonce,
+        parentName,
+    ]);
+    if (environment === 'preview' && video && video.component === lazy) {
+        const Comp = lazy;
+        const inputProps = (0, input_props_js_1.getInputProps)();
+        return (0, react_dom_1.createPortal)((0, jsx_runtime_1.jsx)(exports.ClipComposition, { children: (0, jsx_runtime_1.jsx)(CanUseRemotionHooks_js_1.CanUseRemotionHooksProvider, { children: (0, jsx_runtime_1.jsx)(react_1.Suspense, { fallback: (0, jsx_runtime_1.jsx)(loading_indicator_js_1.Loading, {}), children: (0, jsx_runtime_1.jsx)(Comp, { ...defaultProps, ...inputProps }) }) }) }), (0, portal_node_js_1.portalNode)());
+    }
+    if (environment === 'rendering' && video && video.component === lazy) {
+        const Comp = lazy;
+        const inputProps = (0, input_props_js_1.getInputProps)();
+        return (0, react_dom_1.createPortal)((0, jsx_runtime_1.jsx)(CanUseRemotionHooks_js_1.CanUseRemotionHooksProvider, { children: (0, jsx_runtime_1.jsx)(react_1.Suspense, { fallback: (0, jsx_runtime_1.jsx)(Fallback, {}), children: (0, jsx_runtime_1.jsx)(Comp, { ...defaultProps, ...inputProps }) }) }), (0, portal_node_js_1.portalNode)());
+    }
+    return null;
+};
+exports.Composition = Composition;
+const ClipComposition = ({ children }) => {
+    const { clipRegion } = (0, react_1.useContext)(NativeLayers_js_1.NativeLayersContext);
+    const style = (0, react_1.useMemo)(() => {
+        return {
+            display: 'flex',
+            flexDirection: 'row',
+            opacity: clipRegion === 'hide' ? 0 : 1,
+            clipPath: clipRegion && clipRegion !== 'hide'
+                ? `polygon(${clipRegion.x}px ${clipRegion.y}px, ${clipRegion.x}px ${clipRegion.height + clipRegion.y}px, ${clipRegion.width + clipRegion.x}px ${clipRegion.height + clipRegion.y}px, ${clipRegion.width + clipRegion.x}px ${clipRegion.y}px)`
+                : undefined,
+        };
+    }, [clipRegion]);
+    return (0, jsx_runtime_1.jsx)(AbsoluteFill_js_1.AbsoluteFill, { style: style, children: children });
+};
+exports.ClipComposition = ClipComposition;

package/dist/{CompositionManager.d.ts → cjs/CompositionManager.d.ts}

@@ -1,6 +1,6 @@
 import type { ComponentType, LazyExoticComponent } from 'react';
 import React from 'react';
-import type { TFolder } from './Folder';
+import type { TFolder } from './Folder.js';
 export declare type TComposition<T = unknown> = {
     width: number;
     height: number;
@@ -23,12 +23,14 @@ declare type EnhancedTSequenceData = {
     volume: string | number;
     doesVolumeChange: boolean;
     startMediaFrom: number;
+    playbackRate: number;
 } | {
     type: 'video';
     src: string;
     volume: string | number;
     doesVolumeChange: boolean;
     startMediaFrom: number;
+    playbackRate: number;
 };
 export declare type TSequence = {
     from: number;
@@ -49,7 +51,9 @@ export declare type TAsset = {
     volume: number;
     mediaFrame: number;
     playbackRate: number;
+    allowAmplificationDuringRender: boolean;
 };
+declare type BaseMetadata = Pick<TCompMetadata, 'durationInFrames' | 'fps' | 'defaultProps' | 'height' | 'width'>;
 export declare type CompositionManagerContext = {
     compositions: TComposition[];
     registerComposition: <T>(comp: TComposition<T>) => void;
@@ -58,6 +62,8 @@ export declare type CompositionManagerContext = {
     unregisterFolder: (name: string, parent: string | null) => void;
     currentComposition: string | null;
     setCurrentComposition: (curr: string) => void;
+    setCurrentCompositionMetadata: (metadata: BaseMetadata) => void;
+    currentCompositionMetadata: BaseMetadata | null;
     registerSequence: (seq: TSequence) => void;
     unregisterSequence: (id: string) => void;
     registerAsset: (asset: TAsset) => void;
@@ -72,5 +78,6 @@ export declare const compositionsRef: React.RefObject<{
 }>;
 export declare const CompositionManagerProvider: React.FC<{
     children: React.ReactNode;
+    numberOfAudioTags: number;
 }>;
 export {};

package/dist/{CompositionManager.js → cjs/CompositionManager.js}

@@ -26,6 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CompositionManagerProvider = exports.compositionsRef = exports.CompositionManager = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = __importStar(require("react"));
+const shared_audio_tags_js_1 = require("./audio/shared-audio-tags.js");
 exports.CompositionManager = (0, react_1.createContext)({
     compositions: [],
     registerComposition: () => undefined,
@@ -34,6 +35,7 @@ exports.CompositionManager = (0, react_1.createContext)({
     unregisterFolder: () => undefined,
     currentComposition: null,
     setCurrentComposition: () => undefined,
+    setCurrentCompositionMetadata: () => undefined,
     registerSequence: () => undefined,
     unregisterSequence: () => undefined,
     registerAsset: () => undefined,
@@ -41,24 +43,37 @@ exports.CompositionManager = (0, react_1.createContext)({
     sequences: [],
     assets: [],
     folders: [],
+    currentCompositionMetadata: null,
 });
 exports.compositionsRef = react_1.default.createRef();
-const CompositionManagerProvider = ({ children }) => {
+const CompositionManagerProvider = ({ children, numberOfAudioTags }) => {
+    var _a;
     // Wontfix, expected to have
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const [compositions, setCompositions] = (0, react_1.useState)([]);
+    const currentcompositionsRef = (0, react_1.useRef)(compositions);
     const [currentComposition, setCurrentComposition] = (0, react_1.useState)(null);
     const [assets, setAssets] = (0, react_1.useState)([]);
     const [folders, setFolders] = (0, react_1.useState)([]);
     const [sequences, setSequences] = (0, react_1.useState)([]);
-    const registerComposition = (0, react_1.useCallback)((comp) => {
+    const [currentCompositionMetadata, setCurrentCompositionMetadata] = (0, react_1.useState)(null);
+    const updateCompositions = (0, react_1.useCallback)(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (updateComps) => {
         setCompositions((comps) => {
+            const updated = updateComps(comps);
+            currentcompositionsRef.current = updated;
+            return updated;
+        });
+    }, []);
+    const registerComposition = (0, react_1.useCallback)((comp) => {
+        updateCompositions((comps) => {
             if (comps.find((c) => c.id === comp.id)) {
                 throw new Error(`Multiple composition with id ${comp.id} are registered.`);
             }
             return [...comps, comp].slice().sort((a, b) => a.nonce - b.nonce);
         });
-    }, []);
+    }, [updateCompositions]);
     const registerSequence = (0, react_1.useCallback)((seq) => {
         setSequences((seqs) => {
             return [...seqs, seq];
@@ -108,9 +123,9 @@ const CompositionManagerProvider = ({ children }) => {
     }, [assets]);
     (0, react_1.useImperativeHandle)(exports.compositionsRef, () => {
         return {
-            getCompositions: () => compositions,
+            getCompositions: () => currentcompositionsRef.current,
         };
-    }, [compositions]);
+    }, []);
     const contextValue = (0, react_1.useMemo)(() => {
         return {
             compositions,
@@ -127,22 +142,26 @@ const CompositionManagerProvider = ({ children }) => {
             folders,
             registerFolder,
             unregisterFolder,
+            currentCompositionMetadata,
+            setCurrentCompositionMetadata,
         };
     }, [
         compositions,
-        currentComposition,
         registerComposition,
-        registerSequence,
         unregisterComposition,
+        currentComposition,
+        registerSequence,
         unregisterSequence,
         registerAsset,
         unregisterAsset,
         sequences,
         assets,
+        folders,
         registerFolder,
         unregisterFolder,
-        folders,
+        currentCompositionMetadata,
     ]);
-    return ((0, jsx_runtime_1.jsx)(exports.CompositionManager.Provider, { value: contextValue, children: children }));
+    const composition = (_a = compositions.find((c) => c.id === currentComposition)) === null || _a === void 0 ? void 0 : _a.component;
+    return ((0, jsx_runtime_1.jsx)(exports.CompositionManager.Provider, { value: contextValue, children: (0, jsx_runtime_1.jsx)(shared_audio_tags_js_1.SharedAudioContextProvider, { numberOfAudioTags: numberOfAudioTags, component: composition !== null && composition !== void 0 ? composition : null, children: children }) }));
 };
 exports.CompositionManagerProvider = CompositionManagerProvider;

package/dist/{Folder.d.ts → cjs/Folder.d.ts}

@@ -8,6 +8,10 @@ declare type FolderContextType = {
     parentName: string | null;
 };
 export declare const FolderContext: import("react").Context<FolderContextType>;
+/**
+ * @description By wrapping a <Composition /> inside a <Folder />, you can visually categorize it in your sidebar, should you have many compositions.
+ * @see [Documentation](https://www.remotion.dev/docs/folder)
+ */
 export declare const Folder: FC<{
     name: string;
     children: React.ReactNode;

package/dist/{Folder.js → cjs/Folder.js}

@@ -3,18 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Folder = exports.FolderContext = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = require("react");
-const CompositionManager_1 = require("./CompositionManager");
-const truthy_1 = require("./truthy");
-const validate_folder_name_1 = require("./validation/validate-folder-name");
+const CompositionManager_js_1 = require("./CompositionManager.js");
+const truthy_js_1 = require("./truthy.js");
+const validate_folder_name_js_1 = require("./validation/validate-folder-name.js");
 exports.FolderContext = (0, react_1.createContext)({
     folderName: null,
     parentName: null,
 });
+/**
+ * @description By wrapping a <Composition /> inside a <Folder />, you can visually categorize it in your sidebar, should you have many compositions.
+ * @see [Documentation](https://www.remotion.dev/docs/folder)
+ */
 const Folder = ({ name, children, }) => {
     const parent = (0, react_1.useContext)(exports.FolderContext);
-    const { registerFolder, unregisterFolder } = (0, react_1.useContext)(CompositionManager_1.CompositionManager);
-    (0, validate_folder_name_1.validateFolderName)(name);
-    const parentNameArr = [parent.parentName, parent.folderName].filter(truthy_1.truthy);
+    const { registerFolder, unregisterFolder } = (0, react_1.useContext)(CompositionManager_js_1.CompositionManager);
+    (0, validate_folder_name_js_1.validateFolderName)(name);
+    const parentNameArr = [parent.parentName, parent.folderName].filter(truthy_js_1.truthy);
     const parentName = parentNameArr.length === 0 ? null : parentNameArr.join('/');
     const value = (0, react_1.useMemo)(() => {
         return {

package/dist/{IFrame.d.ts → cjs/IFrame.d.ts}

@@ -1,2 +1,6 @@
 import React from 'react';
+/**
+ * @description The <IFrame /> can be used like a regular <iframe> HTML tag.
+ * @see [Documentation](https://www.remotion.dev/docs/iframe)
+ */
 export declare const IFrame: React.ForwardRefExoticComponent<Pick<React.DetailedHTMLProps<React.IframeHTMLAttributes<HTMLIFrameElement>, HTMLIFrameElement>, "key" | keyof React.IframeHTMLAttributes<HTMLIFrameElement>> & React.RefAttributes<HTMLIFrameElement>>;

package/dist/{IFrame.js → cjs/IFrame.js}

@@ -3,15 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.IFrame = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = require("react");
-const delay_render_1 = require("./delay-render");
+const delay_render_js_1 = require("./delay-render.js");
 const IFrameRefForwarding = ({ onLoad, onError, ...props }, ref) => {
-    const [handle] = (0, react_1.useState)(() => (0, delay_render_1.delayRender)(`Loading <IFrame> with source ${props.src}`));
+    const [handle] = (0, react_1.useState)(() => (0, delay_render_js_1.delayRender)(`Loading <IFrame> with source ${props.src}`));
     const didLoad = (0, react_1.useCallback)((e) => {
-        (0, delay_render_1.continueRender)(handle);
+        (0, delay_render_js_1.continueRender)(handle);
         onLoad === null || onLoad === void 0 ? void 0 : onLoad(e);
     }, [handle, onLoad]);
     const didGetError = (0, react_1.useCallback)((e) => {
-        (0, delay_render_1.continueRender)(handle);
+        (0, delay_render_js_1.continueRender)(handle);
         if (onError) {
             onError(e);
         }
@@ -21,4 +21,8 @@ const IFrameRefForwarding = ({ onLoad, onError, ...props }, ref) => {
     }, [handle, onError]);
     return (0, jsx_runtime_1.jsx)("iframe", { ...props, ref: ref, onError: didGetError, onLoad: didLoad });
 };
+/**
+ * @description The <IFrame /> can be used like a regular <iframe> HTML tag.
+ * @see [Documentation](https://www.remotion.dev/docs/iframe)
+ */
 exports.IFrame = (0, react_1.forwardRef)(IFrameRefForwarding);

package/dist/cjs/Img.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+/**
+ * @description Works just like a regular HTML img tag. When you use the <Img> tag, Remotion will ensure that the image is loaded before rendering the frame.
+ * @see [Documentation](https://www.remotion.dev/docs/img)
+ */
+export declare const Img: React.ForwardRefExoticComponent<Pick<React.ClassAttributes<HTMLImageElement> & React.ImgHTMLAttributes<HTMLImageElement> & {
+    maxRetries?: number | undefined;
+}, "key" | "maxRetries" | keyof React.ImgHTMLAttributes<HTMLImageElement>> & React.RefAttributes<HTMLImageElement>>;