@remotion/player 4.0.0-lambda.3 → 4.0.0-newpaths.13

package/dist/esm/PlayerSeekBar.js

@@ -0,0 +1,142 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
+import { Internals, interpolate } from 'remotion';
+import { useHoverState } from './use-hover-state';
+import { usePlayer } from './use-player';
+import { useElementSize } from './utils/use-element-size';
+const getFrameFromX = (clientX, durationInFrames, width) => {
+    var _a;
+    const pos = clientX;
+    const frame = Math.round(interpolate(pos, [0, width], [0, (_a = durationInFrames - 1) !== null && _a !== void 0 ? _a : 0], {
+        extrapolateLeft: 'clamp',
+        extrapolateRight: 'clamp',
+    }));
+    return frame;
+};
+const BAR_HEIGHT = 5;
+const KNOB_SIZE = 12;
+const VERTICAL_PADDING = 4;
+const containerStyle = {
+    userSelect: 'none',
+    paddingTop: VERTICAL_PADDING,
+    paddingBottom: VERTICAL_PADDING,
+    boxSizing: 'border-box',
+    cursor: 'pointer',
+    position: 'relative',
+    touchAction: 'none',
+};
+const barBackground = {
+    height: BAR_HEIGHT,
+    backgroundColor: 'rgba(255, 255, 255, 0.25)',
+    width: '100%',
+    borderRadius: BAR_HEIGHT / 2,
+};
+const findBodyInWhichDivIsLocated = (div) => {
+    let current = div;
+    while (current.parentElement) {
+        current = current.parentElement;
+    }
+    return current;
+};
+export const PlayerSeekBar = ({ durationInFrames, onSeekEnd, onSeekStart, inFrame, outFrame }) => {
+    const containerRef = useRef(null);
+    const barHovered = useHoverState(containerRef);
+    const size = useElementSize(containerRef, {
+        triggerOnWindowResize: true,
+        shouldApplyCssTransforms: true,
+    });
+    const { seek, play, pause, playing } = usePlayer();
+    const frame = Internals.Timeline.useTimelinePosition();
+    const [dragging, setDragging] = useState({
+        dragging: false,
+    });
+    const onPointerDown = useCallback((e) => {
+        if (!size) {
+            throw new Error('Player has no size');
+        }
+        const _frame = getFrameFromX(e.clientX - size.left, durationInFrames, size.width);
+        pause();
+        seek(_frame);
+        setDragging({
+            dragging: true,
+            wasPlaying: playing,
+        });
+        onSeekStart();
+    }, [size, durationInFrames, pause, seek, playing, onSeekStart]);
+    const onPointerMove = useCallback((e) => {
+        var _a;
+        if (!size) {
+            throw new Error('Player has no size');
+        }
+        if (!dragging.dragging) {
+            return;
+        }
+        const _frame = getFrameFromX(e.clientX - ((_a = size === null || size === void 0 ? void 0 : size.left) !== null && _a !== void 0 ? _a : 0), durationInFrames, size.width);
+        seek(_frame);
+    }, [dragging.dragging, durationInFrames, seek, size]);
+    const onPointerUp = useCallback(() => {
+        setDragging({
+            dragging: false,
+        });
+        if (!dragging.dragging) {
+            return;
+        }
+        if (dragging.wasPlaying) {
+            play();
+        }
+        else {
+            pause();
+        }
+        onSeekEnd();
+    }, [dragging, onSeekEnd, pause, play]);
+    useEffect(() => {
+        if (!dragging.dragging) {
+            return;
+        }
+        const body = findBodyInWhichDivIsLocated(containerRef.current);
+        body.addEventListener('pointermove', onPointerMove);
+        body.addEventListener('pointerup', onPointerUp);
+        return () => {
+            body.removeEventListener('pointermove', onPointerMove);
+            body.removeEventListener('pointerup', onPointerUp);
+        };
+    }, [dragging.dragging, onPointerMove, onPointerUp]);
+    const knobStyle = useMemo(() => {
+        var _a;
+        return {
+            height: KNOB_SIZE,
+            width: KNOB_SIZE,
+            borderRadius: KNOB_SIZE / 2,
+            position: 'absolute',
+            top: VERTICAL_PADDING - KNOB_SIZE / 2 + 5 / 2,
+            backgroundColor: 'white',
+            left: Math.max(0, (frame / Math.max(1, durationInFrames - 1)) * ((_a = size === null || size === void 0 ? void 0 : size.width) !== null && _a !== void 0 ? _a : 0) -
+                KNOB_SIZE / 2),
+            boxShadow: '0 0 2px black',
+            opacity: Number(barHovered),
+        };
+    }, [barHovered, durationInFrames, frame, size]);
+    const fillStyle = useMemo(() => {
+        return {
+            height: BAR_HEIGHT,
+            backgroundColor: 'rgba(255, 255, 255, 1)',
+            width: ((frame - (inFrame !== null && inFrame !== void 0 ? inFrame : 0)) / (durationInFrames - 1)) * 100 + '%',
+            marginLeft: ((inFrame !== null && inFrame !== void 0 ? inFrame : 0) / (durationInFrames - 1)) * 100 + '%',
+            borderRadius: BAR_HEIGHT / 2,
+        };
+    }, [durationInFrames, frame, inFrame]);
+    const active = useMemo(() => {
+        return {
+            height: BAR_HEIGHT,
+            backgroundColor: 'rgba(255, 255, 255, 0.25)',
+            width: (((outFrame !== null && outFrame !== void 0 ? outFrame : durationInFrames - 1) - (inFrame !== null && inFrame !== void 0 ? inFrame : 0)) /
+                (durationInFrames - 1)) *
+                100 +
+                '%',
+            marginLeft: ((inFrame !== null && inFrame !== void 0 ? inFrame : 0) / (durationInFrames - 1)) * 100 + '%',
+            borderRadius: BAR_HEIGHT / 2,
+            position: 'absolute',
+        };
+    }, [durationInFrames, inFrame, outFrame]);
+    return (_jsxs("div", { ref: containerRef, onPointerDown: onPointerDown, style: containerStyle, children: [_jsxs("div", { style: barBackground, children: [_jsx("div", { style: active }), _jsx("div", { style: fillStyle })] }), _jsx("div", { style: knobStyle })] }));
+};

