remotion 3.3.45 → 3.3.52

package/dist/cjs/Img.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Img = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const delay_render_js_1 = require("./delay-render.js");
+const get_environment_js_1 = require("./get-environment.js");
+const prefetch_js_1 = require("./prefetch.js");
+const ImgRefForwarding = ({ onError, src, ...props }, ref) => {
+    const imageRef = (0, react_1.useRef)(null);
+    const environment = (0, get_environment_js_1.useRemotionEnvironment)();
+    (0, react_1.useImperativeHandle)(ref, () => {
+        return imageRef.current;
+    }, []);
+    const actualSrc = (0, prefetch_js_1.usePreload)(src);
+    const didGetError = (0, react_1.useCallback)((e) => {
+        var _a;
+        if (onError) {
+            onError(e);
+        }
+        else {
+            console.error('Error loading image with src:', (_a = imageRef.current) === null || _a === void 0 ? void 0 : _a.src, e, 'Handle the event using the onError() prop to make this message disappear.');
+        }
+    }, [onError]);
+    // If image source switches, make new handle
+    if (environment === 'rendering') {
+        // eslint-disable-next-line react-hooks/rules-of-hooks
+        (0, react_1.useLayoutEffect)(() => {
+            if (process.env.NODE_ENV === 'test') {
+                return;
+            }
+            const newHandle = (0, delay_render_js_1.delayRender)('Loading <Img> with src=' + src);
+            const { current } = imageRef;
+            const didLoad = () => {
+                (0, delay_render_js_1.continueRender)(newHandle);
+            };
+            if (current === null || current === void 0 ? void 0 : current.complete) {
+                (0, delay_render_js_1.continueRender)(newHandle);
+            }
+            else {
+                current === null || current === void 0 ? void 0 : current.addEventListener('load', didLoad, { once: true });
+            }
+            // If tag gets unmounted, clear pending handles because image is not going to load
+            return () => {
+                current === null || current === void 0 ? void 0 : current.removeEventListener('load', didLoad);
+                (0, delay_render_js_1.continueRender)(newHandle);
+            };
+        }, [src]);
+    }
+    return ((0, jsx_runtime_1.jsx)("img", { ...props, ref: imageRef, src: actualSrc, onError: didGetError }));
+};
+exports.Img = (0, react_1.forwardRef)(ImgRefForwarding);

package/dist/cjs/NativeLayers.d.ts

@@ -0,0 +1,13 @@
+import type { PropsWithChildren } from 'react';
+export declare type ClipRegion = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+} | 'hide';
+export declare type TNativeLayersContext = {
+    clipRegion: ClipRegion | null;
+    setClipRegion: React.Dispatch<React.SetStateAction<ClipRegion | null>>;
+};
+export declare const NativeLayersContext: import("react").Context<TNativeLayersContext>;
+export declare const NativeLayersProvider: React.FC<PropsWithChildren>;

package/dist/cjs/NativeLayers.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NativeLayersProvider = exports.NativeLayersContext = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+exports.NativeLayersContext = (0, react_1.createContext)({
+    setClipRegion: () => {
+        throw new Error('NativeLayers not set');
+    },
+    clipRegion: null,
+});
+const NativeLayersProvider = ({ children, }) => {
+    const [clipRegion, setClipRegion] = (0, react_1.useState)(null);
+    const context = (0, react_1.useMemo)(() => {
+        return {
+            setClipRegion,
+            clipRegion,
+        };
+    }, [clipRegion, setClipRegion]);
+    (0, react_1.useLayoutEffect)(() => {
+        if (typeof window !== 'undefined') {
+            window.remotion_getClipRegion = () => {
+                return clipRegion;
+            };
+        }
+    }, [clipRegion, setClipRegion]);
+    return ((0, jsx_runtime_1.jsx)(exports.NativeLayersContext.Provider, { value: context, children: children }));
+};
+exports.NativeLayersProvider = NativeLayersProvider;

package/dist/cjs/Null.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const Null: React.FC;

package/dist/cjs/Null.js

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

package/dist/cjs/RemotionRoot.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+export declare const RemotionRoot: React.FC<{
+    children: React.ReactNode;
+    numberOfAudioTags: number;
+}>;

