@remotion/player 4.0.0-alpha.217 → 4.0.0-alpha4

package/dist/cjs/Player.d.ts

@@ -1,7 +1,6 @@
 import type { ComponentType } from 'react';
 import React from 'react';
 import type { CompProps } from 'remotion';
-import type { z } from 'zod';
 import type { PlayerRef } from './player-methods.js';
 import type { RenderFullscreenButton, RenderPlayPauseButton } from './PlayerControls.js';
 import type { RenderLoading, RenderPoster } from './PlayerUI.js';
@@ -9,7 +8,7 @@ import type { PropsIfHasProps } from './utils/props-if-has-props.js';
 export declare type ErrorFallback = (info: {
     error: Error;
 }) => React.ReactNode;
-export declare type PlayerProps<Schema extends z.ZodTypeAny, Props> = {
+export declare type PlayerProps<T> = {
     durationInFrames: number;
     compositionWidth: number;
     compositionHeight: number;
@@ -40,12 +39,11 @@ export declare type PlayerProps<Schema extends z.ZodTypeAny, Props> = {
     renderPlayPauseButton?: RenderPlayPauseButton;
     renderFullscreenButton?: RenderFullscreenButton;
     alwaysShowControls?: boolean;
-    schema?: Schema;
     initiallyMuted?: boolean;
-} & CompProps<Props> & PropsIfHasProps<Schema, Props>;
-export declare const componentOrNullIfLazy: <Props>(props: CompProps<Props>) => ComponentType<Props> | null;
+} & PropsIfHasProps<T> & CompProps<T>;
+export declare const componentOrNullIfLazy: <T>(props: CompProps<T>) => ComponentType<T> | null;
 /**
  * @description A component which can be rendered in a regular React App (for example: Create React App, Next.js) to display a Remotion video.
  * @see [Documentation](https://www.remotion.dev/docs/player/player)
  */
-export declare const Player: <Schema extends z.ZodTypeAny, Props>(props: PlayerProps<Schema, Props> & React.RefAttributes<PlayerRef>) => React.ReactElement | null;
+export declare const Player: <T>(props: PlayerProps<T> & React.RefAttributes<PlayerRef>) => React.ReactElement | null;

package/dist/cjs/Player.js

@@ -106,7 +106,7 @@ const PlayerFn = ({ durationInFrames, compositionHeight, compositionWidth, fps,
     }
     (0, validate_playbackrate_js_1.validatePlaybackRate)(playbackRate);
     (0, react_1.useEffect)(() => {
-        emitter.dispatchRatechange(playbackRate);
+        emitter.dispatchRateChange(playbackRate);
     }, [emitter, playbackRate]);
     (0, react_1.useImperativeHandle)(ref, () => rootRef.current, []);
     const timelineContextValue = (0, react_1.useMemo)(() => {

package/dist/cjs/PlayerUI.js

@@ -128,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,
                 });
             }
@@ -158,6 +158,14 @@ 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.useImperativeHandle)(ref, () => {
@@ -201,6 +209,7 @@ const PlayerUI = ({ controls, style, loop, autoPlay, allowFullscreen, inputProps
                     throw new TypeError(`setVolume() got a number that is out of range. Must be between 0 and 1, got ${typeof vol}`);
                 }
                 setMediaVolume(vol);
+                player.emitter.dispatchVolumeChange(vol);
             },
             isMuted: () => mediaMuted || mediaVolume === 0,
             mute: () => {

package/dist/cjs/SharedPlayerContext.js

@@ -22,7 +22,6 @@ const SharedPlayerContexts = ({ children, timelineContext, inputProps, fps, comp
                     folderName: null,
                     defaultProps: undefined,
                     parentFolderName: null,
-                    schema: null,
                 },
             ],
             folders: [],

package/dist/cjs/Thumbnail.d.ts

@@ -1,24 +1,24 @@
 import type { CSSProperties, MutableRefObject } from 'react';
 import type { CompProps } from 'remotion';
-import type { z } 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';
-declare type ThumbnailProps<Schema extends z.ZodTypeAny, Props> = PropsIfHasProps<Schema, Props> & CompProps<Schema> & {
+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: <Schema extends z.ZodTypeAny, Props>({ frameToDisplay, style, inputProps, compositionHeight, compositionWidth, durationInFrames, fps, className, errorFallback, renderLoading, ...componentProps }: ThumbnailProps<Schema, Props>, ref: MutableRefObject<ThumbnailMethods>) => JSX.Element;
+export declare const ThumbnailFn: <T>({ frameToDisplay, style, inputProps, compositionHeight, compositionWidth, durationInFrames, fps, className, errorFallback, renderLoading, ...componentProps }: ThumbnailProps<T>, 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 z.ZodTypeAny, Props>(props: ThumbnailProps<Schema, Props> & import("react").RefAttributes<ThumbnailMethods>) => React.ReactElement | null;
+export declare const Thumbnail: <T>(props: ThumbnailProps<T> & import("react").RefAttributes<ThumbnailMethods>) => React.ReactElement | null;
 export {};

package/dist/cjs/event-emitter.d.ts

@@ -13,6 +13,12 @@ declare type FrameUpdateEventPayload = {
 declare type RateChangeEventPayload = {
     playbackRate: number;
 };
+declare type ScaleChangeEventPayload = {
+    scale: number;
+};
+declare type VolumeChangeEventPayload = {
+    volume: number;
+};
 declare type FullscreenChangeEventPayload = {
     isFullscreen: boolean;
 };
@@ -21,6 +27,8 @@ declare type PlayerStateEventMap = {
     pause: undefined;
     play: undefined;
     ratechange: RateChangeEventPayload;
+    scalechange: ScaleChangeEventPayload;
+    volumechange: VolumeChangeEventPayload;
     ended: undefined;
     error: ErrorPayload;
     timeupdate: TimeUpdateEventPayload;
@@ -47,14 +55,16 @@ export declare class PlayerEmitter {
     removeEventListener<Q extends PlayerEventTypes>(name: Q, callback: CallbackListener<Q>): void;
     private dispatchEvent;
     dispatchSeek(frame: number): void;
+    dispatchVolumeChange(volume: number): void;
     dispatchPause(): void;
     dispatchPlay(): void;
     dispatchEnded(): void;
-    dispatchRatechange(playbackRate: number): void;
+    dispatchRateChange(playbackRate: number): void;
+    dispatchScaleChange(scale: number): void;
     dispatchError(error: Error): void;
     dispatchTimeUpdate(event: TimeUpdateEventPayload): void;
     dispatchFrameUpdate(event: FrameUpdateEventPayload): void;
-    dispatchFullscreenChangeUpdate(event: FullscreenChangeEventPayload): void;
+    dispatchFullscreenChange(event: FullscreenChangeEventPayload): void;
 }
 export declare class ThumbnailEmitter {
     listeners: ThumbnailListeners;

package/dist/cjs/event-emitter.js

@@ -9,10 +9,12 @@ class PlayerEmitter {
             pause: [],
             play: [],
             ratechange: [],
+            scalechange: [],
             seeked: [],
             timeupdate: [],
             frameupdate: [],
             fullscreenchange: [],
+            volumechange: [],
         };
     }
     addEventListener(name, callback) {
@@ -31,6 +33,11 @@ class PlayerEmitter {
             frame,
         });
     }
+    dispatchVolumeChange(volume) {
+        this.dispatchEvent('volumechange', {
+            volume,
+        });
+    }
     dispatchPause() {
         this.dispatchEvent('pause', undefined);
     }
@@ -40,11 +47,16 @@ class PlayerEmitter {
     dispatchEnded() {
         this.dispatchEvent('ended', undefined);
     }
-    dispatchRatechange(playbackRate) {
+    dispatchRateChange(playbackRate) {
         this.dispatchEvent('ratechange', {
             playbackRate,
         });
     }
+    dispatchScaleChange(scale) {
+        this.dispatchEvent('scalechange', {
+            scale,
+        });
+    }
     dispatchError(error) {
         this.dispatchEvent('error', {
             error,
@@ -56,7 +68,7 @@ class PlayerEmitter {
     dispatchFrameUpdate(event) {
         this.dispatchEvent('frameupdate', event);
     }
-    dispatchFullscreenChangeUpdate(event) {
+    dispatchFullscreenChange(event) {
         this.dispatchEvent('fullscreenchange', event);
     }
 }

package/dist/cjs/is-backgrounded.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const useIsBackgrounded: () => import("react").MutableRefObject<boolean>;

package/dist/cjs/is-backgrounded.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useIsBackgrounded = void 0;
+const react_1 = require("react");
+const getIsBackgrounded = () => {
+    if (typeof document === 'undefined') {
+        return false;
+    }
+    return document.visibilityState === 'hidden';
+};
+const useIsBackgrounded = () => {
+    const isBackgrounded = (0, react_1.useRef)(getIsBackgrounded());
+    (0, react_1.useEffect)(() => {
+        const onVisibilityChange = () => {
+            isBackgrounded.current = getIsBackgrounded();
+        };
+        document.addEventListener('visibilitychange', onVisibilityChange);
+        return () => {
+            document.removeEventListener('visibilitychange', onVisibilityChange);
+        };
+    }, []);
+    return isBackgrounded;
+};
+exports.useIsBackgrounded = useIsBackgrounded;

package/dist/cjs/player-methods.d.ts

@@ -12,7 +12,7 @@ export declare type PlayerMethods = ThumbnailMethods & {
     getCurrentFrame: () => number;
     requestFullscreen: () => void;
     exitFullscreen: () => void;
-    isFullscreen: () => void;
+    isFullscreen: () => boolean;
     setVolume: (num: number) => void;
     getVolume: () => number;
     isMuted: () => boolean;

package/dist/cjs/test/validate-prop.test.js

@@ -57,7 +57,7 @@ const test_utils_js_1 = require("./test-utils.js");
 });
 (0, vitest_1.test)('Invalid playbackRate should give error', () => {
     try {
-        (0, test_utils_js_1.render)((0, jsx_runtime_1.jsx)(index_js_1.Player, { compositionWidth: 500, compositionHeight: 400, fps: 30, durationInFrames: 500, component: test_utils_js_1.HelloWorld, controls: true, showVolumeControls: true, playbackRate: -5, inputProps: {} }));
+        (0, test_utils_js_1.render)((0, jsx_runtime_1.jsx)(index_js_1.Player, { compositionWidth: 500, compositionHeight: 400, fps: 30, durationInFrames: 500, component: test_utils_js_1.HelloWorld, controls: true, showVolumeControls: true, playbackRate: -5 }));
     }
     catch (e) {
         (0, vitest_1.expect)(e.message).toMatch(/The lowest possible playback rate is -4. You passed: -5/);

package/dist/cjs/use-playback.js

@@ -4,12 +4,17 @@ exports.usePlayback = void 0;
 const react_1 = require("react");
 const remotion_1 = require("remotion");
 const calculate_next_frame_js_1 = require("./calculate-next-frame.js");
+const is_backgrounded_js_1 = require("./is-backgrounded.js");
 const use_player_js_1 = require("./use-player.js");
 const usePlayback = ({ loop, playbackRate, moveToBeginningWhenEnded, inFrame, outFrame, }) => {
     const frame = remotion_1.Internals.Timeline.useTimelinePosition();
     const config = remotion_1.Internals.useUnsafeVideoConfig();
     const { playing, pause, emitter } = (0, use_player_js_1.usePlayer)();
     const setFrame = remotion_1.Internals.Timeline.useTimelineSetFrame();
+    // requestAnimationFrame() does not work if the tab is not active.
+    // This means that audio will keep playing even if it has ended.
+    // In that case, we use setTimeout() instead.
+    const isBackgroundedRef = (0, is_backgrounded_js_1.useIsBackgrounded)();
     const frameRef = (0, react_1.useRef)(frame);
     frameRef.current = frame;
     const lastTimeUpdateEvent = (0, react_1.useRef)(null);
@@ -24,12 +29,20 @@ const usePlayback = ({ loop, playbackRate, moveToBeginningWhenEnded, inFrame, ou
         let reqAnimFrameCall = null;
         const startedTime = performance.now();
         let framesAdvanced = 0;
-        const stop = () => {
-            hasBeenStopped = true;
+        const cancelQueuedFrame = () => {
             if (reqAnimFrameCall !== null) {
-                cancelAnimationFrame(reqAnimFrameCall);
+                if (reqAnimFrameCall.type === 'raf') {
+                    cancelAnimationFrame(reqAnimFrameCall.id);
+                }
+                else {
+                    clearTimeout(reqAnimFrameCall.id);
+                }
             }
         };
+        const stop = () => {
+            hasBeenStopped = true;
+            cancelQueuedFrame();
+        };
         const callback = () => {
             const time = performance.now() - startedTime;
             const actualLastFrame = outFrame !== null && outFrame !== void 0 ? outFrame : config.durationInFrames - 1;
@@ -56,11 +69,34 @@ const usePlayback = ({ loop, playbackRate, moveToBeginningWhenEnded, inFrame, ou
                 return;
             }
             if (!hasBeenStopped) {
-                reqAnimFrameCall = requestAnimationFrame(callback);
+                queueNextFrame();
+            }
+        };
+        const queueNextFrame = () => {
+            if (isBackgroundedRef.current) {
+                reqAnimFrameCall = {
+                    type: 'timeout',
+                    // Note: Most likely, this will not be 1000 / fps, but the browser will throttle it to ~1/sec.
+                    id: setTimeout(callback, 1000 / config.fps),
+                };
+            }
+            else {
+                reqAnimFrameCall = { type: 'raf', id: requestAnimationFrame(callback) };
+            }
+        };
+        queueNextFrame();
+        const onVisibilityChange = () => {
+            if (document.visibilityState === 'visible') {
+                return;
             }
+            // If tab goes into the background, cancel requestAnimationFrame() and update immediately.
+            // , so the transition to setTimeout() can be fulfilled.
+            cancelQueuedFrame();
+            callback();
         };
-        reqAnimFrameCall = requestAnimationFrame(callback);
+        window.addEventListener('visibilitychange', onVisibilityChange);
         return () => {
+            window.removeEventListener('visibilitychange', onVisibilityChange);
             stop();
         };
     }, [
@@ -74,6 +110,7 @@ const usePlayback = ({ loop, playbackRate, moveToBeginningWhenEnded, inFrame, ou
         inFrame,
         outFrame,
         moveToBeginningWhenEnded,
+        isBackgroundedRef,
     ]);
     (0, react_1.useEffect)(() => {
         const interval = setInterval(() => {

package/dist/cjs/utils/props-if-has-props.d.ts

@@ -1,10 +1,5 @@
-import type { z } from 'zod';
-export declare type PropsIfHasProps<Schema extends z.ZodTypeAny, Props> = z.ZodTypeAny extends Schema ? {} extends Props ? {
-    inputProps?: z.infer<Schema> & Props;
+export declare type PropsIfHasProps<Props> = {} extends Props ? {
+    inputProps?: Props;
 } : {
     inputProps: Props;
-} : {} extends Props ? {
-    inputProps: z.infer<Schema>;
-} : {
-    inputProps: z.infer<Schema> & Props;
 };

package/dist/esm/Player.d.ts

@@ -1,7 +1,6 @@
 import type { ComponentType } from 'react';
 import React from 'react';
 import type { CompProps } from 'remotion';
-import type { z } from 'zod';
 import type { PlayerRef } from './player-methods.js';
 import type { RenderFullscreenButton, RenderPlayPauseButton } from './PlayerControls.js';
 import type { RenderLoading, RenderPoster } from './PlayerUI.js';
@@ -9,7 +8,7 @@ import type { PropsIfHasProps } from './utils/props-if-has-props.js';
 export declare type ErrorFallback = (info: {
     error: Error;
 }) => React.ReactNode;
-export declare type PlayerProps<Schema extends z.ZodTypeAny, Props> = {
+export declare type PlayerProps<T> = {
     durationInFrames: number;
     compositionWidth: number;
     compositionHeight: number;
@@ -40,12 +39,11 @@ export declare type PlayerProps<Schema extends z.ZodTypeAny, Props> = {
     renderPlayPauseButton?: RenderPlayPauseButton;
     renderFullscreenButton?: RenderFullscreenButton;
     alwaysShowControls?: boolean;
-    schema?: Schema;
     initiallyMuted?: boolean;
-} & CompProps<Props> & PropsIfHasProps<Schema, Props>;
-export declare const componentOrNullIfLazy: <Props>(props: CompProps<Props>) => ComponentType<Props> | null;
+} & PropsIfHasProps<T> & CompProps<T>;
+export declare const componentOrNullIfLazy: <T>(props: CompProps<T>) => ComponentType<T> | null;
 /**
  * @description A component which can be rendered in a regular React App (for example: Create React App, Next.js) to display a Remotion video.
  * @see [Documentation](https://www.remotion.dev/docs/player/player)
  */
-export declare const Player: <Schema extends z.ZodTypeAny, Props>(props: PlayerProps<Schema, Props> & React.RefAttributes<PlayerRef>) => React.ReactElement | null;
+export declare const Player: <T>(props: PlayerProps<T> & React.RefAttributes<PlayerRef>) => React.ReactElement | null;

package/dist/esm/Thumbnail.d.ts

@@ -1,24 +1,24 @@
 import type { CSSProperties, MutableRefObject } from 'react';
 import type { CompProps } from 'remotion';
-import type { z } 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';
-declare type ThumbnailProps<Schema extends z.ZodTypeAny, Props> = PropsIfHasProps<Schema, Props> & CompProps<Schema> & {
+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: <Schema extends z.ZodTypeAny, Props>({ frameToDisplay, style, inputProps, compositionHeight, compositionWidth, durationInFrames, fps, className, errorFallback, renderLoading, ...componentProps }: ThumbnailProps<Schema, Props>, ref: MutableRefObject<ThumbnailMethods>) => JSX.Element;
+export declare const ThumbnailFn: <T>({ frameToDisplay, style, inputProps, compositionHeight, compositionWidth, durationInFrames, fps, className, errorFallback, renderLoading, ...componentProps }: ThumbnailProps<T>, 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 z.ZodTypeAny, Props>(props: ThumbnailProps<Schema, Props> & import("react").RefAttributes<ThumbnailMethods>) => React.ReactElement | null;
+export declare const Thumbnail: <T>(props: ThumbnailProps<T> & import("react").RefAttributes<ThumbnailMethods>) => React.ReactElement | null;
 export {};

package/dist/esm/event-emitter.d.ts

@@ -13,6 +13,12 @@ declare type FrameUpdateEventPayload = {
 declare type RateChangeEventPayload = {
     playbackRate: number;
 };
+declare type ScaleChangeEventPayload = {
+    scale: number;
+};
+declare type VolumeChangeEventPayload = {
+    volume: number;
+};
 declare type FullscreenChangeEventPayload = {
     isFullscreen: boolean;
 };
@@ -21,6 +27,8 @@ declare type PlayerStateEventMap = {
     pause: undefined;
     play: undefined;
     ratechange: RateChangeEventPayload;
+    scalechange: ScaleChangeEventPayload;
+    volumechange: VolumeChangeEventPayload;
     ended: undefined;
     error: ErrorPayload;
     timeupdate: TimeUpdateEventPayload;
@@ -47,14 +55,16 @@ export declare class PlayerEmitter {
     removeEventListener<Q extends PlayerEventTypes>(name: Q, callback: CallbackListener<Q>): void;
     private dispatchEvent;
     dispatchSeek(frame: number): void;
+    dispatchVolumeChange(volume: number): void;
     dispatchPause(): void;
     dispatchPlay(): void;
     dispatchEnded(): void;
-    dispatchRatechange(playbackRate: number): void;
+    dispatchRateChange(playbackRate: number): void;
+    dispatchScaleChange(scale: number): void;
     dispatchError(error: Error): void;
     dispatchTimeUpdate(event: TimeUpdateEventPayload): void;
     dispatchFrameUpdate(event: FrameUpdateEventPayload): void;
-    dispatchFullscreenChangeUpdate(event: FullscreenChangeEventPayload): void;
+    dispatchFullscreenChange(event: FullscreenChangeEventPayload): void;
 }
 export declare class ThumbnailEmitter {
     listeners: ThumbnailListeners;

package/dist/esm/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 import type { CallbackListener, PlayerEventTypes } from './event-emitter.js';
 import { PlayerEmitter } from './event-emitter.js';
 export { Player, PlayerProps } from './Player.js';