package/dist/esm/PlayerUI.d.ts

@@ -0,0 +1,38 @@
+import React from 'react';
+import type { PlayerRef } from './player-methods';
+import type { RenderFullscreenButton, RenderPlayPauseButton } from './PlayerControls';
+export declare type ErrorFallback = (info: {
+    error: Error;
+}) => React.ReactNode;
+export declare type RenderLoading = (canvas: {
+    height: number;
+    width: number;
+}) => React.ReactNode;
+export declare type RenderPoster = RenderLoading;
+declare const _default: React.ForwardRefExoticComponent<{
+    controls: boolean;
+    loop: boolean;
+    autoPlay: boolean;
+    allowFullscreen: boolean;
+    inputProps: unknown;
+    showVolumeControls: boolean;
+    style?: React.CSSProperties | undefined;
+    clickToPlay: boolean;
+    doubleClickToFullscreen: boolean;
+    spaceKeyToPlayOrPause: boolean;
+    errorFallback: ErrorFallback;
+    playbackRate: number;
+    renderLoading: RenderLoading | undefined;
+    renderPoster: RenderLoading | undefined;
+    className: string | undefined;
+    moveToBeginningWhenEnded: boolean;
+    showPosterWhenPaused: boolean;
+    showPosterWhenEnded: boolean;
+    showPosterWhenUnplayed: boolean;
+    inFrame: number | null;
+    outFrame: number | null;
+    initiallyShowControls: number | boolean;
+    renderPlayPauseButton: RenderPlayPauseButton | null;
+    renderFullscreen: RenderFullscreenButton | null;
+} & React.RefAttributes<PlayerRef>>;
+export default _default;

package/dist/esm/PlayerUI.js