package/dist/cjs/RemotionRoot.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemotionRoot = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const shared_audio_tags_js_1 = require("./audio/shared-audio-tags.js");
+const CompositionManager_js_1 = require("./CompositionManager.js");
+const delay_render_js_1 = require("./delay-render.js");
+const NativeLayers_js_1 = require("./NativeLayers.js");
+const nonce_js_1 = require("./nonce.js");
+const prefetch_state_js_1 = require("./prefetch-state.js");
+const random_js_1 = require("./random.js");
+const timeline_position_state_js_1 = require("./timeline-position-state.js");
+const duration_state_js_1 = require("./video/duration-state.js");
+const RemotionRoot = ({ children, numberOfAudioTags }) => {
+    var _a;
+    const [remotionRootId] = (0, react_1.useState)(() => String((0, random_js_1.random)(null)));
+    const [frame, setFrame] = (0, react_1.useState)((_a = window.remotion_initialFrame) !== null && _a !== void 0 ? _a : 0);
+    const [playing, setPlaying] = (0, react_1.useState)(false);
+    const imperativePlaying = (0, react_1.useRef)(false);
+    const [fastRefreshes, setFastRefreshes] = (0, react_1.useState)(0);
+    const [playbackRate, setPlaybackRate] = (0, react_1.useState)(1);
+    const audioAndVideoTags = (0, react_1.useRef)([]);
+    (0, react_1.useLayoutEffect)(() => {
+        if (typeof window !== 'undefined') {
+            window.remotion_setFrame = (f) => {
+                const id = (0, delay_render_js_1.delayRender)(`Setting the current frame to ${f}`);
+                setFrame(f);
+                requestAnimationFrame(() => (0, delay_render_js_1.continueRender)(id));
+            };
+            window.remotion_isPlayer = false;
+        }
+    }, []);
+    const timelineContextValue = (0, react_1.useMemo)(() => {
+        return {
+            frame,
+            playing,
+            imperativePlaying,
+            rootId: remotionRootId,
+            playbackRate,
+            setPlaybackRate,
+            audioAndVideoTags,
+        };
+    }, [frame, playbackRate, playing, remotionRootId]);
+    const setTimelineContextValue = (0, react_1.useMemo)(() => {
+        return {
+            setFrame,
+            setPlaying,
+        };
+    }, []);
+    const nonceContext = (0, react_1.useMemo)(() => {
+        let counter = 0;
+        return {
+            getNonce: () => counter++,
+            fastRefreshes,
+        };
+    }, [fastRefreshes]);
+    (0, react_1.useEffect)(() => {
+        if (module.hot) {
+            module.hot.addStatusHandler((status) => {
+                if (status === 'idle') {
+                    setFastRefreshes((i) => i + 1);
+                }
+            });
+        }
+    }, []);
+    return ((0, jsx_runtime_1.jsx)(nonce_js_1.NonceContext.Provider, { value: nonceContext, children: (0, jsx_runtime_1.jsx)(timeline_position_state_js_1.TimelineContext.Provider, { value: timelineContextValue, children: (0, jsx_runtime_1.jsx)(timeline_position_state_js_1.SetTimelineContext.Provider, { value: setTimelineContextValue, children: (0, jsx_runtime_1.jsx)(prefetch_state_js_1.PrefetchProvider, { children: (0, jsx_runtime_1.jsx)(NativeLayers_js_1.NativeLayersProvider, { children: (0, jsx_runtime_1.jsx)(CompositionManager_js_1.CompositionManagerProvider, { children: (0, jsx_runtime_1.jsx)(duration_state_js_1.DurationsContextProvider, { children: (0, jsx_runtime_1.jsx)(shared_audio_tags_js_1.SharedAudioContextProvider
+                                // In the preview, which is mostly played on Desktop, we opt out of the autoplay policy fix as described in https://github.com/remotion-dev/remotion/pull/554, as it mostly applies to mobile.
+                                , { 
+                                    // In the preview, which is mostly played on Desktop, we opt out of the autoplay policy fix as described in https://github.com/remotion-dev/remotion/pull/554, as it mostly applies to mobile.
+                                    numberOfAudioTags: numberOfAudioTags, children: children }) }) }) }) }) }) }) }));
+};
+exports.RemotionRoot = RemotionRoot;

package/dist/cjs/Sequence.d.ts

