remotion 3.3.54 → 3.3.55

package/dist/cjs/AbsoluteFill.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 /**
- * An absolutely positioned <div> element with 100% width, height, and a column flex style
- * @link https://www.remotion.dev/docs/absolute-fill
+ * @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/cjs/AbsoluteFill.js

@@ -22,7 +22,7 @@ const AbsoluteFillRefForwarding = (props, ref) => {
     return (0, jsx_runtime_1.jsx)("div", { ref: ref, style: actualStyle, ...other });
 };
 /**
- * An absolutely positioned <div> element with 100% width, height, and a column flex style
- * @link https://www.remotion.dev/docs/absolute-fill
+ * @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/Composition.d.ts

@@ -18,6 +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

@@ -29,6 +29,10 @@ 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)
+ */
 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)();

package/dist/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/cjs/Folder.js

@@ -10,6 +10,10 @@ 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_js_1.CompositionManager);

package/dist/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/cjs/IFrame.js

@@ -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

@@ -1,2 +1,6 @@
 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.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, "key" | keyof React.ImgHTMLAttributes<HTMLImageElement>> & React.RefAttributes<HTMLImageElement>>;

package/dist/cjs/Img.js

@@ -49,4 +49,8 @@ const ImgRefForwarding = ({ onError, src, ...props }, ref) => {
     }
     return ((0, jsx_runtime_1.jsx)("img", { ...props, ref: imageRef, src: actualSrc, 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)
+ */
 exports.Img = (0, react_1.forwardRef)(ImgRefForwarding);

package/dist/cjs/Sequence.d.ts

@@ -1,12 +1,4 @@
 import React from 'react';
-export declare type SequenceContextType = {
-    cumulatedFrom: number;
-    relativeFrom: number;
-    parentFrom: number;
-    durationInFrames: number;
-    id: string;
-};
-export declare const SequenceContext: React.Context<SequenceContextType | null>;
 export declare type LayoutAndStyle = {
     layout: 'none';
 } | {
@@ -23,7 +15,7 @@ export declare type SequenceProps = {
     showLoopTimesInTimeline?: number;
 } & LayoutAndStyle;
 /**
- * A component that time-shifts its children and wraps them in an absolutely positioned <div>.
- * @link https://www.remotion.dev/docs/sequence
+ * @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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Sequence = exports.SequenceContext = void 0;
+exports.Sequence = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = require("react");
 const AbsoluteFill_js_1 = require("./AbsoluteFill.js");
@@ -8,13 +8,13 @@ const CompositionManager_js_1 = require("./CompositionManager.js");
 const get_environment_js_1 = require("./get-environment.js");
 const get_timeline_clip_name_js_1 = require("./get-timeline-clip-name.js");
 const nonce_js_1 = require("./nonce.js");
+const SequenceContext_js_1 = require("./SequenceContext.js");
 const timeline_position_state_js_1 = require("./timeline-position-state.js");
 const use_video_config_js_1 = require("./use-video-config.js");
-exports.SequenceContext = (0, react_1.createContext)(null);
 const SequenceRefForwardingFunction = ({ from = 0, durationInFrames = Infinity, children, name, showInTimeline = true, showLoopTimesInTimeline, ...other }, ref) => {
     const { layout = 'absolute-fill' } = other;
     const [id] = (0, react_1.useState)(() => String(Math.random()));
-    const parentSequence = (0, react_1.useContext)(exports.SequenceContext);
+    const parentSequence = (0, react_1.useContext)(SequenceContext_js_1.SequenceContext);
     const { rootId } = (0, react_1.useContext)(timeline_position_state_js_1.TimelineContext);
     const cumulatedFrom = parentSequence
         ? parentSequence.cumulatedFrom + parentSequence.relativeFrom
@@ -122,10 +122,10 @@ const SequenceRefForwardingFunction = ({ from = 0, durationInFrames = Infinity,
     if (ref !== null && layout === 'none') {
         throw new TypeError('It is not supported to pass both a `ref` and `layout="none"` to <Sequence />.');
     }
-    return ((0, jsx_runtime_1.jsx)(exports.SequenceContext.Provider, { value: contextValue, children: content === null ? null : other.layout === 'none' ? (content) : ((0, jsx_runtime_1.jsx)(AbsoluteFill_js_1.AbsoluteFill, { ref: ref, style: defaultStyle, className: other.className, children: content })) }));
+    return ((0, jsx_runtime_1.jsx)(SequenceContext_js_1.SequenceContext.Provider, { value: contextValue, children: content === null ? null : other.layout === 'none' ? (content) : ((0, jsx_runtime_1.jsx)(AbsoluteFill_js_1.AbsoluteFill, { ref: ref, style: defaultStyle, className: other.className, children: content })) }));
 };
 /**
- * A component that time-shifts its children and wraps them in an absolutely positioned <div>.
- * @link https://www.remotion.dev/docs/sequence
+ * @description A component that time-shifts its children and wraps them in an absolutely positioned <div>.
+ * @see [Documentation](https://www.remotion.dev/docs/sequence]
  */
 exports.Sequence = (0, react_1.forwardRef)(SequenceRefForwardingFunction);

package/dist/cjs/SequenceContext.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+export declare const SequenceContext: import("react").Context<SequenceContextType | null>;
+export declare type SequenceContextType = {
+    cumulatedFrom: number;
+    relativeFrom: number;
+    parentFrom: number;
+    durationInFrames: number;
+    id: string;
+};

package/dist/cjs/SequenceContext.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SequenceContext = void 0;
+const react_1 = require("react");
+exports.SequenceContext = (0, react_1.createContext)(null);

package/dist/cjs/Still.d.ts

@@ -1,3 +1,7 @@
 /// <reference types="react" />
 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: <T>(props: StillProps<T>) => JSX.Element;

package/dist/cjs/Still.js

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Still = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 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)
+ */
 const Still = (props) => {
     return (0, jsx_runtime_1.jsx)(Composition_js_1.Composition, { fps: 1, durationInFrames: 1, ...props });
 };

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

@@ -1,5 +1,9 @@
 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<Pick<Omit<React.DetailedHTMLProps<React.AudioHTMLAttributes<HTMLAudioElement>, HTMLAudioElement>, "nonce" | "onEnded" | "onResize" | "onResizeCapture" | "autoPlay" | "controls"> & {
     volume?: import("../volume-prop.js").VolumeProp | undefined;
     playbackRate?: number | undefined;

package/dist/cjs/audio/Audio.js

@@ -4,7 +4,7 @@ exports.Audio = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = require("react");
 const get_environment_js_1 = require("../get-environment.js");
-const loop_1 = require("../loop");
+const index_js_1 = require("../loop/index.js");
 const Sequence_js_1 = require("../Sequence.js");
 const use_video_config_js_1 = require("../use-video-config.js");
 const validate_media_props_js_1 = require("../validate-media-props.js");
@@ -35,7 +35,7 @@ const AudioRefForwardingFunction = (props, ref) => {
         const duration = Math.floor(durations[props.src] * fps);
         const playbackRate = (_a = props.playbackRate) !== null && _a !== void 0 ? _a : 1;
         const actualDuration = duration / playbackRate;
-        return ((0, jsx_runtime_1.jsx)(loop_1.Loop, { layout: "none", durationInFrames: Math.floor(actualDuration), children: (0, jsx_runtime_1.jsx)(exports.Audio, { ...propsOtherThanLoop, ref: ref }) }));
+        return ((0, jsx_runtime_1.jsx)(index_js_1.Loop, { layout: "none", durationInFrames: Math.floor(actualDuration), children: (0, jsx_runtime_1.jsx)(exports.Audio, { ...propsOtherThanLoop, ref: ref }) }));
     }
     if (typeof startFrom !== 'undefined' || typeof endAt !== 'undefined') {
         (0, validate_start_from_props_js_1.validateStartFromProps)(startFrom, endAt);
@@ -49,4 +49,8 @@ const AudioRefForwardingFunction = (props, ref) => {
     }
     return ((0, jsx_runtime_1.jsx)(AudioForDevelopment_js_1.AudioForDevelopment, { shouldPreMountAudioTags: audioContext !== null && audioContext.numberOfAudioTags > 0, ...props, ref: ref, onError: onError, onDuration: onDuration }));
 };
+/**
+ * @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)
+ */
 exports.Audio = (0, react_1.forwardRef)(AudioRefForwardingFunction);

package/dist/cjs/audio/AudioForDevelopment.js

@@ -5,7 +5,7 @@ const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = require("react");
 const prefetch_js_1 = require("../prefetch.js");
 const random_js_1 = require("../random.js");
-const Sequence_js_1 = require("../Sequence.js");
+const SequenceContext_js_1 = require("../SequenceContext.js");
 const use_media_in_timeline_js_1 = require("../use-media-in-timeline.js");
 const use_media_playback_js_1 = require("../use-media-playback.js");
 const use_media_tag_volume_js_1 = require("../use-media-tag-volume.js");
@@ -33,7 +33,7 @@ const AudioForDevelopmentForwardRefFunction = (props, ref) => {
             ...nativeProps,
         };
     }, [mediaMuted, muted, nativeProps, preloadedSrc]);
-    const sequenceContext = (0, react_1.useContext)(Sequence_js_1.SequenceContext);
+    const sequenceContext = (0, react_1.useContext)(SequenceContext_js_1.SequenceContext);
     // Generate a string that's as unique as possible for this asset
     // but at the same time deterministic. We use it to combat strict mode issues.
     const id = (0, react_1.useMemo)(() => `audio-${(0, random_js_1.random)(src !== null && src !== void 0 ? src : '')}-${sequenceContext === null || sequenceContext === void 0 ? void 0 : sequenceContext.relativeFrom}-${sequenceContext === null || sequenceContext === void 0 ? void 0 : sequenceContext.cumulatedFrom}-${sequenceContext === null || sequenceContext === void 0 ? void 0 : sequenceContext.durationInFrames}-muted:${props.muted}`, [props.muted, src, sequenceContext]);

package/dist/cjs/audio/AudioForRendering.js

@@ -8,7 +8,7 @@ const CompositionManager_js_1 = require("../CompositionManager.js");
 const delay_render_js_1 = require("../delay-render.js");
 const get_environment_js_1 = require("../get-environment.js");
 const random_js_1 = require("../random.js");
-const Sequence_js_1 = require("../Sequence.js");
+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 volume_prop_js_1 = require("../volume-prop.js");
@@ -18,7 +18,7 @@ const AudioForRenderingRefForwardingFunction = (props, ref) => {
     const absoluteFrame = (0, timeline_position_state_js_1.useTimelinePosition)();
     const volumePropFrame = (0, use_audio_frame_js_1.useFrameForVolumeProp)();
     const frame = (0, use_current_frame_js_1.useCurrentFrame)();
-    const sequenceContext = (0, react_1.useContext)(Sequence_js_1.SequenceContext);
+    const sequenceContext = (0, react_1.useContext)(SequenceContext_js_1.SequenceContext);
     const { registerAsset, unregisterAsset } = (0, react_1.useContext)(CompositionManager_js_1.CompositionManager);
     const environment = (0, get_environment_js_1.useRemotionEnvironment)();
     // Generate a string that's as unique as possible for this asset

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

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useFrameForVolumeProp = exports.useMediaStartsAt = void 0;
 const react_1 = require("react");
-const Sequence_js_1 = require("../Sequence.js");
+const SequenceContext_js_1 = require("../SequenceContext.js");
 const use_current_frame_js_1 = require("../use-current-frame.js");
 const useMediaStartsAt = () => {
     var _a;
-    const parentSequence = (0, react_1.useContext)(Sequence_js_1.SequenceContext);
+    const parentSequence = (0, react_1.useContext)(SequenceContext_js_1.SequenceContext);
     const startsAt = Math.min(0, (_a = parentSequence === null || parentSequence === void 0 ? void 0 : parentSequence.relativeFrom) !== null && _a !== void 0 ? _a : 0);
     return startsAt;
 };

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

@@ -1 +1,5 @@
+/**
+ * @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

@@ -26,6 +26,10 @@ 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)
+ */
 function cancelRender(err) {
     let error;
     if (isErrorLike(err)) {

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

@@ -1,14 +1,14 @@
 export declare const DELAY_RENDER_CALLSTACK_TOKEN = "The delayRender was called:";
 /**
- * Call this function to tell Remotion to wait before capturing this frame until data has loaded. Use continueRender() to unblock the render.
+ * @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().
- * @link https://www.remotion.dev/docs/delay-render
+ * @see [Documentation](https://www.remotion.dev/docs/delay-render)
  */
 export declare const delayRender: (label?: string) => number;
 /**
- * Unblock a render that has been blocked by delayRender()
+ * @description Unblock a render that has been blocked by delayRender()
  * @param handle The return value of delayRender().
- * @link https://www.remotion.dev/docs/continue-render
+ * @see [Documentation](https://www.remotion.dev/docs/continue-render)
  */
 export declare const continueRender: (handle: number) => void;

package/dist/cjs/delay-render.js

@@ -11,10 +11,10 @@ const timeouts = {};
 exports.DELAY_RENDER_CALLSTACK_TOKEN = 'The delayRender was called:';
 const defaultTimeout = 30000;
 /**
- * Call this function to tell Remotion to wait before capturing this frame until data has loaded. Use continueRender() to unblock the render.
+ * @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().
- * @link https://www.remotion.dev/docs/delay-render
+ * @see [Documentation](https://www.remotion.dev/docs/delay-render)
  */
 const delayRender = (label) => {
     var _a, _b, _c;
@@ -49,9 +49,9 @@ const delayRender = (label) => {
 };
 exports.delayRender = delayRender;
 /**
- * Unblock a render that has been blocked by delayRender()
+ * @description Unblock a render that has been blocked by delayRender()
  * @param handle The return value of delayRender().
- * @link https://www.remotion.dev/docs/continue-render
+ * @see [Documentation](https://www.remotion.dev/docs/continue-render)
  */
 const continueRender = (handle) => {
     if (typeof handle === 'undefined') {

package/dist/cjs/easing.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @description The Easing module implements common easing functions. You can use it with the interpolate() API.
+ * @see [Documentation](https://www.remotion.dev/docs/easing)
+ */
 export declare class Easing {
     static step0(n: number): number;
     static step1(n: number): number;

package/dist/cjs/easing.js

@@ -3,6 +3,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Easing = void 0;
 const bezier_js_1 = require("./bezier.js");
+/**
+ * @description The Easing module implements common easing functions. You can use it with the interpolate() API.
+ * @see [Documentation](https://www.remotion.dev/docs/easing)
+ */
 class Easing {
     static step0(n) {
         return n > 0 ? 1 : 0;

package/dist/cjs/freeze.d.ts

@@ -3,5 +3,9 @@ declare type FreezeProps = {
     frame: number;
     children: React.ReactNode;
 };
+/**
+ * @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

@@ -3,8 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Freeze = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = require("react");
-const Sequence_js_1 = require("./Sequence.js");
+const SequenceContext_js_1 = require("./SequenceContext.js");
 const timeline_position_state_js_1 = require("./timeline-position-state.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)
+ */
 const Freeze = ({ frame, children }) => {
     if (typeof frame === 'undefined') {
         throw new Error(`The <Freeze /> component requires a 'frame' prop, but none was passed.`);
@@ -29,6 +33,6 @@ const Freeze = ({ frame, children }) => {
             frame,
         };
     }, [context, frame]);
-    return ((0, jsx_runtime_1.jsx)(timeline_position_state_js_1.TimelineContext.Provider, { value: value, children: (0, jsx_runtime_1.jsx)(Sequence_js_1.SequenceContext.Provider, { value: null, children: children }) }));
+    return ((0, jsx_runtime_1.jsx)(timeline_position_state_js_1.TimelineContext.Provider, { value: value, children: (0, jsx_runtime_1.jsx)(SequenceContext_js_1.SequenceContext.Provider, { value: null, children: children }) }));
 };
 exports.Freeze = Freeze;

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

@@ -1,3 +1,7 @@
+/**
+ * @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 declare type StaticFile = {
     /**

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

@@ -17,6 +17,10 @@ const warnPlayerOnce = () => {
     warnedPlayer = true;
     console.warn('Called getStaticFiles() while using the Remotion Player. The API is only available while using the Remotion Preview. 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)
+ */
 const getStaticFiles = () => {
     if (typeof document === 'undefined') {
         warnServerOnce();

package/dist/cjs/index.d.ts

@@ -47,11 +47,11 @@ export declare type BundleState = {
     compositionFps: number;
 };
 export * from './AbsoluteFill.js';
-export * from './audio';
+export * from './audio/index.js';
 export { cancelRender } from './cancel-render.js';
 export * from './Composition.js';
-export { SmallTCompMetadata, TAsset, TCompMetadata } from './CompositionManager.js';
-export { Config, ConfigType } from './config';
+export { SmallTCompMetadata, TAsset, TCompMetadata, } from './CompositionManager.js';
+export { Config, ConfigType } from './config.js';
 export { getInputProps } from './config/input-props.js';
 export { continueRender, delayRender } from './delay-render.js';
 export * from './easing.js';
@@ -61,31 +61,39 @@ export { getStaticFiles, StaticFile } from './get-static-files.js';
 export * from './IFrame.js';
 export * from './Img.js';
 export * from './internals.js';
-export * from './interpolate.js';
 export { interpolateColors } from './interpolate-colors.js';
-export { Loop } from './loop';
+export * from './interpolate.js';
+export { Loop } from './loop/index.js';
 export { ClipRegion } from './NativeLayers.js';
 export { prefetch } from './prefetch.js';
 export { random, RandomSeed } from './random.js';
 export { registerRoot } from './register-root.js';
 export { Sequence } from './Sequence.js';
-export { Series } from './series';
-export * from './spring';
+export { Series } from './series/index.js';
+export * from './spring/index.js';
 export { staticFile } from './static-file.js';
 export * from './Still.js';
 export type { PlayableMediaTag } from './timeline-position-state.js';
 export { useCurrentFrame } from './use-current-frame.js';
 export * from './use-video-config.js';
 export * from './version.js';
-export * from './video';
 export * from './video-config.js';
+export * from './video/index.js';
 export declare const Experimental: {
+    /**
+     * @description This is a special component that will cause Remotion to only partially capture the frame of the video.
+     * @see [Documentation](https://www.remotion.dev/docs/clipper)
+     */
     Clipper: import("react").FC<{
         width: number;
         height: number;
         x: number;
         y: number;
     }>;
+    /**
+     * @description This is a special component, that, when rendered, will skip rendering the frame altogether.
+     * @see [Documentation](https://www.remotion.dev/docs/null)
+     */
     Null: import("react").FC<{}>;
     useIsPlayer: () => boolean;
 };

package/dist/cjs/index.js

@@ -22,12 +22,12 @@ const multiple_versions_warning_js_1 = require("./multiple-versions-warning.js")
 const Null_js_1 = require("./Null.js");
 (0, multiple_versions_warning_js_1.checkMultipleRemotionVersions)();
 __exportStar(require("./AbsoluteFill.js"), exports);
-__exportStar(require("./audio"), exports);
+__exportStar(require("./audio/index.js"), exports);
 var cancel_render_js_1 = require("./cancel-render.js");
 Object.defineProperty(exports, "cancelRender", { enumerable: true, get: function () { return cancel_render_js_1.cancelRender; } });
 __exportStar(require("./Composition.js"), exports);
-var config_1 = require("./config");
-Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_1.Config; } });
+var config_js_1 = require("./config.js");
+Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_js_1.Config; } });
 var input_props_js_1 = require("./config/input-props.js");
 Object.defineProperty(exports, "getInputProps", { enumerable: true, get: function () { return input_props_js_1.getInputProps; } });
 var delay_render_js_1 = require("./delay-render.js");
@@ -41,11 +41,11 @@ Object.defineProperty(exports, "getStaticFiles", { enumerable: true, get: functi
 __exportStar(require("./IFrame.js"), exports);
 __exportStar(require("./Img.js"), exports);
 __exportStar(require("./internals.js"), exports);
-__exportStar(require("./interpolate.js"), exports);
 var interpolate_colors_js_1 = require("./interpolate-colors.js");
 Object.defineProperty(exports, "interpolateColors", { enumerable: true, get: function () { return interpolate_colors_js_1.interpolateColors; } });
-var loop_1 = require("./loop");
-Object.defineProperty(exports, "Loop", { enumerable: true, get: function () { return loop_1.Loop; } });
+__exportStar(require("./interpolate.js"), exports);
+var index_js_1 = require("./loop/index.js");
+Object.defineProperty(exports, "Loop", { enumerable: true, get: function () { return index_js_1.Loop; } });
 var prefetch_js_1 = require("./prefetch.js");
 Object.defineProperty(exports, "prefetch", { enumerable: true, get: function () { return prefetch_js_1.prefetch; } });
 var random_js_1 = require("./random.js");
@@ -54,9 +54,9 @@ var register_root_js_1 = require("./register-root.js");
 Object.defineProperty(exports, "registerRoot", { enumerable: true, get: function () { return register_root_js_1.registerRoot; } });
 var Sequence_js_1 = require("./Sequence.js");
 Object.defineProperty(exports, "Sequence", { enumerable: true, get: function () { return Sequence_js_1.Sequence; } });
-var series_1 = require("./series");
-Object.defineProperty(exports, "Series", { enumerable: true, get: function () { return series_1.Series; } });
-__exportStar(require("./spring"), exports);
+var index_js_2 = require("./series/index.js");
+Object.defineProperty(exports, "Series", { enumerable: true, get: function () { return index_js_2.Series; } });
+__exportStar(require("./spring/index.js"), exports);
 var static_file_js_1 = require("./static-file.js");
 Object.defineProperty(exports, "staticFile", { enumerable: true, get: function () { return static_file_js_1.staticFile; } });
 __exportStar(require("./Still.js"), exports);
@@ -64,10 +64,18 @@ var use_current_frame_js_1 = require("./use-current-frame.js");
 Object.defineProperty(exports, "useCurrentFrame", { enumerable: true, get: function () { return use_current_frame_js_1.useCurrentFrame; } });
 __exportStar(require("./use-video-config.js"), exports);
 __exportStar(require("./version.js"), exports);
-__exportStar(require("./video"), exports);
 __exportStar(require("./video-config.js"), exports);
+__exportStar(require("./video/index.js"), exports);
 exports.Experimental = {
+    /**
+     * @description This is a special component that will cause Remotion to only partially capture the frame of the video.
+     * @see [Documentation](https://www.remotion.dev/docs/clipper)
+     */
     Clipper: Clipper_js_1.Clipper,
+    /**
+     * @description This is a special component, that, when rendered, will skip rendering the frame altogether.
+     * @see [Documentation](https://www.remotion.dev/docs/null)
+     */
     Null: Null_js_1.Null,
     useIsPlayer: is_player_js_1.useIsPlayer,
 };

package/dist/cjs/internals.d.ts

@@ -10,7 +10,7 @@ import type { MediaVolumeContextValue, SetMediaVolumeContextValue } from './volu
 import { useRemotionContexts } from './wrap-remotion-context.js';
 declare const Timeline: typeof TimelinePosition;
 export declare const Internals: {
-    useUnsafeVideoConfig: () => import("./video-config").VideoConfig | null;
+    useUnsafeVideoConfig: () => import("./video-config.js").VideoConfig | null;
     Timeline: typeof TimelinePosition;
     CompositionManager: import("react").Context<CompositionManagerContext>;
     RemotionRoot: import("react").FC<{
@@ -36,7 +36,7 @@ export declare const Internals: {
         readonly _result: import("react").ComponentType<T>;
     };
     truthy: typeof truthy;
-    SequenceContext: import("react").Context<import("./Sequence.js").SequenceContextType | null>;
+    SequenceContext: import("react").Context<import("./SequenceContext.js").SequenceContextType | null>;
     useRemotionContexts: typeof useRemotionContexts;
     RemotionContextProvider: (props: import("./wrap-remotion-context.js").RemotionContextProviderProps) => JSX.Element;
     CSSUtils: typeof CSSUtils;
@@ -49,16 +49,16 @@ export declare const Internals: {
     validateDimension: (amount: number, nameOfProp: string, location: string) => void;
     getRemotionEnvironment: () => RemotionEnvironment;
     SharedAudioContext: import("react").Context<{
-        registerAudio: (aud: import("./audio").RemotionAudioProps, audioId: string) => {
+        registerAudio: (aud: import("./index.js").RemotionAudioProps, audioId: string) => {
             id: number;
-            props: import("./audio").RemotionAudioProps;
+            props: import("./index.js").RemotionAudioProps;
             el: import("react").RefObject<HTMLAudioElement>;
             audioId: string;
         };
         unregisterAudio: (id: number) => void;
         updateAudio: (options: {
             id: number;
-            aud: import("./audio").RemotionAudioProps;
+            aud: import("./index.js").RemotionAudioProps;
             audioId: string;
         }) => void;
         playAllAudios: () => void;