@@ -0,0 +1,283 @@
+import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+import React, { forwardRef, Suspense, useCallback, useContext, useEffect, useImperativeHandle, useMemo, useRef, useState, } from 'react';
+import { Internals } from 'remotion';
+import { calculateCanvasTransformation, calculateContainerStyle, calculateOuter, calculateOuterStyle, } from './calculate-scale';
+import { ErrorBoundary } from './error-boundary';
+import { PLAYER_CSS_CLASSNAME } from './player-css-classname';
+import { Controls } from './PlayerControls';
+import { useHoverState } from './use-hover-state';
+import { usePlayback } from './use-playback';
+import { usePlayer } from './use-player';
+import { IS_NODE } from './utils/is-node';
+import { useClickPreventionOnDoubleClick } from './utils/use-click-prevention-on-double-click';
+import { useElementSize } from './utils/use-element-size';
+const reactVersion = React.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, doubleClickToFullscreen, spaceKeyToPlayOrPause, errorFallback, playbackRate, renderLoading, renderPoster, className, moveToBeginningWhenEnded, showPosterWhenUnplayed, showPosterWhenEnded, showPosterWhenPaused, inFrame, outFrame, initiallyShowControls, renderFullscreen: renderFullscreenButton, renderPlayPauseButton, }, ref) => {
+    var _a, _b, _c, _d, _e;
+    const config = Internals.useUnsafeVideoConfig();
+    const video = Internals.useVideo();
+    const container = useRef(null);
+    const hovered = useHoverState(container);
+    const canvasSize = useElementSize(container, {
+        triggerOnWindowResize: false,
+        shouldApplyCssTransforms: false,
+    });
+    const [hasPausedToResume, setHasPausedToResume] = useState(false);
+    const [shouldAutoplay, setShouldAutoPlay] = useState(autoPlay);
+    const [isFullscreen, setIsFullscreen] = useState(() => false);
+    const [seeking, setSeeking] = useState(false);
+    usePlayback({
+        loop,
+        playbackRate,
+        moveToBeginningWhenEnded,
+        inFrame,
+        outFrame,
+    });
+    const player = usePlayer();
+    useEffect(() => {
+        if (hasPausedToResume && !player.playing) {
+            setHasPausedToResume(false);
+            player.play();
+        }
+    }, [hasPausedToResume, player]);
+    useEffect(() => {
+        const { current } = container;
+        if (!current) {
+            return;
+        }
+        const onFullscreenChange = () => {
+            setIsFullscreen(document.fullscreenElement === current ||
+                document.webkitFullscreenElement === current);
+        };
+        document.addEventListener('fullscreenchange', onFullscreenChange);
+        document.addEventListener('webkitfullscreenchange', onFullscreenChange);
+        return () => {
+            document.removeEventListener('fullscreenchange', onFullscreenChange);
+            document.removeEventListener('webkitfullscreenchange', onFullscreenChange);
+        };
+    }, []);
+    const toggle = useCallback((e) => {
+        if (player.isPlaying()) {
+            player.pause();
+        }
+        else {
+            player.play(e);
+        }
+    }, [player]);
+    const requestFullscreen = useCallback(() => {
+        if (!allowFullscreen) {
+            throw new Error('allowFullscreen is false');
+        }
+        const supportsFullScreen = document.fullscreenEnabled || document.webkitFullscreenEnabled;
+        if (!supportsFullScreen) {
+            throw new Error('Browser doesnt support fullscreen');
+        }
+        if (!container.current) {
+            throw new Error('No player ref found');
+        }
+        if (container.current.webkitRequestFullScreen) {
+            container.current.webkitRequestFullScreen();
+        }
+        else {
+            container.current.requestFullscreen();
+        }
+    }, [allowFullscreen]);
+    const exitFullscreen = useCallback(() => {
+        if (document.webkitExitFullscreen) {
+            document.webkitExitFullscreen();
+        }
+        else {
+            document.exitFullscreen();
+        }
+    }, []);
+    useEffect(() => {
+        const { current } = container;
+        if (!current) {
+            return;
+        }
+        const fullscreenChange = () => {
+            var _a;
+            const element = (_a = document.webkitFullscreenElement) !== null && _a !== void 0 ? _a : document.fullscreenElement;
+            if (element && element === container.current) {
+                player.emitter.dispatchFullscreenChangeUpdate({
+                    isFullscreen: true,
+                });
+            }
+            else {
+                player.emitter.dispatchFullscreenChangeUpdate({
+                    isFullscreen: false,
+                });
+            }
+        };
+        current.addEventListener('webkitfullscreenchange', fullscreenChange);
+        current.addEventListener('fullscreenchange', fullscreenChange);
+        return () => {
+            current.removeEventListener('webkitfullscreenchange', fullscreenChange);
+            current.removeEventListener('fullscreenchange', fullscreenChange);
+        };
+    }, [player.emitter]);
+    const durationInFrames = (_a = config === null || config === void 0 ? void 0 : config.durationInFrames) !== null && _a !== void 0 ? _a : 1;
+    const layout = useMemo(() => {
+        if (!config || !canvasSize) {
+            return null;
+        }
+        return calculateCanvasTransformation({
+            canvasSize,
+            compositionHeight: config.height,
+            compositionWidth: config.width,
+            previewSize: 'auto',
+        });
+    }, [canvasSize, config]);
+    const scale = (_b = layout === null || layout === void 0 ? void 0 : layout.scale) !== null && _b !== void 0 ? _b : 1;
+    const { setMediaVolume, setMediaMuted } = useContext(Internals.SetMediaVolumeContext);
+    const { mediaMuted, mediaVolume } = useContext(Internals.MediaVolumeContext);
+    useImperativeHandle(ref, () => {
+        const methods = {
+            play: player.play,
+            pause: player.pause,
+            toggle,
+            getContainerNode: () => container.current,
+            getCurrentFrame: player.getCurrentFrame,
+            isPlaying: () => player.playing,
+            seekTo: (f) => {
+                const lastFrame = durationInFrames - 1;
+                const frameToSeekTo = Math.max(0, Math.min(lastFrame, f));
+                if (player.isPlaying()) {
+                    const pauseToResume = frameToSeekTo !== lastFrame || loop;
+                    setHasPausedToResume(pauseToResume);
+                    player.pause();
+                }
+                if (frameToSeekTo === lastFrame && !loop) {
+                    player.emitter.dispatchEnded();
+                }
+                player.seek(frameToSeekTo);
+            },
+            isFullscreen: () => isFullscreen,
+            requestFullscreen,
+            exitFullscreen,
+            getVolume: () => {
+                if (mediaMuted) {
+                    return 0;
+                }
+                return mediaVolume;
+            },
+            setVolume: (vol) => {
+                if (typeof vol !== 'number') {
+                    throw new TypeError(`setVolume() takes a number, got value of type ${typeof vol}`);
+                }
+                if (isNaN(vol)) {
+                    throw new TypeError(`setVolume() got a number that is NaN. Volume must be between 0 and 1.`);
+                }
+                if (vol < 0 || vol > 1) {
+                    throw new TypeError(`setVolume() got a number that is out of range. Must be between 0 and 1, got ${typeof vol}`);
+                }
+                setMediaVolume(vol);
+            },
+            isMuted: () => mediaMuted || mediaVolume === 0,
+            mute: () => {
+                setMediaMuted(true);
+            },
+            unmute: () => {
+                setMediaMuted(false);
+            },
+            getScale: () => scale,
+        };
+        return Object.assign(player.emitter, methods);
+    }, [
+        durationInFrames,
+        exitFullscreen,
+        isFullscreen,
+        loop,
+        mediaMuted,
+        mediaVolume,
+        player,
+        requestFullscreen,
+        setMediaMuted,
+        setMediaVolume,
+        toggle,
+        scale,
+    ]);
+    const VideoComponent = video ? video.component : null;
+    const outerStyle = useMemo(() => {
+        return calculateOuterStyle({ canvasSize, config, style });
+    }, [canvasSize, config, style]);
+    const outer = useMemo(() => {
+        return calculateOuter({ config, layout, scale });
+    }, [config, layout, scale]);
+    const containerStyle = useMemo(() => {
+        return calculateContainerStyle({ canvasSize, config, layout, scale });
+    }, [canvasSize, config, layout, scale]);
+    const onError = useCallback((error) => {
+        player.pause();
+        // Pay attention to `this context`
+        player.emitter.dispatchError(error);
+    }, [player]);
+    const onFullscreenButtonClick = useCallback((e) => {
+        e.stopPropagation();
+        requestFullscreen();
+    }, [requestFullscreen]);
+    const onExitFullscreenButtonClick = useCallback((e) => {
+        e.stopPropagation();
+        exitFullscreen();
+    }, [exitFullscreen]);
+    const onSingleClick = useCallback((e) => {
+        toggle(e);
+    }, [toggle]);
+    const onSeekStart = useCallback(() => {
+        setSeeking(true);
+    }, []);
+    const onSeekEnd = useCallback(() => {
+        setSeeking(false);
+    }, []);
+    const onDoubleClick = useCallback(() => {
+        if (isFullscreen) {
+            exitFullscreen();
+        }
+        else {
+            requestFullscreen();
+        }
+    }, [exitFullscreen, isFullscreen, requestFullscreen]);
+    const [handleClick, handleDoubleClick] = useClickPreventionOnDoubleClick(onSingleClick, onDoubleClick, doubleClickToFullscreen);
+    useEffect(() => {
+        if (shouldAutoplay) {
+            player.play();
+            setShouldAutoPlay(false);
+        }
+    }, [shouldAutoplay, player]);
+    const loadingMarkup = useMemo(() => {
+        return renderLoading
+            ? renderLoading({
+                height: outerStyle.height,
+                width: outerStyle.width,
+            })
+            : null;
+    }, [outerStyle.height, outerStyle.width, renderLoading]);
+    if (!config) {
+        return null;
+    }
+    const poster = renderPoster
+        ? renderPoster({
+            height: outerStyle.height,
+            width: outerStyle.width,
+        })
+        : null;
+    if (poster === undefined) {
+        throw new TypeError('renderPoster() must return a React element, but undefined was returned');
+    }
+    const shouldShowPoster = poster &&
+        [
+            showPosterWhenPaused && !player.isPlaying() && !seeking,
+            showPosterWhenEnded && player.isLastFrame && !player.isPlaying(),
+            showPosterWhenUnplayed && !player.hasPlayed && !player.isPlaying(),
+        ].some(Boolean);
+    const content = (_jsxs(_Fragment, { children: [_jsx("div", { style: outer, onClick: clickToPlay ? handleClick : undefined, onDoubleClick: doubleClickToFullscreen ? handleDoubleClick : undefined, children: _jsx("div", { style: containerStyle, className: PLAYER_CSS_CLASSNAME, children: VideoComponent ? (_jsx(ErrorBoundary, { onError: onError, errorFallback: errorFallback, children: _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 ? (_jsx("div", { style: outer, onClick: clickToPlay ? handleClick : undefined, onDoubleClick: doubleClickToFullscreen ? handleDoubleClick : undefined, children: poster })) : null, controls ? (_jsx(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, renderFullscreenButton: renderFullscreenButton, renderPlayPauseButton: renderPlayPauseButton })) : null] }));
+    if (IS_NODE && !doesReactVersionSupportSuspense) {
+        return (_jsx("div", { ref: container, style: outerStyle, className: className, children: content }));
+    }
+    return (_jsx("div", { ref: container, style: outerStyle, className: className, children: _jsx(Suspense, { fallback: loadingMarkup, children: content }) }));
+};
+export default forwardRef(PlayerUI);

package/dist/esm/SharedPlayerContext.d.ts

@@ -0,0 +1,14 @@
+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?: unknown;
+    fps: number;
+    compositionWidth: number;
+    compositionHeight: number;
+    durationInFrames: number;
+    component: LazyExoticComponent<ComponentType<unknown>>;
+    numberOfSharedAudioTags: number;
+}>;

package/dist/esm/SharedPlayerContext.js

@@ -0,0 +1,68 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useCallback, useMemo, useState } from 'react';
+import { Internals } from 'remotion';
+import { getPreferredVolume, persistVolume } from './volume-persistance';
+export const SharedPlayerContexts = ({ children, timelineContext, inputProps, fps, compositionHeight, compositionWidth, durationInFrames, component, numberOfSharedAudioTags, }) => {
+    const compositionManagerContext = 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,
+                },
+            ],
+            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,
+        };
+    }, [
+        component,
+        durationInFrames,
+        compositionHeight,
+        compositionWidth,
+        fps,
+        inputProps,
+    ]);
+    const [mediaMuted, setMediaMuted] = useState(false);
+    const [mediaVolume, setMediaVolume] = useState(getPreferredVolume());
+    const mediaVolumeContextValue = useMemo(() => {
+        return {
+            mediaMuted,
+            mediaVolume,
+        };
+    }, [mediaMuted, mediaVolume]);
+    const setMediaVolumeAndPersist = useCallback((vol) => {
+        setMediaVolume(vol);
+        persistVolume(vol);
+    }, []);
+    const setMediaVolumeContextValue = useMemo(() => {
+        return {
+            setMediaMuted,
+            setMediaVolume: setMediaVolumeAndPersist,
+        };
+    }, [setMediaVolumeAndPersist]);
+    return (_jsx(Internals.CanUseRemotionHooksProvider, { children: _jsx(Internals.Timeline.TimelineContext.Provider, { value: timelineContext, children: _jsx(Internals.CompositionManager.Provider, { value: compositionManagerContext, children: _jsx(Internals.PrefetchProvider, { children: _jsx(Internals.DurationsContextProvider, { children: _jsx(Internals.MediaVolumeContext.Provider, { value: mediaVolumeContextValue, children: _jsx(Internals.SetMediaVolumeContext.Provider, { value: setMediaVolumeContextValue, children: _jsx(Internals.SharedAudioContextProvider, { numberOfAudioTags: numberOfSharedAudioTags, children: children }) }) }) }) }) }) }) }));
+};