@@ -0,0 +1,29 @@
+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';
+} | {
+    layout?: 'absolute-fill';
+    style?: React.CSSProperties;
+    className?: string;
+};
+export declare type SequenceProps = {
+    children: React.ReactNode;
+    from?: number;
+    durationInFrames?: number;
+    name?: string;
+    showInTimeline?: boolean;
+    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
+ */
+export declare const Sequence: React.ForwardRefExoticComponent<SequenceProps & React.RefAttributes<HTMLDivElement>>;

package/dist/cjs/Sequence.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Sequence = exports.SequenceContext = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const AbsoluteFill_js_1 = require("./AbsoluteFill.js");
+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 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 { rootId } = (0, react_1.useContext)(timeline_position_state_js_1.TimelineContext);
+    const cumulatedFrom = parentSequence
+        ? parentSequence.cumulatedFrom + parentSequence.relativeFrom
+        : 0;
+    const nonce = (0, nonce_js_1.useNonce)();
+    const environment = (0, get_environment_js_1.useRemotionEnvironment)();
+    if (layout !== 'absolute-fill' && layout !== 'none') {
+        throw new TypeError(`The layout prop of <Sequence /> expects either "absolute-fill" or "none", but you passed: ${layout}`);
+    }
+    // @ts-expect-error
+    if (layout === 'none' && typeof other.style !== 'undefined') {
+        throw new TypeError('If layout="none", you may not pass a style.');
+    }
+    if (typeof durationInFrames !== 'number') {
+        throw new TypeError(`You passed to durationInFrames an argument of type ${typeof durationInFrames}, but it must be a number.`);
+    }
+    if (durationInFrames <= 0) {
+        throw new TypeError(`durationInFrames must be positive, but got ${durationInFrames}`);
+    }
+    // Infinity is non-integer but allowed!
+    if (durationInFrames % 1 !== 0 && Number.isFinite(durationInFrames)) {
+        throw new TypeError(`The "durationInFrames" of a sequence must be an integer, but got ${durationInFrames}.`);
+    }
+    if (typeof from !== 'number') {
+        throw new TypeError(`You passed to the "from" props of your <Sequence> an argument of type ${typeof from}, but it must be a number.`);
+    }
+    if (from % 1 !== 0) {
+        throw new TypeError(`The "from" prop of a sequence must be an integer, but got ${from}.`);
+    }
+    const absoluteFrame = (0, timeline_position_state_js_1.useTimelinePosition)();
+    const videoConfig = (0, use_video_config_js_1.useVideoConfig)();
+    const parentSequenceDuration = parentSequence
+        ? Math.min(parentSequence.durationInFrames - from, durationInFrames)
+        : durationInFrames;
+    const actualDurationInFrames = Math.max(0, Math.min(videoConfig.durationInFrames - from, parentSequenceDuration));
+    const { registerSequence, unregisterSequence } = (0, react_1.useContext)(CompositionManager_js_1.CompositionManager);
+    const contextValue = (0, react_1.useMemo)(() => {
+        var _a;
+        return {
+            cumulatedFrom,
+            relativeFrom: from,
+            durationInFrames: actualDurationInFrames,
+            parentFrom: (_a = parentSequence === null || parentSequence === void 0 ? void 0 : parentSequence.relativeFrom) !== null && _a !== void 0 ? _a : 0,
+            id,
+        };
+    }, [
+        cumulatedFrom,
+        from,
+        actualDurationInFrames,
+        parentSequence === null || parentSequence === void 0 ? void 0 : parentSequence.relativeFrom,
+        id,
+    ]);
+    const timelineClipName = (0, react_1.useMemo)(() => {
+        return name !== null && name !== void 0 ? name : (0, get_timeline_clip_name_js_1.getTimelineClipName)(children);
+    }, [children, name]);
+    (0, react_1.useEffect)(() => {
+        var _a;
+        if (environment !== 'preview') {
+            return;
+        }
+        registerSequence({
+            from,
+            duration: actualDurationInFrames,
+            id,
+            displayName: timelineClipName,
+            parent: (_a = parentSequence === null || parentSequence === void 0 ? void 0 : parentSequence.id) !== null && _a !== void 0 ? _a : null,
+            type: 'sequence',
+            rootId,
+            showInTimeline,
+            nonce,
+            showLoopTimesInTimeline,
+        });
+        return () => {
+            unregisterSequence(id);
+        };
+    }, [
+        durationInFrames,
+        id,
+        name,
+        registerSequence,
+        timelineClipName,
+        unregisterSequence,
+        parentSequence === null || parentSequence === void 0 ? void 0 : parentSequence.id,
+        actualDurationInFrames,
+        rootId,
+        from,
+        showInTimeline,
+        nonce,
+        showLoopTimesInTimeline,
+        environment,
+    ]);
+    const endThreshold = cumulatedFrom + from + durationInFrames - 1;
+    const content = absoluteFrame < cumulatedFrom + from
+        ? null
+        : absoluteFrame > endThreshold
+            ? null
+            : children;
+    const styleIfThere = other.layout === 'none' ? undefined : other.style;
+    const defaultStyle = (0, react_1.useMemo)(() => {
+        return {
+            flexDirection: undefined,
+            ...(styleIfThere !== null && styleIfThere !== void 0 ? styleIfThere : {}),
+        };
+    }, [styleIfThere]);
+    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 })) }));
+};
+/**
+ * A component that time-shifts its children and wraps them in an absolutely positioned <div>.
+ * @link https://www.remotion.dev/docs/sequence
+ */
+exports.Sequence = (0, react_1.forwardRef)(SequenceRefForwardingFunction);

