@remotion/player 4.0.0-webhook.26 → 4.1.0-alpha1

package/dist/cjs/PlayerControls.js

@@ -0,0 +1,161 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Controls = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const remotion_1 = require("remotion");
+const format_time_js_1 = require("./format-time.js");
+const icons_js_1 = require("./icons.js");
+const MediaVolumeSlider_js_1 = require("./MediaVolumeSlider.js");
+const PlaybackrateControl_js_1 = require("./PlaybackrateControl.js");
+const PlayerSeekBar_js_1 = require("./PlayerSeekBar.js");
+const use_video_controls_resize_js_1 = require("./use-video-controls-resize.js");
+const gradientSteps = [
+    0, 0.013, 0.049, 0.104, 0.175, 0.259, 0.352, 0.45, 0.55, 0.648, 0.741, 0.825,
+    0.896, 0.951, 0.987,
+];
+const gradientOpacities = [
+    0, 8.1, 15.5, 22.5, 29, 35.3, 41.2, 47.1, 52.9, 58.8, 64.7, 71, 77.5, 84.5,
+    91.9,
+];
+const globalGradientOpacity = 1 / 0.7;
+const containerStyle = {
+    boxSizing: 'border-box',
+    position: 'absolute',
+    bottom: 0,
+    width: '100%',
+    paddingTop: 40,
+    paddingBottom: 10,
+    backgroundImage: `linear-gradient(to bottom,${gradientSteps
+        .map((g, i) => {
+        return `hsla(0, 0%, 0%, ${g}) ${gradientOpacities[i] * globalGradientOpacity}%`;
+    })
+        .join(', ')}, hsl(0, 0%, 0%) 100%)`,
+    backgroundSize: 'auto 145px',
+    display: 'flex',
+    paddingRight: use_video_controls_resize_js_1.X_PADDING,
+    paddingLeft: use_video_controls_resize_js_1.X_PADDING,
+    flexDirection: 'column',
+    transition: 'opacity 0.3s',
+};
+const controlsRow = {
+    display: 'flex',
+    flexDirection: 'row',
+    width: '100%',
+    alignItems: 'center',
+    justifyContent: 'center',
+    userSelect: 'none',
+};
+const leftPartStyle = {
+    display: 'flex',
+    flexDirection: 'row',
+    userSelect: 'none',
+    alignItems: 'center',
+};
+const xSpacer = {
+    width: 12,
+};
+const ySpacer = {
+    height: 8,
+};
+const flex1 = {
+    flex: 1,
+};
+const fullscreen = {};
+const PlayPauseButton = ({ playing }) => playing ? (0, jsx_runtime_1.jsx)(icons_js_1.PauseIcon, {}) : (0, jsx_runtime_1.jsx)(icons_js_1.PlayIcon, {});
+const Controls = ({ durationInFrames, hovered, isFullscreen, fps, player, showVolumeControls, onFullscreenButtonClick, allowFullscreen, onExitFullscreenButtonClick, spaceKeyToPlayOrPause, onSeekEnd, onSeekStart, inFrame, outFrame, initiallyShowControls, canvasSize, renderPlayPauseButton, renderFullscreenButton, alwaysShowControls, showPlaybackRateControl, }) => {
+    var _a;
+    const playButtonRef = (0, react_1.useRef)(null);
+    const frame = remotion_1.Internals.Timeline.useTimelinePosition();
+    const [supportsFullscreen, setSupportsFullscreen] = (0, react_1.useState)(false);
+    const { maxTimeLabelWidth, displayVerticalVolumeSlider } = (0, use_video_controls_resize_js_1.useVideoControlsResize)({
+        allowFullscreen,
+        playerWidth: (_a = canvasSize === null || canvasSize === void 0 ? void 0 : canvasSize.width) !== null && _a !== void 0 ? _a : 0,
+    });
+    const [shouldShowInitially, setInitiallyShowControls] = (0, react_1.useState)(() => {
+        if (typeof initiallyShowControls === 'boolean') {
+            return initiallyShowControls;
+        }
+        if (typeof initiallyShowControls === 'number') {
+            if (initiallyShowControls % 1 !== 0) {
+                throw new Error('initiallyShowControls must be an integer or a boolean');
+            }
+            if (Number.isNaN(initiallyShowControls)) {
+                throw new Error('initiallyShowControls must not be NaN');
+            }
+            if (!Number.isFinite(initiallyShowControls)) {
+                throw new Error('initiallyShowControls must be finite');
+            }
+            if (initiallyShowControls <= 0) {
+                throw new Error('initiallyShowControls must be a positive integer');
+            }
+            return initiallyShowControls;
+        }
+        throw new TypeError('initiallyShowControls must be a number or a boolean');
+    });
+    const containerCss = (0, react_1.useMemo)(() => {
+        // Hide if playing and mouse outside
+        const shouldShow = hovered || !player.playing || shouldShowInitially || alwaysShowControls;
+        return {
+            ...containerStyle,
+            opacity: Number(shouldShow),
+        };
+    }, [hovered, shouldShowInitially, player.playing, alwaysShowControls]);
+    (0, react_1.useEffect)(() => {
+        if (playButtonRef.current && spaceKeyToPlayOrPause) {
+            // This switches focus to play button when player.playing flag changes
+            playButtonRef.current.focus({
+                preventScroll: true,
+            });
+        }
+    }, [player.playing, spaceKeyToPlayOrPause]);
+    (0, react_1.useEffect)(() => {
+        var _a;
+        // Must be handled client-side to avoid SSR hydration mismatch
+        setSupportsFullscreen((_a = (typeof document !== 'undefined' &&
+            (document.fullscreenEnabled || document.webkitFullscreenEnabled))) !== null && _a !== void 0 ? _a : false);
+    }, []);
+    (0, react_1.useEffect)(() => {
+        if (shouldShowInitially === false) {
+            return;
+        }
+        const time = shouldShowInitially === true ? 2000 : shouldShowInitially;
+        const timeout = setTimeout(() => {
+            setInitiallyShowControls(false);
+        }, time);
+        return () => {
+            clearInterval(timeout);
+        };
+    }, [shouldShowInitially]);
+    const timeLabel = (0, react_1.useMemo)(() => {
+        return {
+            color: 'white',
+            fontFamily: 'sans-serif',
+            fontSize: 14,
+            maxWidth: maxTimeLabelWidth === null ? undefined : maxTimeLabelWidth,
+            overflow: 'hidden',
+            textOverflow: 'ellipsis',
+        };
+    }, [maxTimeLabelWidth]);
+    const playbackRates = (0, react_1.useMemo)(() => {
+        if (showPlaybackRateControl === true) {
+            return [0.5, 0.8, 1, 1.2, 1.5, 1.8, 2, 2.5, 3];
+        }
+        if (Array.isArray(showPlaybackRateControl)) {
+            for (const rate of showPlaybackRateControl) {
+                if (typeof rate !== 'number') {
+                    throw new Error('Every item in showPlaybackRateControl must be a number');
+                }
+                if (rate <= 0) {
+                    throw new Error('Every item in showPlaybackRateControl must be positive');
+                }
+            }
+            return showPlaybackRateControl;
+        }
+        return null;
+    }, [showPlaybackRateControl]);
+    return ((0, jsx_runtime_1.jsxs)("div", { style: containerCss, children: [(0, jsx_runtime_1.jsxs)("div", { style: controlsRow, children: [(0, jsx_runtime_1.jsxs)("div", { style: leftPartStyle, children: [(0, jsx_runtime_1.jsx)("button", { ref: playButtonRef, type: "button", style: PlaybackrateControl_js_1.playerButtonStyle, onClick: player.playing ? player.pause : player.play, "aria-label": player.playing ? 'Pause video' : 'Play video', title: player.playing ? 'Pause video' : 'Play video', children: renderPlayPauseButton === null ? ((0, jsx_runtime_1.jsx)(PlayPauseButton, { playing: player.playing })) : (renderPlayPauseButton({ playing: player.playing })) }), showVolumeControls ? ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("div", { style: xSpacer }), (0, jsx_runtime_1.jsx)(MediaVolumeSlider_js_1.MediaVolumeSlider, { displayVerticalVolumeSlider: displayVerticalVolumeSlider })] })) : null, (0, jsx_runtime_1.jsx)("div", { style: xSpacer }), (0, jsx_runtime_1.jsxs)("div", { style: timeLabel, children: [(0, format_time_js_1.formatTime)(frame / fps), " / ", (0, format_time_js_1.formatTime)(durationInFrames / fps)] }), (0, jsx_runtime_1.jsx)("div", { style: xSpacer })] }), (0, jsx_runtime_1.jsx)("div", { style: flex1 }), playbackRates && canvasSize && ((0, jsx_runtime_1.jsx)(PlaybackrateControl_js_1.PlaybackrateControl, { canvasSize: canvasSize, playbackRates: playbackRates })), playbackRates && supportsFullscreen && allowFullscreen ? ((0, jsx_runtime_1.jsx)("div", { style: xSpacer })) : null, (0, jsx_runtime_1.jsx)("div", { style: fullscreen, children: supportsFullscreen && allowFullscreen ? ((0, jsx_runtime_1.jsx)("button", { type: "button", "aria-label": isFullscreen ? 'Exit fullscreen' : 'Enter Fullscreen', title: isFullscreen ? 'Exit fullscreen' : 'Enter Fullscreen', style: PlaybackrateControl_js_1.playerButtonStyle, onClick: isFullscreen
+                                ? onExitFullscreenButtonClick
+                                : onFullscreenButtonClick, children: renderFullscreenButton === null ? ((0, jsx_runtime_1.jsx)(icons_js_1.FullscreenIcon, { isFullscreen: isFullscreen })) : (renderFullscreenButton({ isFullscreen })) })) : null })] }), (0, jsx_runtime_1.jsx)("div", { style: ySpacer }), (0, jsx_runtime_1.jsx)(PlayerSeekBar_js_1.PlayerSeekBar, { onSeekEnd: onSeekEnd, onSeekStart: onSeekStart, durationInFrames: durationInFrames, inFrame: inFrame, outFrame: outFrame })] }));
+};
+exports.Controls = Controls;

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

