remotion 4.0.244 → 4.0.245

package/LICENSE.md

@@ -11,7 +11,7 @@ Depending on the type of your legal entity, you are granted permission to use Re
 
 ## Free license
 
-Copyright © 2024 [Remotion](https://www.remotion.dev)
+Copyright © 2025 [Remotion](https://www.remotion.dev)
 
 ### Eligibility
 

package/dist/cjs/AbsoluteFill.d.ts

@@ -1,6 +1,2 @@
 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<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;

package/dist/cjs/AbsoluteFill.js

@@ -21,8 +21,8 @@ const AbsoluteFillRefForwarding = (props, ref) => {
     }, [style]);
     return (0, jsx_runtime_1.jsx)("div", { ref: ref, style: actualStyle, ...other });
 };
-/**
- * @description An absolutely positioned <div> element with 100% width, height, and a column flex style
- * @see [Documentation](https://www.remotion.dev/docs/absolute-fill)
+/*
+ * @description A helper component which renders an absolutely positioned <div> element with full width, height, and flex display suited for content layering.
+ * @see [Documentation](https://remotion.dev/docs/absolute-fill)
  */
 exports.AbsoluteFill = (0, react_1.forwardRef)(AbsoluteFillRefForwarding);

package/dist/cjs/Composition.d.ts

@@ -51,9 +51,5 @@ export type CompositionProps<Schema extends AnyZodObject, Props extends Record<s
     readonly id: string;
     readonly schema?: Schema;
 } & CompositionCalculateMetadataOrExplicit<Schema, Props> & CompProps<Props> & PropsIfHasProps<Schema, Props>;