package/dist/esm/Thumbnail.d.ts

@@ -0,0 +1,20 @@
+import type { CSSProperties, MutableRefObject } from 'react';
+import type { CompProps } from 'remotion';
+import type { ThumbnailMethods } from './player-methods';
+import type { ErrorFallback, RenderLoading } from './PlayerUI';
+import type { PropsIfHasProps } from './utils/props-if-has-props';
+declare type ThumbnailProps<T> = PropsIfHasProps<T> & CompProps<T> & {
+    frameToDisplay: number;
+    style?: CSSProperties;
+    durationInFrames: number;
+    compositionWidth: number;
+    compositionHeight: number;
+    inputProps?: unknown;
+    fps: number;
+    errorFallback?: ErrorFallback;
+    renderLoading?: RenderLoading;
+    className?: string;
+};
+export declare const ThumbnailFn: <T>({ frameToDisplay, style, inputProps, compositionHeight, compositionWidth, durationInFrames, fps, className, errorFallback, renderLoading, ...componentProps }: ThumbnailProps<T>, ref: MutableRefObject<ThumbnailMethods>) => JSX.Element;
+export declare const Thumbnail: <T>(props: ThumbnailProps<T> & import("react").RefAttributes<ThumbnailMethods>) => React.ReactElement | null;
+export {};