@@ -4,9 +4,9 @@ exports.PlayerSeekBar = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = require("react");
 const remotion_1 = require("remotion");
-const use_hover_state_1 = require("./use-hover-state");
-const use_player_1 = require("./use-player");
-const use_element_size_1 = require("./utils/use-element-size");
+const use_hover_state_js_1 = require("./use-hover-state.js");
+const use_player_js_1 = require("./use-player.js");
+const use_element_size_js_1 = require("./utils/use-element-size.js");
 const getFrameFromX = (clientX, durationInFrames, width) => {
     var _a;
     const pos = clientX;
@@ -43,12 +43,12 @@ const findBodyInWhichDivIsLocated = (div) => {
 };
 const PlayerSeekBar = ({ durationInFrames, onSeekEnd, onSeekStart, inFrame, outFrame }) => {
     const containerRef = (0, react_1.useRef)(null);
-    const barHovered = (0, use_hover_state_1.useHoverState)(containerRef);
-    const size = (0, use_element_size_1.useElementSize)(containerRef, {
+    const barHovered = (0, use_hover_state_js_1.useHoverState)(containerRef);
+    const size = (0, use_element_size_js_1.useElementSize)(containerRef, {
         triggerOnWindowResize: true,
         shouldApplyCssTransforms: true,
     });
-    const { seek, play, pause, playing } = (0, use_player_1.usePlayer)();
+    const { seek, play, pause, playing } = (0, use_player_js_1.usePlayer)();
     const frame = remotion_1.Internals.Timeline.useTimelinePosition();
     const [dragging, setDragging] = (0, react_1.useState)({
         dragging: false,

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

@@ -1,28 +1,25 @@
 import React from 'react';
-import type { PlayerRef } from './player-methods';
-export declare type ErrorFallback = (info: {
+import type { PlayerRef } from './player-methods.js';
+import type { RenderFullscreenButton, RenderPlayPauseButton } from './PlayerControls.js';
+export type ErrorFallback = (info: {
     error: Error;
 }) => React.ReactNode;
-export declare type RenderLoading = (canvas: {
+export type RenderLoading = (canvas: {
     height: number;
     width: number;
-}) => React.ReactChild;
-export declare type RenderPoster = RenderLoading;
-declare const _default: (props: {
+}) => React.ReactNode;
+export type RenderPoster = RenderLoading;
+declare const _default: React.ForwardRefExoticComponent<{
     controls: boolean;
     loop: boolean;
     autoPlay: boolean;
     allowFullscreen: boolean;
-    inputProps: unknown;
+    inputProps: Record<string, unknown>;
     showVolumeControls: boolean;
-    mediaMuted: boolean;
     style?: React.CSSProperties | undefined;
     clickToPlay: boolean;
     doubleClickToFullscreen: boolean;
     spaceKeyToPlayOrPause: boolean;
-    setMediaVolume: (v: number) => void;
-    setMediaMuted: (v: boolean) => void;
-    mediaVolume: number;
     errorFallback: ErrorFallback;
     playbackRate: number;
     renderLoading: RenderLoading | undefined;
@@ -35,5 +32,9 @@ declare const _default: (props: {
     inFrame: number | null;
     outFrame: number | null;
     initiallyShowControls: number | boolean;
-} & React.RefAttributes<PlayerRef | null>) => React.ReactElement<any, string | React.JSXElementConstructor<any>> | null;
+    renderPlayPauseButton: RenderPlayPauseButton | null;
+    renderFullscreen: RenderFullscreenButton | null;
+    alwaysShowControls: boolean;
+    showPlaybackRateControl: boolean | number[];
+} & React.RefAttributes<PlayerRef>>;
 export default _default;

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

@@ -26,29 +26,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = __importStar(require("react"));
 const remotion_1 = require("remotion");
-const calculate_scale_1 = require("./calculate-scale");
-const error_boundary_1 = require("./error-boundary");
-const player_css_classname_1 = require("./player-css-classname");
-const PlayerControls_1 = require("./PlayerControls");
-const use_hover_state_1 = require("./use-hover-state");
-const use_playback_1 = require("./use-playback");
-const use_player_1 = require("./use-player");
-const calculate_player_size_1 = require("./utils/calculate-player-size");
-const is_node_1 = require("./utils/is-node");
-const use_click_prevention_on_double_click_1 = require("./utils/use-click-prevention-on-double-click");
-const use_element_size_1 = require("./utils/use-element-size");
+const calculate_scale_js_1 = require("./calculate-scale.js");
+const error_boundary_js_1 = require("./error-boundary.js");
+const player_css_classname_js_1 = require("./player-css-classname.js");
+const PlayerControls_js_1 = require("./PlayerControls.js");
+const use_hover_state_js_1 = require("./use-hover-state.js");
+const use_playback_js_1 = require("./use-playback.js");
+const use_player_js_1 = require("./use-player.js");
+const is_node_js_1 = require("./utils/is-node.js");
+const use_click_prevention_on_double_click_js_1 = require("./utils/use-click-prevention-on-double-click.js");
+const use_element_size_js_1 = require("./utils/use-element-size.js");
 const reactVersion = react_1.default.version.split('.')[0];
 if (reactVersion === '0') {
     throw new Error(`Version ${reactVersion} of "react" is not supported by Remotion`);
 }
 const doesReactVersionSupportSuspense = parseInt(reactVersion, 10) >= 18;
-const PlayerUI = ({ controls, style, loop, autoPlay, allowFullscreen, inputProps, clickToPlay, showVolumeControls, mediaVolume, mediaMuted, doubleClickToFullscreen, setMediaMuted, setMediaVolume, spaceKeyToPlayOrPause, errorFallback, playbackRate, renderLoading, renderPoster, className, moveToBeginningWhenEnded, showPosterWhenUnplayed, showPosterWhenEnded, showPosterWhenPaused, inFrame, outFrame, initiallyShowControls, }, ref) => {
-    var _a, _b, _c, _d, _e;
+const PlayerUI = ({ controls, style, loop, autoPlay, allowFullscreen, inputProps, clickToPlay, showVolumeControls, doubleClickToFullscreen, spaceKeyToPlayOrPause, errorFallback, playbackRate, renderLoading, renderPoster, className, moveToBeginningWhenEnded, showPosterWhenUnplayed, showPosterWhenEnded, showPosterWhenPaused, inFrame, outFrame, initiallyShowControls, renderFullscreen: renderFullscreenButton, renderPlayPauseButton, alwaysShowControls, showPlaybackRateControl, }, ref) => {
+    var _a, _b, _c;
     const config = remotion_1.Internals.useUnsafeVideoConfig();
     const video = remotion_1.Internals.useVideo();
     const container = (0, react_1.useRef)(null);
-    const hovered = (0, use_hover_state_1.useHoverState)(container);
-    const canvasSize = (0, use_element_size_1.useElementSize)(container, {
+    const hovered = (0, use_hover_state_js_1.useHoverState)(container);
+    const canvasSize = (0, use_element_size_js_1.useElementSize)(container, {
         triggerOnWindowResize: false,
         shouldApplyCssTransforms: false,
     });
@@ -56,14 +55,14 @@ const PlayerUI = ({ controls, style, loop, autoPlay, allowFullscreen, inputProps
     const [shouldAutoplay, setShouldAutoPlay] = (0, react_1.useState)(autoPlay);
     const [isFullscreen, setIsFullscreen] = (0, react_1.useState)(() => false);
     const [seeking, setSeeking] = (0, react_1.useState)(false);
-    (0, use_playback_1.usePlayback)({
+    (0, use_playback_js_1.usePlayback)({
         loop,
         playbackRate,
         moveToBeginningWhenEnded,
         inFrame,
         outFrame,
     });
-    const player = (0, use_player_1.usePlayer)();
+    const player = (0, use_player_js_1.usePlayer)();
     (0, react_1.useEffect)(() => {
         if (hasPausedToResume && !player.playing) {
             setHasPausedToResume(false);
@@ -129,12 +128,12 @@ const PlayerUI = ({ controls, style, loop, autoPlay, allowFullscreen, inputProps
             var _a;
             const element = (_a = document.webkitFullscreenElement) !== null && _a !== void 0 ? _a : document.fullscreenElement;
             if (element && element === container.current) {
-                player.emitter.dispatchFullscreenChangeUpdate({
+                player.emitter.dispatchFullscreenChange({
                     isFullscreen: true,
                 });
             }
             else {
-                player.emitter.dispatchFullscreenChangeUpdate({
+                player.emitter.dispatchFullscreenChange({
                     isFullscreen: false,
                 });
             }
@@ -151,7 +150,7 @@ const PlayerUI = ({ controls, style, loop, autoPlay, allowFullscreen, inputProps
         if (!config || !canvasSize) {
             return null;
         }
-        return (0, calculate_scale_1.calculateCanvasTransformation)({
+        return (0, calculate_scale_js_1.calculateCanvasTransformation)({
             canvasSize,
             compositionHeight: config.height,
             compositionWidth: config.width,
@@ -159,6 +158,25 @@ const PlayerUI = ({ controls, style, loop, autoPlay, allowFullscreen, inputProps
         });
     }, [canvasSize, config]);
     const scale = (_b = layout === null || layout === void 0 ? void 0 : layout.scale) !== null && _b !== void 0 ? _b : 1;
+    const initialScaleIgnored = (0, react_1.useRef)(false);
+    (0, react_1.useEffect)(() => {
+        if (!initialScaleIgnored.current) {
+            initialScaleIgnored.current = true;
+            return;
+        }
+        player.emitter.dispatchScaleChange(scale);
+    }, [player.emitter, scale]);
+    const { setMediaVolume, setMediaMuted } = (0, react_1.useContext)(remotion_1.Internals.SetMediaVolumeContext);
+    const { mediaMuted, mediaVolume } = (0, react_1.useContext)(remotion_1.Internals.MediaVolumeContext);
+    (0, react_1.useEffect)(() => {
+        player.emitter.dispatchVolumeChange(mediaVolume);
+    }, [player.emitter, mediaVolume]);
+    const isMuted = mediaMuted || mediaVolume === 0;
+    (0, react_1.useEffect)(() => {
+        player.emitter.dispatchMuteChange({
+            isMuted,
+        });
+    }, [player.emitter, isMuted]);
     (0, react_1.useImperativeHandle)(ref, () => {
         const methods = {
             play: player.play,
@@ -201,7 +219,7 @@ const PlayerUI = ({ controls, style, loop, autoPlay, allowFullscreen, inputProps
                 }
                 setMediaVolume(vol);
             },
-            isMuted: () => mediaMuted || mediaVolume === 0,
+            isMuted: () => isMuted,
             mute: () => {
                 setMediaMuted(true);
             },
@@ -217,6 +235,7 @@ const PlayerUI = ({ controls, style, loop, autoPlay, allowFullscreen, inputProps
         isFullscreen,
         loop,
         mediaMuted,
+        isMuted,
         mediaVolume,
         player,
         requestFullscreen,
@@ -227,52 +246,13 @@ const PlayerUI = ({ controls, style, loop, autoPlay, allowFullscreen, inputProps
     ]);
     const VideoComponent = video ? video.component : null;
     const outerStyle = (0, react_1.useMemo)(() => {
-        if (!config) {
-            return {};
-        }
-        return {
-            position: 'relative',
-            overflow: 'hidden',
-            ...(0, calculate_player_size_1.calculatePlayerSize)({
-                compositionHeight: config.height,
-                compositionWidth: config.width,
-                currentSize: canvasSize,
-                height: style === null || style === void 0 ? void 0 : style.height,
-                width: style === null || style === void 0 ? void 0 : style.width,
-            }),
-            ...style,
-        };
+        return (0, calculate_scale_js_1.calculateOuterStyle)({ canvasSize, config, style });
     }, [canvasSize, config, style]);
     const outer = (0, react_1.useMemo)(() => {
-        if (!layout || !config) {
-            return {};
-        }
-        const { centerX, centerY } = layout;
-        return {
-            width: config.width * scale,
-            height: config.height * scale,
-            display: 'flex',
-            flexDirection: 'column',
-            position: 'absolute',
-            left: centerX,
-            top: centerY,
-            overflow: 'hidden',
-        };
+        return (0, calculate_scale_js_1.calculateOuter)({ config, layout, scale });
     }, [config, layout, scale]);
     const containerStyle = (0, react_1.useMemo)(() => {
-        if (!config || !canvasSize || !layout) {
-            return {};
-        }
-        return {
-            position: 'absolute',
-            width: config.width,
-            height: config.height,
-            display: 'flex',
-            transform: `scale(${scale})`,
-            marginLeft: layout.xCorrection,
-            marginTop: layout.yCorrection,
-            overflow: 'hidden',
-        };
+        return (0, calculate_scale_js_1.calculateContainerStyle)({ canvasSize, config, layout, scale });
     }, [canvasSize, config, layout, scale]);
     const onError = (0, react_1.useCallback)((error) => {
         player.pause();
@@ -304,13 +284,21 @@ const PlayerUI = ({ controls, style, loop, autoPlay, allowFullscreen, inputProps
             requestFullscreen();
         }
     }, [exitFullscreen, isFullscreen, requestFullscreen]);
-    const [handleClick, handleDoubleClick] = (0, use_click_prevention_on_double_click_1.useClickPreventionOnDoubleClick)(onSingleClick, onDoubleClick, doubleClickToFullscreen);
+    const [handleClick, handleDoubleClick] = (0, use_click_prevention_on_double_click_js_1.useClickPreventionOnDoubleClick)(onSingleClick, onDoubleClick, doubleClickToFullscreen);
     (0, react_1.useEffect)(() => {
         if (shouldAutoplay) {
             player.play();
             setShouldAutoPlay(false);
         }
     }, [shouldAutoplay, player]);
+    const loadingMarkup = (0, react_1.useMemo)(() => {
+        return renderLoading
+            ? renderLoading({
+                height: outerStyle.height,
+                width: outerStyle.width,
+            })
+            : null;
+    }, [outerStyle.height, outerStyle.width, renderLoading]);
     if (!config) {
         return null;
     }
@@ -329,16 +317,10 @@ const PlayerUI = ({ controls, style, loop, autoPlay, allowFullscreen, inputProps
             showPosterWhenEnded && player.isLastFrame && !player.isPlaying(),
             showPosterWhenUnplayed && !player.hasPlayed && !player.isPlaying(),
         ].some(Boolean);
-    const content = ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("div", { style: outer, onClick: clickToPlay ? handleClick : undefined, onDoubleClick: doubleClickToFullscreen ? handleDoubleClick : undefined, children: (0, jsx_runtime_1.jsx)("div", { style: containerStyle, className: player_css_classname_1.PLAYER_CSS_CLASSNAME, children: VideoComponent ? ((0, jsx_runtime_1.jsx)(error_boundary_1.ErrorBoundary, { onError: onError, errorFallback: errorFallback, children: (0, jsx_runtime_1.jsx)(VideoComponent, { ...((_c = video === null || video === void 0 ? void 0 : video.defaultProps) !== null && _c !== void 0 ? _c : {}), ...((_d = inputProps) !== null && _d !== void 0 ? _d : {}) }) })) : null }) }), shouldShowPoster ? ((0, jsx_runtime_1.jsx)("div", { style: outer, onClick: clickToPlay ? handleClick : undefined, onDoubleClick: doubleClickToFullscreen ? handleDoubleClick : undefined, children: poster })) : null, controls ? ((0, jsx_runtime_1.jsx)(PlayerControls_1.Controls, { fps: config.fps, durationInFrames: config.durationInFrames, hovered: hovered, player: player, onFullscreenButtonClick: onFullscreenButtonClick, isFullscreen: isFullscreen, allowFullscreen: allowFullscreen, showVolumeControls: showVolumeControls, onExitFullscreenButtonClick: onExitFullscreenButtonClick, spaceKeyToPlayOrPause: spaceKeyToPlayOrPause, onSeekEnd: onSeekEnd, onSeekStart: onSeekStart, inFrame: inFrame, outFrame: outFrame, initiallyShowControls: initiallyShowControls, playerWidth: (_e = canvasSize === null || canvasSize === void 0 ? void 0 : canvasSize.width) !== null && _e !== void 0 ? _e : 0 })) : null] }));
-    if (is_node_1.IS_NODE && !doesReactVersionSupportSuspense) {
+    const content = ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("div", { style: outer, onClick: clickToPlay ? handleClick : undefined, onDoubleClick: doubleClickToFullscreen ? handleDoubleClick : undefined, children: (0, jsx_runtime_1.jsx)("div", { style: containerStyle, className: player_css_classname_js_1.PLAYER_CSS_CLASSNAME, children: VideoComponent ? ((0, jsx_runtime_1.jsx)(error_boundary_js_1.ErrorBoundary, { onError: onError, errorFallback: errorFallback, children: (0, jsx_runtime_1.jsx)(VideoComponent, { ...((_c = video === null || video === void 0 ? void 0 : video.defaultProps) !== null && _c !== void 0 ? _c : {}), ...(inputProps !== null && inputProps !== void 0 ? inputProps : {}) }) })) : null }) }), shouldShowPoster ? ((0, jsx_runtime_1.jsx)("div", { style: outer, onClick: clickToPlay ? handleClick : undefined, onDoubleClick: doubleClickToFullscreen ? handleDoubleClick : undefined, children: poster })) : null, controls ? ((0, jsx_runtime_1.jsx)(PlayerControls_js_1.Controls, { fps: config.fps, durationInFrames: config.durationInFrames, hovered: hovered, player: player, onFullscreenButtonClick: onFullscreenButtonClick, isFullscreen: isFullscreen, allowFullscreen: allowFullscreen, showVolumeControls: showVolumeControls, onExitFullscreenButtonClick: onExitFullscreenButtonClick, spaceKeyToPlayOrPause: spaceKeyToPlayOrPause, onSeekEnd: onSeekEnd, onSeekStart: onSeekStart, inFrame: inFrame, outFrame: outFrame, initiallyShowControls: initiallyShowControls, canvasSize: canvasSize, renderFullscreenButton: renderFullscreenButton, renderPlayPauseButton: renderPlayPauseButton, alwaysShowControls: alwaysShowControls, showPlaybackRateControl: showPlaybackRateControl })) : null] }));
+    if (is_node_js_1.IS_NODE && !doesReactVersionSupportSuspense) {
         return ((0, jsx_runtime_1.jsx)("div", { ref: container, style: outerStyle, className: className, children: content }));
     }
-    const loadingMarkup = renderLoading
-        ? renderLoading({
-            height: outerStyle.height,
-            width: outerStyle.width,
-        })
-        : null;
     return ((0, jsx_runtime_1.jsx)("div", { ref: container, style: outerStyle, className: className, children: (0, jsx_runtime_1.jsx)(react_1.Suspense, { fallback: loadingMarkup, children: content }) }));
 };
 exports.default = (0, react_1.forwardRef)(PlayerUI);

package/dist/cjs/SharedPlayerContext.d.ts

@@ -0,0 +1,15 @@
+import type { ComponentType, LazyExoticComponent } from 'react';
+import React from 'react';
+import type { TimelineContextValue } from 'remotion';
+export declare const SharedPlayerContexts: React.FC<{
+    children: React.ReactNode;
+    timelineContext: TimelineContextValue;
+    inputProps?: Record<string, unknown>;
+    fps: number;
+    compositionWidth: number;
+    compositionHeight: number;
+    durationInFrames: number;
+    component: LazyExoticComponent<ComponentType<unknown>>;
+    numberOfSharedAudioTags: number;
+    initiallyMuted: boolean;
+}>;

package/dist/cjs/SharedPlayerContext.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SharedPlayerContexts = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const remotion_1 = require("remotion");
+const volume_persistance_js_1 = require("./volume-persistance.js");
+const SharedPlayerContexts = ({ children, timelineContext, inputProps, fps, compositionHeight, compositionWidth, durationInFrames, component, numberOfSharedAudioTags, initiallyMuted, }) => {
+    const compositionManagerContext = (0, react_1.useMemo)(() => {
+        return {
+            compositions: [
+                {
+                    component: component,
+                    durationInFrames,
+                    height: compositionHeight,
+                    width: compositionWidth,
+                    fps,
+                    id: 'player-comp',
+                    props: inputProps,
+                    nonce: 777,
+                    scale: 1,
+                    folderName: null,
+                    defaultProps: undefined,
+                    parentFolderName: null,
+                    schema: null,
+                    calculateMetadata: null,
+                },
+            ],
+            folders: [],
+            registerFolder: () => undefined,
+            unregisterFolder: () => undefined,
+            currentComposition: 'player-comp',
+            registerComposition: () => undefined,
+            registerSequence: () => undefined,
+            sequences: [],
+            setCurrentComposition: () => undefined,
+            unregisterComposition: () => undefined,
+            unregisterSequence: () => undefined,
+            registerAsset: () => undefined,
+            unregisterAsset: () => undefined,
+            currentCompositionMetadata: null,
+            setCurrentCompositionMetadata: () => undefined,
+            assets: [],
+            setClipRegion: () => undefined,
+            resolved: null,
+        };
+    }, [
+        component,
+        durationInFrames,
+        compositionHeight,
+        compositionWidth,
+        fps,
+        inputProps,
+    ]);
+    const [mediaMuted, setMediaMuted] = (0, react_1.useState)(() => initiallyMuted);
+    const [mediaVolume, setMediaVolume] = (0, react_1.useState)(() => (0, volume_persistance_js_1.getPreferredVolume)());
+    const mediaVolumeContextValue = (0, react_1.useMemo)(() => {
+        return {
+            mediaMuted,
+            mediaVolume,
+        };
+    }, [mediaMuted, mediaVolume]);
+    const setMediaVolumeAndPersist = (0, react_1.useCallback)((vol) => {
+        setMediaVolume(vol);
+        (0, volume_persistance_js_1.persistVolume)(vol);
+    }, []);
+    const setMediaVolumeContextValue = (0, react_1.useMemo)(() => {
+        return {
+            setMediaMuted,
+            setMediaVolume: setMediaVolumeAndPersist,
+        };
+    }, [setMediaVolumeAndPersist]);
+    return ((0, jsx_runtime_1.jsx)(remotion_1.Internals.CanUseRemotionHooksProvider, { children: (0, jsx_runtime_1.jsx)(remotion_1.Internals.Timeline.TimelineContext.Provider, { value: timelineContext, children: (0, jsx_runtime_1.jsx)(remotion_1.Internals.CompositionManager.Provider, { value: compositionManagerContext, children: (0, jsx_runtime_1.jsx)(remotion_1.Internals.ResolveCompositionConfig, { children: (0, jsx_runtime_1.jsx)(remotion_1.Internals.PrefetchProvider, { children: (0, jsx_runtime_1.jsx)(remotion_1.Internals.DurationsContextProvider, { children: (0, jsx_runtime_1.jsx)(remotion_1.Internals.MediaVolumeContext.Provider, { value: mediaVolumeContextValue, children: (0, jsx_runtime_1.jsx)(remotion_1.Internals.SetMediaVolumeContext.Provider, { value: setMediaVolumeContextValue, children: (0, jsx_runtime_1.jsx)(remotion_1.Internals.SharedAudioContextProvider, { numberOfAudioTags: numberOfSharedAudioTags, component: component, children: children }) }) }) }) }) }) }) }) }));
+};
+exports.SharedPlayerContexts = SharedPlayerContexts;

package/dist/cjs/Thumbnail.d.ts

@@ -0,0 +1,24 @@
+import type { CSSProperties, MutableRefObject } from 'react';
+import type { CompProps } from 'remotion';
+import type { AnyZodObject } from 'zod';
+import type { ThumbnailMethods } from './player-methods.js';
+import type { ErrorFallback, RenderLoading } from './PlayerUI.js';
+import type { PropsIfHasProps } from './utils/props-if-has-props.js';
+type ThumbnailProps<Schema extends AnyZodObject, Props> = PropsIfHasProps<Schema, Props> & CompProps<Schema> & {
+    frameToDisplay: number;
+    style?: CSSProperties;
+    durationInFrames: number;
+    compositionWidth: number;
+    compositionHeight: number;
+    fps: number;
+    errorFallback?: ErrorFallback;
+    renderLoading?: RenderLoading;
+    className?: string;
+};
+export declare const ThumbnailFn: <Schema extends AnyZodObject, Props>({ frameToDisplay, style, inputProps, compositionHeight, compositionWidth, durationInFrames, fps, className, errorFallback, renderLoading, ...componentProps }: ThumbnailProps<Schema, Props>, ref: MutableRefObject<ThumbnailMethods>) => JSX.Element;
+/**
+ * @description A component which can be rendered in a regular React App (for example: Create React App, Next.js) to display a single frame of a video.
+ * @see [Documentation](https://www.remotion.dev/docs/player/thumbnail)
+ */
+export declare const Thumbnail: <Schema extends AnyZodObject, Props>(props: ThumbnailProps<Schema, Props> & import("react").RefAttributes<ThumbnailMethods>) => React.ReactElement | null;
+export {};

package/dist/cjs/Thumbnail.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Thumbnail = exports.ThumbnailFn = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const remotion_1 = require("remotion");
+const emitter_context_js_1 = require("./emitter-context.js");
+const event_emitter_js_1 = require("./event-emitter.js");
+const SharedPlayerContext_js_1 = require("./SharedPlayerContext.js");
+const ThumbnailUI_js_1 = __importDefault(require("./ThumbnailUI.js"));
+const ThumbnailFn = ({ frameToDisplay, style, inputProps, compositionHeight, compositionWidth, durationInFrames, fps, className, errorFallback = () => '⚠️', renderLoading, ...componentProps }, ref) => {
+    const [thumbnailId] = (0, react_1.useState)(() => String((0, remotion_1.random)(null)));
+    const rootRef = (0, react_1.useRef)(null);
+    const timelineState = (0, react_1.useMemo)(() => {
+        return {
+            playing: false,
+            frame: frameToDisplay,
+            rootId: thumbnailId,
+            imperativePlaying: {
+                current: false,
+            },
+            playbackRate: 1,
+            setPlaybackRate: () => {
+                throw new Error('thumbnail');
+            },
+            audioAndVideoTags: { current: [] },
+        };
+    }, [frameToDisplay, thumbnailId]);
+    (0, react_1.useImperativeHandle)(ref, () => rootRef.current, []);
+    const Component = remotion_1.Internals.useLazyComponent(componentProps);
+    const [emitter] = (0, react_1.useState)(() => new event_emitter_js_1.ThumbnailEmitter());
+    const passedInputProps = (0, react_1.useMemo)(() => {
+        return inputProps !== null && inputProps !== void 0 ? inputProps : {};
+    }, [inputProps]);
+    return ((0, jsx_runtime_1.jsx)(remotion_1.Internals.IsPlayerContextProvider, { children: (0, jsx_runtime_1.jsx)(SharedPlayerContext_js_1.SharedPlayerContexts, { timelineContext: timelineState, component: Component, compositionHeight: compositionHeight, compositionWidth: compositionWidth, durationInFrames: durationInFrames, fps: fps, inputProps: passedInputProps, numberOfSharedAudioTags: 0, initiallyMuted: true, children: (0, jsx_runtime_1.jsx)(emitter_context_js_1.ThumbnailEmitterContext.Provider, { value: emitter, children: (0, jsx_runtime_1.jsx)(ThumbnailUI_js_1.default, { className: className, errorFallback: errorFallback, inputProps: passedInputProps, renderLoading: renderLoading, style: style }) }) }) }));
+};
+exports.ThumbnailFn = ThumbnailFn;
+const forward = react_1.forwardRef;
+/**
+ * @description A component which can be rendered in a regular React App (for example: Create React App, Next.js) to display a single frame of a video.
+ * @see [Documentation](https://www.remotion.dev/docs/player/thumbnail)
+ */
+exports.Thumbnail = forward(exports.ThumbnailFn);

package/dist/cjs/ThumbnailUI.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import type { ThumbnailMethods } from './player-methods.js';
+import type { ErrorFallback, RenderLoading } from './PlayerUI.js';
+declare const _default: React.ForwardRefExoticComponent<{
+    inputProps: Record<string, unknown>;
+    style?: React.CSSProperties | undefined;
+    errorFallback: ErrorFallback;
+    renderLoading: RenderLoading | undefined;
+    className: string | undefined;
+} & React.RefAttributes<ThumbnailMethods>>;
+export default _default;