package/dist/cjs/Still.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { StillProps } from './Composition.js';
+export declare const Still: <T>(props: StillProps<T>) => JSX.Element;

package/dist/cjs/Still.js

@@ -0,0 +1,9 @@
+"use strict";
+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");
+const Still = (props) => {
+    return (0, jsx_runtime_1.jsx)(Composition_js_1.Composition, { fps: 1, durationInFrames: 1, ...props });
+};
+exports.Still = Still;

package/dist/cjs/absolute-src.d.ts

@@ -0,0 +1 @@
+export declare const getAbsoluteSrc: (relativeSrc: string) => string;

package/dist/cjs/absolute-src.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAbsoluteSrc = void 0;
+const getAbsoluteSrc = (relativeSrc) => {
+    return new URL(relativeSrc, window.location.origin).href;
+};
+exports.getAbsoluteSrc = getAbsoluteSrc;

package/dist/cjs/asset-types.d.ts

@@ -0,0 +1,50 @@
+declare module '*.webm' {
+    const src: string;
+    export default src;
+}
+declare module '*.png' {
+    const src: string;
+    export default src;
+}
+declare module '*.mp4' {
+    const src: string;
+    export default src;
+}
+declare module '*.mp3' {
+    const src: string;
+    export default src;
+}
+declare module '*.wav' {
+    const src: string;
+    export default src;
+}
+declare module '*.aac' {
+    const src: string;
+    export default src;
+}
+declare module '*.svg';
+declare module '*.jpg' {
+    const src: string;
+    export default src;
+}
+declare module '*.jpeg' {
+    const src: string;
+    export default src;
+}
+declare module '*.bmp' {
+    const src: string;
+    export default src;
+}
+declare module '*.gif' {
+    const src: string;
+    export default src;
+}
+declare module '*.woff' {
+    const src: string;
+    export default src;
+}
+declare module '*.woff2' {
+    const src: string;
+    export default src;
+}
+declare module '*.css';

package/dist/cjs/asset-types.js

@@ -0,0 +1 @@
+"use strict";

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

@@ -0,0 +1,8 @@
+import React from 'react';
+import type { RemotionMainAudioProps } from './props.js';
+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;
+    acceptableTimeShiftInSeconds?: number | undefined;
+    allowAmplificationDuringRender?: boolean | undefined;
+} & RemotionMainAudioProps, "id" | "key" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "className" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "lang" | "placeholder" | "slot" | "spellCheck" | "style" | "tabIndex" | "title" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "children" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "src" | "volume" | "playbackRate" | "allowAmplificationDuringRender" | "controlsList" | "crossOrigin" | "loop" | "mediaGroup" | "muted" | "playsInline" | "preload" | "acceptableTimeShiftInSeconds" | keyof RemotionMainAudioProps> & React.RefAttributes<HTMLAudioElement>>;