-/**
- * @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: <Schema extends AnyZodObject, Props extends Record<string, unknown>>({ width, height, fps, durationInFrames, id, defaultProps, schema, ...compProps }: CompositionProps<Schema, Props>) => React.ReactPortal | null;
 export {};

package/dist/cjs/Composition.js

@@ -26,9 +26,9 @@ const 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)
+ * @see [Documentation](https://remotion.dev/docs/composition)
  */
 const Composition = ({ width, height, fps, durationInFrames, id, defaultProps, schema, ...compProps }) => {
     var _a, _b;

package/dist/cjs/Folder.d.ts

@@ -8,10 +8,6 @@ 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<{
     readonly name: string;
     readonly children: React.ReactNode;

package/dist/cjs/Folder.js

@@ -10,9 +10,9 @@ 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)
+ * @see [Documentation](https://remotion.dev/docs/folder)
  */
 const Folder = ({ name, children }) => {
     const parent = (0, react_1.useContext)(exports.FolderContext);

package/dist/cjs/IFrame.d.ts

@@ -1,8 +1,4 @@
 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<Omit<React.ClassAttributes<HTMLIFrameElement> & React.IframeHTMLAttributes<HTMLIFrameElement> & {
     readonly delayRenderRetries?: number;
     readonly delayRenderTimeoutInMilliseconds?: number;

package/dist/cjs/IFrame.js

@@ -25,8 +25,8 @@ const IFrameRefForwarding = ({ onLoad, onError, delayRenderRetries, delayRenderT
     }, [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)
+ * @see [Documentation](https://remotion.dev/docs/iframe)
  */
 exports.IFrame = (0, react_1.forwardRef)(IFrameRefForwarding);

package/dist/cjs/Img.d.ts

@@ -7,8 +7,4 @@ export type ImgProps = Omit<React.DetailedHTMLProps<React.ImgHTMLAttributes<HTML
     readonly onImageFrame?: (imgelement: HTMLImageElement) => void;
     readonly src: string;
 };
-/**
- * @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<Omit<ImgProps, "ref"> & React.RefAttributes<HTMLImageElement>>;

package/dist/cjs/Img.js

@@ -149,8 +149,8 @@ const ImgRefForwarding = ({ onError, maxRetries = 2, src, pauseWhenLoading, dela
     // src gets set once we've loaded and decoded the image.
     return (0, jsx_runtime_1.jsx)("img", { ...props, ref: imageRef, onError: didGetError });
 };
-/**
+/*
  * @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)
+ * @see [Documentation](https://remotion.dev/docs/img)
  */
 exports.Img = (0, react_1.forwardRef)(ImgRefForwarding);

package/dist/cjs/Sequence.d.ts

@@ -36,8 +36,4 @@ export type SequencePropsWithoutDuration = {
 export type SequenceProps = {
     readonly durationInFrames?: number;
 } & SequencePropsWithoutDuration;
-/**
- * @description A component that time-shifts its children and wraps them in an absolutely positioned <div>.
- * @see [Documentation](https://www.remotion.dev/docs/sequence)
- */
 export declare const Sequence: React.ForwardRefExoticComponent<SequenceProps & React.RefAttributes<HTMLDivElement>>;

package/dist/cjs/Sequence.js

@@ -173,7 +173,7 @@ const SequenceRefForwardingFunction = (props, ref) => {
     }
     return (0, jsx_runtime_1.jsx)(RegularSequence, { ...props, ref: ref });
 };
-/**
+/*
  * @description A component that time-shifts its children and wraps them in an absolutely positioned <div>.
  * @see [Documentation](https://www.remotion.dev/docs/sequence)
  */

package/dist/cjs/Still.d.ts

@@ -1,8 +1,4 @@
 import React from 'react';
 import type { AnyZodObject } from 'zod';
 import type { StillProps } from './Composition.js';
-/**
- * @description A `<Still />` is a `<Composition />` that is only 1 frame long.
- * @see [Documentation](https://www.remotion.dev/docs/still)
- */
 export declare const Still: <Schema extends AnyZodObject, Props extends Record<string, unknown>>(props: StillProps<Schema, Props>) => React.DetailedReactHTMLElement<React.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>;

package/dist/cjs/Still.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Still = void 0;
 const react_1 = __importDefault(require("react"));
 const Composition_js_1 = require("./Composition.js");
-/**
+/*
  * @description A `<Still />` is a `<Composition />` that is only 1 frame long.
  * @see [Documentation](https://www.remotion.dev/docs/still)
  */

package/dist/cjs/audio/Audio.d.ts

@@ -1,9 +1,5 @@
 import React from 'react';
 import type { RemotionMainAudioProps } from './props.js';
-/**
- * @description With this component, you can add audio to your video. All audio formats which are supported by Chromium are supported by the component.
- * @see [Documentation](https://www.remotion.dev/docs/audio)
- */
 export declare const Audio: React.ForwardRefExoticComponent<Omit<Omit<React.DetailedHTMLProps<React.AudioHTMLAttributes<HTMLAudioElement>, HTMLAudioElement>, "nonce" | "onEnded" | "onResize" | "onResizeCapture" | "autoPlay" | "controls"> & {
     name?: string;
     volume?: import("../volume-prop.js").VolumeProp;

package/dist/cjs/audio/Audio.js

@@ -75,9 +75,9 @@ const AudioRefForwardingFunction = (props, ref) => {
         // Proposal: Make this default to true in v5
         pauseWhenBuffering: pauseWhenBuffering !== null && pauseWhenBuffering !== void 0 ? pauseWhenBuffering : false, _remotionInternalNeedsDurationCalculation: Boolean(loop), showInTimeline: showInTimeline !== null && showInTimeline !== void 0 ? showInTimeline : true }));
 };
-/**
+/*
  * @description With this component, you can add audio to your video. All audio formats which are supported by Chromium are supported by the component.
- * @see [Documentation](https://www.remotion.dev/docs/audio)
+ * @see [Documentation](https://remotion.dev/docs/audio)
  */
 exports.Audio = (0, react_1.forwardRef)(AudioRefForwardingFunction);
 (0, enable_sequence_stack_traces_js_1.addSequenceStackTraces)(exports.Audio);

package/dist/cjs/cancel-render.d.ts

@@ -1,5 +1 @@
-/**
- * @description When you invoke this function, Remotion will stop rendering all the frames without any retries
- * @see [Documentation](https://www.remotion.dev/docs/cancel-render)
- */
 export declare function cancelRender(err: unknown): never;

package/dist/cjs/cancel-render.js

@@ -29,9 +29,9 @@ const isErrorLike = (err) => {
     }
     return true;
 };
-/**
- * @description When you invoke this function, Remotion will stop rendering all the frames without any retries
- * @see [Documentation](https://www.remotion.dev/docs/cancel-render)
+/*
+ * @description When you invoke this function, Remotion will stop rendering all the frames without any retries.
+ * @see [Documentation](https://remotion.dev/docs/cancel-render)
  */
 function cancelRender(err) {
     let error;

package/dist/cjs/delay-render.d.ts

@@ -5,16 +5,5 @@ export type DelayRenderOptions = {
     timeoutInMilliseconds?: number;
     retries?: number;
 };
-/**
- * @description Call this function to tell Remotion to wait before capturing this frame until data has loaded. Use continueRender() to unblock the render.
- * @param label _optional_ A label to identify the call in case it does time out.
- * @returns {number} An identifier to be passed to continueRender().
- * @see [Documentation](https://www.remotion.dev/docs/delay-render)
- */
 export declare const delayRender: (label?: string, options?: DelayRenderOptions) => number;
-/**
- * @description Unblock a render that has been blocked by delayRender()
- * @param handle The return value of delayRender().
- * @see [Documentation](https://www.remotion.dev/docs/continue-render)
- */
 export declare const continueRender: (handle: number) => void;

package/dist/cjs/delay-render.js

@@ -15,11 +15,9 @@ exports.DELAY_RENDER_CALLSTACK_TOKEN = 'The delayRender was called:';
 exports.DELAY_RENDER_RETRIES_LEFT = 'Retries left: ';
 exports.DELAY_RENDER_RETRY_TOKEN = '- Rendering the frame will be retried.';
 const defaultTimeout = 30000;
-/**
- * @description Call this function to tell Remotion to wait before capturing this frame until data has loaded. Use continueRender() to unblock the render.
- * @param label _optional_ A label to identify the call in case it does time out.
- * @returns {number} An identifier to be passed to continueRender().
- * @see [Documentation](https://www.remotion.dev/docs/delay-render)
+/*
+ * @description Call this function to signal that a frame should not be rendered until an asynchronous task (such as data fetching) is complete. Use continueRender(handle) to proceed with rendering once the task is complete.
+ * @see [Documentation](https://remotion.dev/docs/delay-render)
  */
 const delayRender = (label, options) => {
     var _a, _b, _c, _d, _e;
@@ -61,10 +59,9 @@ const delayRender = (label, options) => {
     return handle;
 };
 exports.delayRender = delayRender;
-/**
- * @description Unblock a render that has been blocked by delayRender()
- * @param handle The return value of delayRender().
- * @see [Documentation](https://www.remotion.dev/docs/continue-render)
+/*
+ * @description Unblock a render that has been blocked by delayRender().
+ * @see [Documentation](https://remotion.dev/docs/continue-render)
  */
 const continueRender = (handle) => {
     if (typeof handle === 'undefined') {

package/dist/cjs/freeze.d.ts

@@ -4,9 +4,5 @@ type FreezeProps = {
     readonly children: React.ReactNode;
     readonly active?: boolean | ((f: number) => boolean);
 };
-/**
- * @description This method freezes all of its children to the frame that you specify as a prop
- * @see [Documentation](https://www.remotion.dev/docs/freeze)
- */
 export declare const Freeze: React.FC<FreezeProps>;
 export {};

package/dist/cjs/freeze.js

@@ -7,9 +7,9 @@ const SequenceContext_js_1 = require("./SequenceContext.js");
 const timeline_position_state_js_1 = require("./timeline-position-state.js");
 const use_current_frame_js_1 = require("./use-current-frame.js");
 const use_video_config_js_1 = require("./use-video-config.js");
-/**
- * @description This method freezes all of its children to the frame that you specify as a prop
- * @see [Documentation](https://www.remotion.dev/docs/freeze)
+/*
+ * @description Freezes its children at the specified frame when rendering videos.
+ * @see [Documentation](https://remotion.dev/docs/freeze)
  */
 const Freeze = ({ frame: frameToFreeze, children, active = true, }) => {
     var _a;

package/dist/cjs/get-remotion-environment.d.ts

@@ -4,8 +4,4 @@ export type RemotionEnvironment = {
     isPlayer: boolean;
     isReadOnlyStudio: boolean;
 };
-/**
- * @description Provides information about the Remotion Environment
- * @see [Documentation](https://www.remotion.dev/docs/get-remotion-environment)
- */
 export declare const getRemotionEnvironment: () => RemotionEnvironment;

package/dist/cjs/get-remotion-environment.js

@@ -8,9 +8,9 @@ function getNodeEnvString() {
 const getEnvString = () => {
     return ['e', 'nv'].join('');
 };
-/**
+/*
  * @description Provides information about the Remotion Environment
- * @see [Documentation](https://www.remotion.dev/docs/get-remotion-environment)
+ * @see [Documentation](https://remotion.dev/docs/get-remotion-environment)
  */
 const getRemotionEnvironment = () => {
     const isPlayer = typeof window !== 'undefined' && window.remotion_isPlayer;

package/dist/cjs/get-static-files.d.ts

@@ -1,7 +1,3 @@
-/**
- * @description The function array containing all files in the public/ folder. You can reference them by using staticFile().
- * @see [Documentation](https://www.remotion.dev/docs/getstaticfiles)
- */
 export declare const getStaticFiles: () => StaticFile[];
 export type StaticFile = {
     /**

package/dist/cjs/get-static-files.js

@@ -20,9 +20,9 @@ const warnPlayerOnce = () => {
     // eslint-disable-next-line no-console
     console.warn('Called getStaticFiles() while using the Remotion Player. The API is only available while using the Remotion Studio. An empty array was returned.');
 };
-/**
- * @description The function array containing all files in the public/ folder. You can reference them by using staticFile().
- * @see [Documentation](https://www.remotion.dev/docs/getstaticfiles)
+/*
+ * @description Gets an array containing all files in the `public/` folder. You can reference them by using `staticFile()`.
+ * @see [Documentation](https://remotion.dev/docs/getstaticfiles)
  */
 const getStaticFiles = () => {
     if (v5_flag_1.ENABLE_V5_BREAKING_CHANGES) {

package/dist/cjs/interpolate-colors.d.ts

@@ -6,8 +6,4 @@ export declare const colorNames: {
     [key: string]: number;
 };
 export declare function processColor(color: string): number;
-/**
- * @description This function allows you to map a range of values to colors using a concise syntax.
- * @see [Documentation](https://www.remotion.dev/docs/interpolate-colors)
- */
 export declare const interpolateColors: (input: number, inputRange: readonly number[], outputRange: readonly string[]) => string;

package/dist/cjs/interpolate-colors.js

@@ -270,10 +270,11 @@ function normalizeColor(color) {
         if ((match = matchers.rgb.exec(color))) {
             return (
             // b
+            // a
             ((parse255(match[1]) << 24) | // r
                 (parse255(match[2]) << 16) | // g
                 (parse255(match[3]) << 8) |
-                0x000000ff) >>> // a
+                0x000000ff) >>>
                 0);
         }
     }
@@ -281,10 +282,11 @@ function normalizeColor(color) {
         if ((match = matchers.rgba.exec(color))) {
             return (
             // b
+            // a
             ((parse255(match[1]) << 24) | // r
                 (parse255(match[2]) << 16) | // g
                 (parse255(match[3]) << 8) |
-                parse1(match[4])) >>> // a
+                parse1(match[4])) >>>
                 0);
         }
     }
@@ -371,9 +373,9 @@ const interpolateColorsRGB = (value, inputRange, colors) => {
     });
     return rgbaColor(r, g, b, a);
 };
-/**
- * @description This function allows you to map a range of values to colors using a concise syntax.
- * @see [Documentation](https://www.remotion.dev/docs/interpolate-colors)
+/*
+ * @description Allows you to map a range of values to colors using a concise syntax.
+ * @see [Documentation](https://remotion.dev/docs/interpolate-colors)
  */
 const interpolateColors = (input, inputRange, outputRange) => {
     if (typeof input === 'undefined') {

package/dist/cjs/interpolate.d.ts

@@ -9,15 +9,4 @@ export type InterpolateOptions = Partial<{
     extrapolateLeft: ExtrapolateType;
     extrapolateRight: ExtrapolateType;
 }>;
-/**
- * Map a value from an input range to an output range.
- * @link https://www.remotion.dev/docs/interpolate
- * @param {!number} input value to interpolate
- * @param {!number[]} inputRange range of values that you expect the input to assume.
- * @param {!number[]} outputRange range of output values that you want the input to map to.
- * @param {?object} options
- * @param {?Function} options.easing easing function which allows you to customize the input, for example to apply a certain easing function. By default, the input is left unmodified, resulting in a pure linear interpolation {@link https://www.remotion.dev/docs/easing}
- * @param {string=} [options.extrapolateLeft="extend"] What should happen if the input value is outside left the input range, default: "extend" {@link https://www.remotion.dev/docs/interpolate#extrapolateleft}
- * @param {string=} [options.extrapolateRight="extend"] Same as extrapolateLeft, except for values outside right the input range {@link https://www.remotion.dev/docs/interpolate#extrapolateright}
- */
 export declare function interpolate(input: number, inputRange: readonly number[], outputRange: readonly number[], options?: InterpolateOptions): number;

package/dist/cjs/interpolate.js

@@ -77,16 +77,9 @@ function checkInfiniteRange(name, arr) {
         }
     }
 }
-/**
- * Map a value from an input range to an output range.
- * @link https://www.remotion.dev/docs/interpolate
- * @param {!number} input value to interpolate
- * @param {!number[]} inputRange range of values that you expect the input to assume.
- * @param {!number[]} outputRange range of output values that you want the input to map to.
- * @param {?object} options
- * @param {?Function} options.easing easing function which allows you to customize the input, for example to apply a certain easing function. By default, the input is left unmodified, resulting in a pure linear interpolation {@link https://www.remotion.dev/docs/easing}
- * @param {string=} [options.extrapolateLeft="extend"] What should happen if the input value is outside left the input range, default: "extend" {@link https://www.remotion.dev/docs/interpolate#extrapolateleft}
- * @param {string=} [options.extrapolateRight="extend"] Same as extrapolateLeft, except for values outside right the input range {@link https://www.remotion.dev/docs/interpolate#extrapolateright}
+/*
+ * @description Allows you to map a range of values to another using a concise syntax.
+ * @see [Documentation](https://remotion.dev/docs/interpolate)
  */
 function interpolate(input, inputRange, outputRange, options) {
     var _a;

package/dist/cjs/loop/index.d.ts

@@ -11,10 +11,6 @@ type LoopContextType = {
     durationInFrames: number;
 };
 declare const useLoop: () => LoopContextType | null;
-/**
- * @description This component allows you to quickly lay out an animation so it repeats itself.
- * @see [Documentation](https://www.remotion.dev/docs/loop)
- */
 export declare const Loop: React.FC<LoopProps> & {
     useLoop: typeof useLoop;
 };

package/dist/cjs/loop/index.js

@@ -34,9 +34,9 @@ const LoopContext = (0, react_1.createContext)(null);
 const useLoop = () => {
     return react_1.default.useContext(LoopContext);
 };
-/**
+/*
  * @description This component allows you to quickly lay out an animation so it repeats itself.
- * @see [Documentation](https://www.remotion.dev/docs/loop)
+ * @see [Documentation](https://remotion.dev/docs/loop)
  */
 const Loop = ({ durationInFrames, times = Infinity, children, name, ...props }) => {
     const currentFrame = (0, use_current_frame_js_1.useCurrentFrame)();

package/dist/cjs/prefetch.d.ts

@@ -7,10 +7,6 @@ export type PrefetchOnProgress = (options: {
     totalBytes: number | null;
     loadedBytes: number;
 }) => void;
-/**
- * @description When you call the preFetch() function, an asset will be fetched and kept in memory so it is ready when you want to play it in a <Player>.
- * @see [Documentation](https://www.remotion.dev/docs/prefetch)
- */
 export declare const prefetch: (src: string, options?: {
     method?: "blob-url" | "base64";
     contentType?: string;

package/dist/cjs/prefetch.js

@@ -47,8 +47,8 @@ const getBlobFromReader = async ({ reader, contentType, contentLength, onProgres
         type: contentType !== null && contentType !== void 0 ? contentType : undefined,
     });
 };
-/**
- * @description When you call the preFetch() function, an asset will be fetched and kept in memory so it is ready when you want to play it in a <Player>.
+/*
+ * @description When you call the prefetch() function, an asset will be fetched and kept in memory so it is ready when you want to play it in a <Player>.
  * @see [Documentation](https://www.remotion.dev/docs/prefetch)
  */
 const prefetch = (src, options) => {

package/dist/cjs/random.d.ts

@@ -1,6 +1,2 @@
 export type RandomSeed = number | string | null;
-/**
- * @description A deterministic pseudo-random number generator. Pass in the same seed and get the same pseudorandom number.
- * @see [Documentation](https://remotion.dev/docs/random)
- */
 export declare const random: (seed: RandomSeed, dummy?: unknown) => number;

package/dist/cjs/random.js

@@ -18,9 +18,9 @@ function hashCode(str) {
     }
     return hash;
 }
-/**
+/*
  * @description A deterministic pseudo-random number generator. Pass in the same seed and get the same pseudorandom number.
- * @see [Documentation](https://remotion.dev/docs/random)
+ * @see [Documentation](https://www.remotion.dev/docs/random)
  */
 const random = (seed, dummy) => {
     if (dummy !== undefined) {

package/dist/cjs/register-root.d.ts

@@ -1,8 +1,4 @@
 import type React from 'react';
-/**
- * @description This function registers the root component of the Remotion project
- * @see [Documentation](https://www.remotion.dev/docs/register-root)
- */
 export declare const registerRoot: (comp: React.FC) => void;
 export declare const getRoot: () => React.FC<{}> | null;
 export declare const waitForRoot: (fn: (comp: React.FC) => void) => (() => void);

package/dist/cjs/register-root.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.waitForRoot = exports.getRoot = exports.registerRoot = void 0;
 let Root = null;
 let listeners = [];
-/**
- * @description This function registers the root component of the Remotion project
+/*
+ * @description Registers the root component of the Remotion project.
  * @see [Documentation](https://www.remotion.dev/docs/register-root)
  */
 const registerRoot = (comp) => {

package/dist/cjs/spring/index.d.ts

@@ -1,21 +1,4 @@
 import type { SpringConfig } from './spring-utils';
-/**
- * @description Calculates a position based on physical parameters, start and end value, and time.
- * @see [Documentation](https://www.remotion.dev/docs/spring)
- * @param {number} frame The current time value. Most of the time you want to pass in the return value of useCurrentFrame.
- * @param {number} fps The framerate at which the animation runs. Pass in the value obtained by `useVideoConfig()`.
- * @param {?boolean} reverse Whether the animation plays in reverse or not. Default `false`.
- * @param {?Object} config optional object that allows you to customize the physical properties of the animation.
- * @param {number} [config.mass=1] The weight of the spring. If you reduce the mass, the animation becomes faster!
- * @param {number} [config.damping=10] How hard the animation decelerates.
- * @param {number} [config.stiffness=100] Affects bounciness of the animation.
- * @param {boolean} [config.overshootClamping=false] Whether to prevent the animation going beyond the target value.
- * @param {?number} [config.from] The initial value of the animation. Default `0`
- * @param {?number} [config.to] The end value of the animation. Default `1`
- * @param {?number} [config.durationInFrames] Stretch the duration of an animation to  a set value.. Default `undefined`
- * @param {?number} [config.durationThreshold] How close to the end the animation is considered to be done. Default `0.005`
- * @param {?number} [config.delay] Delay the animation for this amount of frames. Default `0`
- */
 export declare function spring({ frame: passedFrame, fps, config, from, to, durationInFrames: passedDurationInFrames, durationRestThreshold, delay, reverse, }: {
     frame: number;
     fps: number;

package/dist/cjs/spring/index.js

@@ -8,22 +8,9 @@ const validate_fps_js_1 = require("../validation/validate-fps.js");
 const validation_spring_duration_js_1 = require("../validation/validation-spring-duration.js");
 const measure_spring_js_1 = require("./measure-spring.js");
 const spring_utils_js_1 = require("./spring-utils.js");
-/**
+/*
  * @description Calculates a position based on physical parameters, start and end value, and time.
  * @see [Documentation](https://www.remotion.dev/docs/spring)
- * @param {number} frame The current time value. Most of the time you want to pass in the return value of useCurrentFrame.
- * @param {number} fps The framerate at which the animation runs. Pass in the value obtained by `useVideoConfig()`.
- * @param {?boolean} reverse Whether the animation plays in reverse or not. Default `false`.
- * @param {?Object} config optional object that allows you to customize the physical properties of the animation.
- * @param {number} [config.mass=1] The weight of the spring. If you reduce the mass, the animation becomes faster!
- * @param {number} [config.damping=10] How hard the animation decelerates.
- * @param {number} [config.stiffness=100] Affects bounciness of the animation.
- * @param {boolean} [config.overshootClamping=false] Whether to prevent the animation going beyond the target value.
- * @param {?number} [config.from] The initial value of the animation. Default `0`
- * @param {?number} [config.to] The end value of the animation. Default `1`
- * @param {?number} [config.durationInFrames] Stretch the duration of an animation to  a set value.. Default `undefined`
- * @param {?number} [config.durationThreshold] How close to the end the animation is considered to be done. Default `0.005`
- * @param {?number} [config.delay] Delay the animation for this amount of frames. Default `0`
  */
 function spring({ frame: passedFrame, fps, config = {}, from = 0, to = 1, durationInFrames: passedDurationInFrames, durationRestThreshold, delay = 0, reverse = false, }) {
     (0, validation_spring_duration_js_1.validateSpringDuration)(passedDurationInFrames);

package/dist/cjs/spring/measure-spring.d.ts

@@ -9,9 +9,5 @@ type MeasureSpringProps = {
     config?: Partial<SpringConfig>;
     threshold?: number;
 } & (false extends typeof ENABLE_V5_BREAKING_CHANGES ? V4Props : {});
-/**
- * @description The function returns how long it takes for a spring animation to settle
- * @see [Documentation](https://www.remotion.dev/docs/measure-spring)
- */
 export declare function measureSpring({ fps, config, threshold, }: MeasureSpringProps): number;
 export {};

package/dist/cjs/spring/measure-spring.js

@@ -4,9 +4,9 @@ exports.measureSpring = measureSpring;
 const validate_fps_js_1 = require("../validation/validate-fps.js");
 const spring_utils_js_1 = require("./spring-utils.js");
 const cache = new Map();
-/**
- * @description The function returns how long it takes for a spring animation to settle
- * @see [Documentation](https://www.remotion.dev/docs/measure-spring)
+/*
+ * @description Based on a spring() configuration and the frame rate, return how long it takes for a spring animation to settle.
+ * @see [Documentation](https://remotion.dev/docs/measure-spring)
  */
 function measureSpring({ fps, config = {}, threshold = 0.005, }) {
     if (typeof threshold !== 'number') {

package/dist/cjs/static-file.d.ts

@@ -25,9 +25,5 @@ export type HexInfo = {
     hexCode: HexCode;
 };
 export declare const includesHexOfUnsafeChar: (path: string) => HexInfo;
-/**
- * @description Reference a file from the public/ folder. If the file does not appear in the autocomplete, type the path manually.
- * @see [Documentation](https://www.remotion.dev/docs/staticfile)
- */
 export declare const staticFile: (path: string) => string;
 export {};

package/dist/cjs/static-file.js

@@ -61,7 +61,7 @@ const encodeBySplitting = (path) => {
     const merged = encodedArray.join('/');
     return merged;
 };
-/**
+/*
  * @description Reference a file from the public/ folder. If the file does not appear in the autocomplete, type the path manually.
  * @see [Documentation](https://www.remotion.dev/docs/staticfile)
  */

package/dist/cjs/use-current-frame.d.ts

@@ -1,5 +1 @@
-/**
- * @description Get the current frame of the video. Frames are 0-indexed, meaning the first frame is 0, the last frame is the duration of the composition in frames minus one.
- * @see [Documentation](https://remotion.dev/docs/use-current-frame)
- */
 export declare const useCurrentFrame: () => number;

package/dist/cjs/use-current-frame.js

@@ -6,9 +6,9 @@ const CanUseRemotionHooks_js_1 = require("./CanUseRemotionHooks.js");
 const SequenceContext_js_1 = require("./SequenceContext.js");
 const get_remotion_environment_js_1 = require("./get-remotion-environment.js");
 const timeline_position_state_js_1 = require("./timeline-position-state.js");
-/**
- * @description Get the current frame of the video. Frames are 0-indexed, meaning the first frame is 0, the last frame is the duration of the composition in frames minus one.
- * @see [Documentation](https://remotion.dev/docs/use-current-frame)
+/*
+ * @description Retrieves the current frame of the video within a component. Frames are 0-indexed, and if the component is wrapped in a `<Sequence>`, it returns the frame relative to when the Sequence starts.
+ * @see [Documentation](https://www.remotion.dev/docs/use-current-frame)
  */
 const useCurrentFrame = () => {
     const canUseRemotionHooks = (0, react_1.useContext)(CanUseRemotionHooks_js_1.CanUseRemotionHooks);

package/dist/cjs/use-current-scale.d.ts

@@ -43,9 +43,5 @@ export declare const calculateScale: ({ canvasSize, compositionHeight, compositi
         height: number;
     };
 }) => number;
-/**
- * Gets the current scale of the container in which the component is being rendered.
- * Only works in the Remotion Studio and in the Remotion Player.
- */
 export declare const useCurrentScale: (options?: Options) => number;
 export {};

package/dist/cjs/use-current-scale.js

@@ -39,9 +39,9 @@ const calculateScale = ({ canvasSize, compositionHeight, compositionWidth, previ
     return previewSize === 'auto' ? ratio : Number(previewSize);
 };
 exports.calculateScale = calculateScale;
-/**
- * Gets the current scale of the container in which the component is being rendered.
- * Only works in the Remotion Studio and in the Remotion Player.
+/*
+ * @description Retrieves the current scale of the canvas within Remotion's Studio or Player context. In the Studio, it corresponds to the zoom level (1 equals no scaling, i.e., 100% zoom). In the Player, it indicates the scaling necessary to fit the video into the player. If called outside of a Remotion context, by default, it throws an error unless configured not to.
+ * @see [Documentation](https://www.remotion.dev/docs/use-current-scale)
  */
 const useCurrentScale = (options) => {
     const hasContext = react_1.default.useContext(exports.CurrentScaleContext);

package/dist/cjs/use-video-config.d.ts

@@ -1,7 +1,2 @@
 import type { VideoConfig } from './video-config.js';
-/**
- * @description Get some info about the context of the video that you are making.
- * @see [Documentation](https://www.remotion.dev/docs/use-video-config)
- * @returns Returns an object containing `fps`, `width`, `height`, `durationInFrames`, `id` and `defaultProps`.
- */
 export declare const useVideoConfig: () => VideoConfig;

package/dist/cjs/use-video-config.js

@@ -5,10 +5,9 @@ const react_1 = require("react");
 const CanUseRemotionHooks_js_1 = require("./CanUseRemotionHooks.js");
 const is_player_js_1 = require("./is-player.js");
 const use_unsafe_video_config_js_1 = require("./use-unsafe-video-config.js");
-/**
- * @description Get some info about the context of the video that you are making.
+/*
+ * @description Retrieves information about the composition context in which it is used, including dimensions, frame rate, duration, and more.
  * @see [Documentation](https://www.remotion.dev/docs/use-video-config)
- * @returns Returns an object containing `fps`, `width`, `height`, `durationInFrames`, `id` and `defaultProps`.
  */
 const useVideoConfig = () => {
     const videoConfig = (0, use_unsafe_video_config_js_1.useUnsafeVideoConfig)();

package/dist/cjs/version.d.ts

@@ -3,4 +3,4 @@
  * @see [Documentation](https://remotion.dev/docs/version)
  * @returns {string} The current version of the remotion package
  */
-export declare const VERSION = "4.0.244";
+export declare const VERSION = "4.0.245";

package/dist/cjs/version.js

@@ -7,4 +7,4 @@ exports.VERSION = void 0;
  * @see [Documentation](https://remotion.dev/docs/version)
  * @returns {string} The current version of the remotion package
  */
-exports.VERSION = '4.0.244';
+exports.VERSION = '4.0.245';

package/dist/cjs/video/OffthreadVideo.d.ts

@@ -1,7 +1,3 @@
 import React from 'react';
 import type { OffthreadVideoProps } from './props.js';
-/**
- * @description This method imports and displays a video, similar to <Video />. During rendering, it extracts the exact frame from the video and displays it in an <img> tag
- * @see [Documentation](https://www.remotion.dev/docs/offthreadvideo)
- */
 export declare const OffthreadVideo: React.FC<OffthreadVideoProps>;

package/dist/cjs/video/OffthreadVideo.js

@@ -9,7 +9,7 @@ const validate_media_props_js_1 = require("../validate-media-props.js");
 const validate_start_from_props_js_1 = require("../validate-start-from-props.js");
 const OffthreadVideoForRendering_js_1 = require("./OffthreadVideoForRendering.js");
 const VideoForPreview_js_1 = require("./VideoForPreview.js");
-/**
+/*
  * @description This method imports and displays a video, similar to <Video />. During rendering, it extracts the exact frame from the video and displays it in an <img> tag
  * @see [Documentation](https://www.remotion.dev/docs/offthreadvideo)
  */

package/dist/cjs/video/Video.d.ts

@@ -1,9 +1,5 @@
 import React from 'react';
 import type { RemotionMainVideoProps } from './props';
-/**
- * @description allows you to include a video file in your Remotion project. It wraps the native HTMLVideoElement.
- * @see [Documentation](https://www.remotion.dev/docs/video)
- */
 export declare const Video: React.ForwardRefExoticComponent<Omit<Omit<React.DetailedHTMLProps<React.VideoHTMLAttributes<HTMLVideoElement>, HTMLVideoElement>, "nonce" | "onError" | "onEnded" | "autoPlay" | "controls" | "disableRemotePlayback"> & {
     name?: string;
     volume?: import("../volume-prop.js").VolumeProp;

package/dist/cjs/video/Video.js

@@ -62,8 +62,8 @@ const VideoForwardingFunction = (props, ref) => {
         // Proposal: Make this default to true in v5
         pauseWhenBuffering: pauseWhenBuffering !== null && pauseWhenBuffering !== void 0 ? pauseWhenBuffering : false, onDuration: onDuration, _remotionInternalStack: stack !== null && stack !== void 0 ? stack : null, _remotionInternalNativeLoopPassed: _remotionInternalNativeLoopPassed !== null && _remotionInternalNativeLoopPassed !== void 0 ? _remotionInternalNativeLoopPassed : false, _remotionDebugSeeking: _remotionDebugSeeking !== null && _remotionDebugSeeking !== void 0 ? _remotionDebugSeeking : false, showInTimeline: showInTimeline !== null && showInTimeline !== void 0 ? showInTimeline : true, onAutoPlayError: onAutoPlayError !== null && onAutoPlayError !== void 0 ? onAutoPlayError : undefined }));
 };
-/**
- * @description allows you to include a video file in your Remotion project. It wraps the native HTMLVideoElement.
+/*
+ * @description Wraps the native `<video>` element to include video in your component that is synchronized with Remotion's time.
  * @see [Documentation](https://www.remotion.dev/docs/video)
  */
 exports.Video = (0, react_1.forwardRef)(VideoForwardingFunction);

package/dist/cjs/watch-static-file.d.ts

@@ -4,13 +4,6 @@ export declare const WATCH_REMOTION_STATIC_FILES = "remotion_staticFilesChanged"
 export type WatchRemotionStaticFilesPayload = {
     files: StaticFile[];
 };
-/**
- * @description Watch for changes in a specific static file.
- * @param {string} fileName - The name of the static file to watch for changes.
- * @param {WatcherCallback} callback - A callback function to be called when the file changes.
- * @returns {{cancel: () => void}} A function that can be used to cancel the event listener.
- * @see [Documentation](https://www.remotion.dev/docs/watchstaticfile)
- */
 export declare const watchStaticFile: (fileName: string, callback: WatcherCallback) => {
     cancel: () => void;
 };

package/dist/cjs/watch-static-file.js

@@ -4,11 +4,8 @@ exports.watchStaticFile = exports.WATCH_REMOTION_STATIC_FILES = void 0;
 const get_remotion_environment_1 = require("./get-remotion-environment");
 const v5_flag_1 = require("./v5-flag");
 exports.WATCH_REMOTION_STATIC_FILES = 'remotion_staticFilesChanged';
-/**
- * @description Watch for changes in a specific static file.
- * @param {string} fileName - The name of the static file to watch for changes.
- * @param {WatcherCallback} callback - A callback function to be called when the file changes.
- * @returns {{cancel: () => void}} A function that can be used to cancel the event listener.
+/*
+ * @description Watches for changes in a specific static file and invokes a callback function when the file changes, enabling dynamic updates in your Remotion projects.
  * @see [Documentation](https://www.remotion.dev/docs/watchstaticfile)
  */
 const watchStaticFile = (fileName, callback) => {

package/dist/esm/index.mjs

@@ -104,7 +104,7 @@ function truthy(value) {
 }
 
 // src/version.ts
-var VERSION = "4.0.244";
+var VERSION = "4.0.245";
 
 // src/multiple-versions-warning.ts
 var checkMultipleRemotionVersions = () => {

package/dist/esm/version.mjs

@@ -1,5 +1,5 @@
 // src/version.ts
-var VERSION = "4.0.244";
+var VERSION = "4.0.245";
 export {
   VERSION
 };

package/package.json

@@ -3,7 +3,7 @@
     "url": "https://github.com/remotion-dev/remotion/tree/main/packages/core"
   },
   "name": "remotion",
-  "version": "4.0.244",
+  "version": "4.0.245",
   "description": "Make videos programmatically",
   "main": "dist/cjs/index.js",
   "types": "dist/cjs/index.d.ts",
@@ -29,7 +29,7 @@
     "webpack": "5.96.1",
     "zod": "3.22.3",
     "eslint": "9.14.0",
-    "@remotion/eslint-config-internal": "4.0.244"
+    "@remotion/eslint-config-internal": "4.0.245"
   },
   "keywords": [
     "remotion",