package/dist/esm/Thumbnail.js

@@ -0,0 +1,35 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { forwardRef, useImperativeHandle, useMemo, useRef, useState, } from 'react';
+import { Internals, random } from 'remotion';
+import { ThumbnailEmitterContext } from './emitter-context';
+import { ThumbnailEmitter } from './event-emitter';
+import { SharedPlayerContexts } from './SharedPlayerContext';
+import ThumbnailUI from './ThumbnailUI';
+export const ThumbnailFn = ({ frameToDisplay, style, inputProps, compositionHeight, compositionWidth, durationInFrames, fps, className, errorFallback = () => '⚠️', renderLoading, ...componentProps }, ref) => {
+    const [thumbnailId] = useState(() => String(random(null)));
+    const rootRef = useRef(null);
+    const timelineState = useMemo(() => {
+        return {
+            playing: false,
+            frame: frameToDisplay,
+            rootId: thumbnailId,
+            imperativePlaying: {
+                current: false,
+            },
+            playbackRate: 1,
+            setPlaybackRate: () => {
+                throw new Error('thumbnail');
+            },
+            audioAndVideoTags: { current: [] },
+        };
+    }, [frameToDisplay, thumbnailId]);
+    useImperativeHandle(ref, () => rootRef.current, []);
+    const Component = Internals.useLazyComponent(componentProps);
+    const [emitter] = useState(() => new ThumbnailEmitter());
+    const passedInputProps = useMemo(() => {
+        return inputProps !== null && inputProps !== void 0 ? inputProps : {};
+    }, [inputProps]);
+    return (_jsx(Internals.IsPlayerContextProvider, { children: _jsx(SharedPlayerContexts, { timelineContext: timelineState, component: Component, compositionHeight: compositionHeight, compositionWidth: compositionWidth, durationInFrames: durationInFrames, fps: fps, inputProps: inputProps, numberOfSharedAudioTags: 0, children: _jsx(ThumbnailEmitterContext.Provider, { value: emitter, children: _jsx(ThumbnailUI, { className: className, errorFallback: errorFallback, inputProps: passedInputProps, renderLoading: renderLoading, style: style }) }) }) }));
+};
+const forward = forwardRef;
+export const Thumbnail = forward(ThumbnailFn);

package/dist/esm/ThumbnailUI.d.ts

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