package/dist/cjs/audio/Audio.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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 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");
+const validate_start_from_props_js_1 = require("../validate-start-from-props.js");
+const duration_state_js_1 = require("../video/duration-state.js");
+const AudioForDevelopment_js_1 = require("./AudioForDevelopment.js");
+const AudioForRendering_js_1 = require("./AudioForRendering.js");
+const shared_audio_tags_js_1 = require("./shared-audio-tags.js");
+const AudioRefForwardingFunction = (props, ref) => {
+    var _a;
+    const audioContext = (0, react_1.useContext)(shared_audio_tags_js_1.SharedAudioContext);
+    const { startFrom, endAt, ...otherProps } = props;
+    const { loop, ...propsOtherThanLoop } = props;
+    const { fps } = (0, use_video_config_js_1.useVideoConfig)();
+    const environment = (0, get_environment_js_1.useRemotionEnvironment)();
+    const { durations, setDurations } = (0, react_1.useContext)(duration_state_js_1.DurationsContext);
+    if (typeof props.src !== 'string') {
+        throw new TypeError(`The \`<Audio>\` tag requires a string for \`src\`, but got ${JSON.stringify(props.src)} instead.`);
+    }
+    const onError = (0, react_1.useCallback)((e) => {
+        console.log(e.currentTarget.error);
+        throw new Error(`Could not play audio with src ${otherProps.src}: ${e.currentTarget.error}. See https://remotion.dev/docs/media-playback-error for help.`);
+    }, [otherProps.src]);
+    const onDuration = (0, react_1.useCallback)((src, durationInSeconds) => {
+        setDurations({ type: 'got-duration', durationInSeconds, src });
+    }, [setDurations]);
+    if (loop && props.src && durations[props.src] !== undefined) {
+        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 }) }));
+    }
+    if (typeof startFrom !== 'undefined' || typeof endAt !== 'undefined') {
+        (0, validate_start_from_props_js_1.validateStartFromProps)(startFrom, endAt);
+        const startFromFrameNo = startFrom !== null && startFrom !== void 0 ? startFrom : 0;
+        const endAtFrameNo = endAt !== null && endAt !== void 0 ? endAt : Infinity;
+        return ((0, jsx_runtime_1.jsx)(Sequence_js_1.Sequence, { layout: "none", from: 0 - startFromFrameNo, showInTimeline: false, durationInFrames: endAtFrameNo, children: (0, jsx_runtime_1.jsx)(exports.Audio, { ...otherProps, ref: ref }) }));
+    }
+    (0, validate_media_props_js_1.validateMediaProps)(props, 'Audio');
+    if (environment === 'rendering') {
+        return ((0, jsx_runtime_1.jsx)(AudioForRendering_js_1.AudioForRendering, { onDuration: onDuration, ...props, ref: ref, onError: onError }));
+    }
+    return ((0, jsx_runtime_1.jsx)(AudioForDevelopment_js_1.AudioForDevelopment, { shouldPreMountAudioTags: audioContext !== null && audioContext.numberOfAudioTags > 0, ...props, ref: ref, onError: onError, onDuration: onDuration }));
+};
+exports.Audio = (0, react_1.forwardRef)(AudioRefForwardingFunction);

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

@@ -0,0 +1,11 @@
+import type { ForwardRefExoticComponent, RefAttributes } from 'react';
+import React from 'react';
+export declare const AudioForDevelopment: ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.AudioHTMLAttributes<HTMLAudioElement>, HTMLAudioElement>, "nonce" | "onEnded" | "onResize" | "onResizeCapture" | "autoPlay" | "controls"> & {
+    volume?: import("../volume-prop.js").VolumeProp | undefined;
+    playbackRate?: number | undefined;
+    acceptableTimeShiftInSeconds?: number | undefined;
+    allowAmplificationDuringRender?: boolean | undefined;
+} & {
+    shouldPreMountAudioTags: boolean;
+    onDuration: (src: string, durationInSeconds: number) => void;
+} & RefAttributes<HTMLAudioElement>>;

package/dist/cjs/audio/AudioForDevelopment.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AudioForDevelopment = void 0;
+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 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");
+const use_sync_volume_with_media_tag_js_1 = require("../use-sync-volume-with-media-tag.js");
+const volume_position_state_js_1 = require("../volume-position-state.js");
+const shared_audio_tags_js_1 = require("./shared-audio-tags.js");
+const use_audio_frame_js_1 = require("./use-audio-frame.js");
+const AudioForDevelopmentForwardRefFunction = (props, ref) => {
+    const [initialShouldPreMountAudioElements] = (0, react_1.useState)(props.shouldPreMountAudioTags);
+    if (props.shouldPreMountAudioTags !== initialShouldPreMountAudioElements) {
+        throw new Error('Cannot change the behavior for pre-mounting audio tags dynamically.');
+    }
+    const [mediaVolume] = (0, volume_position_state_js_1.useMediaVolumeState)();
+    const [mediaMuted] = (0, volume_position_state_js_1.useMediaMutedState)();
+    const volumePropFrame = (0, use_audio_frame_js_1.useFrameForVolumeProp)();
+    const { volume, muted, playbackRate, shouldPreMountAudioTags, src, onDuration, acceptableTimeShiftInSeconds, ...nativeProps } = props;
+    if (!src) {
+        throw new TypeError("No 'src' was passed to <Audio>.");
+    }
+    const preloadedSrc = (0, prefetch_js_1.usePreload)(src);
+    const propsToPass = (0, react_1.useMemo)(() => {
+        return {
+            muted: muted || mediaMuted,
+            src: preloadedSrc,
+            ...nativeProps,
+        };
+    }, [mediaMuted, muted, nativeProps, preloadedSrc]);
+    const sequenceContext = (0, react_1.useContext)(Sequence_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]);
+    const audioRef = (0, shared_audio_tags_js_1.useSharedAudio)(propsToPass, id).el;
+    const actualVolume = (0, use_media_tag_volume_js_1.useMediaTagVolume)(audioRef);
+    (0, use_sync_volume_with_media_tag_js_1.useSyncVolumeWithMediaTag)({
+        volumePropFrame,
+        actualVolume,
+        volume,
+        mediaVolume,
+        mediaRef: audioRef,
+    });
+    (0, use_media_in_timeline_js_1.useMediaInTimeline)({
+        volume,
+        mediaVolume,
+        mediaRef: audioRef,
+        src,
+        mediaType: 'audio',
+        playbackRate: playbackRate !== null && playbackRate !== void 0 ? playbackRate : 1,
+    });
+    (0, use_media_playback_js_1.useMediaPlayback)({
+        mediaRef: audioRef,
+        src,
+        mediaType: 'audio',
+        playbackRate: playbackRate !== null && playbackRate !== void 0 ? playbackRate : 1,
+        onlyWarnForMediaSeekingError: false,
+        acceptableTimeshift: acceptableTimeShiftInSeconds !== null && acceptableTimeShiftInSeconds !== void 0 ? acceptableTimeShiftInSeconds : use_media_playback_js_1.DEFAULT_ACCEPTABLE_TIMESHIFT,
+    });
+    (0, react_1.useImperativeHandle)(ref, () => {
+        return audioRef.current;
+    }, [audioRef]);
+    const currentOnDurationCallback = (0, react_1.useRef)();
+    currentOnDurationCallback.current = onDuration;
+    (0, react_1.useEffect)(() => {
+        var _a;
+        const { current } = audioRef;
+        if (!current) {
+            return;
+        }
+        if (current.duration) {
+            (_a = currentOnDurationCallback.current) === null || _a === void 0 ? void 0 : _a.call(currentOnDurationCallback, src, current.duration);
+            return;
+        }
+        const onLoadedMetadata = () => {
+            var _a;
+            (_a = currentOnDurationCallback.current) === null || _a === void 0 ? void 0 : _a.call(currentOnDurationCallback, src, current.duration);
+        };
+        current.addEventListener('loadedmetadata', onLoadedMetadata);
+        return () => {
+            current.removeEventListener('loadedmetadata', onLoadedMetadata);
+        };
+    }, [audioRef, src]);
+    if (initialShouldPreMountAudioElements) {
+        return null;
+    }
+    return (0, jsx_runtime_1.jsx)("audio", { ref: audioRef, ...propsToPass });
+};
+exports.AudioForDevelopment = (0, react_1.forwardRef)(AudioForDevelopmentForwardRefFunction);

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

@@ -0,0 +1,10 @@
+import type { ForwardRefExoticComponent, RefAttributes } from 'react';
+import React from 'react';
+export declare const AudioForRendering: ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.AudioHTMLAttributes<HTMLAudioElement>, HTMLAudioElement>, "nonce" | "onEnded" | "onResize" | "onResizeCapture" | "autoPlay" | "controls"> & {
+    volume?: import("../volume-prop.js").VolumeProp | undefined;
+    playbackRate?: number | undefined;
+    acceptableTimeShiftInSeconds?: number | undefined;
+    allowAmplificationDuringRender?: boolean | undefined;
+} & {
+    onDuration: (src: string, durationInSeconds: number) => void;
+} & RefAttributes<HTMLAudioElement>>;