@remotion/player 4.0.251 → 4.0.253

package/dist/cjs/Player.d.ts

@@ -56,6 +56,7 @@ export type PlayerProps<Schema extends AnyZodObject, Props extends Record<string
     readonly browserMediaControlsBehavior?: BrowserMediaControlsBehavior;
     readonly overrideInternalClassName?: string;
     readonly logLevel?: LogLevel;
+    readonly acknowledgeRemotionLicense?: boolean;
 } & CompProps<Props> & PropsIfHasProps<Schema, Props>;
 export type PlayerPropsWithoutZod<Props extends Record<string, unknown>> = PlayerProps<AnyZodObject, Props>;
 export declare const componentOrNullIfLazy: <Props>(props: CompProps<Props>) => ComponentType<Props> | null;

package/dist/cjs/Player.js

@@ -11,6 +11,7 @@ const EmitterProvider_js_1 = require("./EmitterProvider.js");
 const PlayerUI_js_1 = __importDefault(require("./PlayerUI.js"));
 const SharedPlayerContext_js_1 = require("./SharedPlayerContext.js");
 const player_css_classname_js_1 = require("./player-css-classname.js");
+const use_remotion_license_acknowledge_js_1 = require("./use-remotion-license-acknowledge.js");
 const validate_in_out_frame_js_1 = require("./utils/validate-in-out-frame.js");
 const validate_initial_frame_js_1 = require("./utils/validate-initial-frame.js");
 const validate_playbackrate_js_1 = require("./utils/validate-playbackrate.js");
@@ -22,7 +23,7 @@ const componentOrNullIfLazy = (props) => {
     return null;
 };
 exports.componentOrNullIfLazy = componentOrNullIfLazy;
-const PlayerFn = ({ durationInFrames, compositionHeight, compositionWidth, fps, inputProps, style, controls = false, loop = false, autoPlay = false, showVolumeControls = true, allowFullscreen = true, clickToPlay, doubleClickToFullscreen = false, spaceKeyToPlayOrPause = true, moveToBeginningWhenEnded = true, numberOfSharedAudioTags = 5, errorFallback = () => '⚠️', playbackRate = 1, renderLoading, className, showPosterWhenUnplayed, showPosterWhenEnded, showPosterWhenPaused, showPosterWhenBuffering, initialFrame, renderPoster, inFrame, outFrame, initiallyShowControls, renderFullscreenButton, renderPlayPauseButton, renderVolumeSlider, alwaysShowControls = false, initiallyMuted = false, showPlaybackRateControl = false, posterFillMode = 'player-size', bufferStateDelayInMilliseconds, hideControlsWhenPointerDoesntMove = true, overflowVisible = false, renderMuteButton, browserMediaControlsBehavior: passedBrowserMediaControlsBehavior, overrideInternalClassName, logLevel = 'info', ...componentProps }, ref) => {
+const PlayerFn = ({ durationInFrames, compositionHeight, compositionWidth, fps, inputProps, style, controls = false, loop = false, autoPlay = false, showVolumeControls = true, allowFullscreen = true, clickToPlay, doubleClickToFullscreen = false, spaceKeyToPlayOrPause = true, moveToBeginningWhenEnded = true, numberOfSharedAudioTags = 5, errorFallback = () => '⚠️', playbackRate = 1, renderLoading, className, showPosterWhenUnplayed, showPosterWhenEnded, showPosterWhenPaused, showPosterWhenBuffering, initialFrame, renderPoster, inFrame, outFrame, initiallyShowControls, renderFullscreenButton, renderPlayPauseButton, renderVolumeSlider, alwaysShowControls = false, initiallyMuted = false, showPlaybackRateControl = false, posterFillMode = 'player-size', bufferStateDelayInMilliseconds, hideControlsWhenPointerDoesntMove = true, overflowVisible = false, renderMuteButton, browserMediaControlsBehavior: passedBrowserMediaControlsBehavior, overrideInternalClassName, logLevel = 'info', acknowledgeRemotionLicense, ...componentProps }, ref) => {
     if (typeof window !== 'undefined') {
         // eslint-disable-next-line react-hooks/rules-of-hooks
         (0, react_1.useLayoutEffect)(() => {
@@ -41,6 +42,7 @@ const PlayerFn = ({ durationInFrames, compositionHeight, compositionWidth, fps,
     if (componentForValidation === remotion_1.Composition) {
         throw new TypeError(`'component' must not be the 'Composition' component. Pass your own React component directly, and set the duration, fps and dimensions as separate props. See https://www.remotion.dev/docs/player/examples for an example.`);
     }
+    (0, react_1.useState)(() => (0, use_remotion_license_acknowledge_js_1.acknowledgeRemotionLicenseMessage)(Boolean(acknowledgeRemotionLicense), logLevel));
     const component = remotion_1.Internals.useLazyComponent(componentProps);
     (0, validate_initial_frame_js_1.validateInitialFrame)({ initialFrame, durationInFrames });
     const [frame, setFrame] = (0, react_1.useState)(() => ({

package/dist/cjs/use-remotion-license-acknowledge.d.ts

@@ -0,0 +1,2 @@
+import type { LogLevel } from 'remotion';
+export declare const acknowledgeRemotionLicenseMessage: (acknowledge: boolean, logLevel: LogLevel) => void;

package/dist/cjs/use-remotion-license-acknowledge.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.acknowledgeRemotionLicenseMessage = void 0;
+const remotion_1 = require("remotion");
+let warningShown = false;
+const acknowledgeRemotionLicenseMessage = (acknowledge, logLevel) => {
+    if (acknowledge) {
+        return;
+    }
+    if (warningShown) {
+        return;
+    }
+    warningShown = true;
+    remotion_1.Internals.Log.warn(logLevel, 'Note: Some companies are required to obtain a license to use Remotion. See: https://remotion.dev/license');
+    remotion_1.Internals.Log.warn(logLevel, 'Pass the `acknowledgeRemotionLicense` prop to `<Player />` function to make this message disappear.');
+};
+exports.acknowledgeRemotionLicenseMessage = acknowledgeRemotionLicenseMessage;

package/dist/esm/index.mjs

@@ -1143,7 +1143,7 @@ import {
   useRef as useRef11,
   useState as useState13
 } from "react";
-import { Composition, Internals as Internals14 } from "remotion";
+import { Composition, Internals as Internals15 } from "remotion";
 
 // src/PlayerUI.tsx
 import React10, {
@@ -2960,6 +2960,21 @@ var SharedPlayerContexts = ({
   });
 };
 
+// src/use-remotion-license-acknowledge.ts
+import { Internals as Internals14 } from "remotion";
+var warningShown = false;
+var acknowledgeRemotionLicenseMessage = (acknowledge, logLevel) => {
+  if (acknowledge) {
+    return;
+  }
+  if (warningShown) {
+    return;
+  }
+  warningShown = true;
+  Internals14.Log.warn(logLevel, "Note: Some companies are required to obtain a license to use Remotion. See: https://remotion.dev/license");
+  Internals14.Log.warn(logLevel, "Pass the `acknowledgeRemotionLicense` prop to `<Player />` function to make this message disappear.");
+};
+
 // src/utils/validate-in-out-frame.ts
 var validateSingleFrame = (frame, variableName) => {
   if (typeof frame === "undefined" || frame === null) {
@@ -3109,6 +3124,7 @@ var PlayerFn = ({
   browserMediaControlsBehavior: passedBrowserMediaControlsBehavior,
   overrideInternalClassName,
   logLevel = "info",
+  acknowledgeRemotionLicense,
   ...componentProps
 }, ref) => {
   if (typeof window !== "undefined") {
@@ -3126,7 +3142,8 @@ var PlayerFn = ({
   if (componentForValidation === Composition) {
     throw new TypeError(`'component' must not be the 'Composition' component. Pass your own React component directly, and set the duration, fps and dimensions as separate props. See https://www.remotion.dev/docs/player/examples for an example.`);
   }
-  const component = Internals14.useLazyComponent(componentProps);
+  useState13(() => acknowledgeRemotionLicenseMessage(Boolean(acknowledgeRemotionLicense), logLevel));
+  const component = Internals15.useLazyComponent(componentProps);
   validateInitialFrame({ initialFrame, durationInFrames });
   const [frame, setFrame] = useState13(() => ({
     [PLAYER_COMP_ID]: initialFrame ?? 0
@@ -3189,7 +3206,7 @@ var PlayerFn = ({
   }, [playbackRate]);
   useImperativeHandle2(ref, () => rootRef.current, []);
   useState13(() => {
-    Internals14.Log.trace(logLevel, `[player] Mounting <Player>. User agent = ${typeof navigator === "undefined" ? "server" : navigator.userAgent}`);
+    Internals15.Log.trace(logLevel, `[player] Mounting <Player>. User agent = ${typeof navigator === "undefined" ? "server" : navigator.userAgent}`);
   });
   const timelineContextValue = useMemo14(() => {
     return {
@@ -3212,7 +3229,7 @@ var PlayerFn = ({
   }, [setFrame]);
   if (typeof window !== "undefined") {
     useLayoutEffect(() => {
-      Internals14.CSSUtils.injectCSS(Internals14.CSSUtils.makeDefaultPreviewCSS(`.${playerCssClassname(overrideInternalClassName)}`, "#fff"));
+      Internals15.CSSUtils.injectCSS(Internals15.CSSUtils.makeDefaultPreviewCSS(`.${playerCssClassname(overrideInternalClassName)}`, "#fff"));
     }, [overrideInternalClassName]);
   }
   const actualInputProps = useMemo14(() => inputProps ?? {}, [inputProps]);
@@ -3221,7 +3238,7 @@ var PlayerFn = ({
       mode: "prevent-media-session"
     };
   }, [passedBrowserMediaControlsBehavior]);
-  return /* @__PURE__ */ jsx14(Internals14.IsPlayerContextProvider, {
+  return /* @__PURE__ */ jsx14(Internals15.IsPlayerContextProvider, {
     children: /* @__PURE__ */ jsx14(SharedPlayerContexts, {
       timelineContext: timelineContextValue,
       component,
@@ -3232,7 +3249,7 @@ var PlayerFn = ({
       numberOfSharedAudioTags,
       initiallyMuted,
       logLevel,
-      children: /* @__PURE__ */ jsx14(Internals14.Timeline.SetTimelineContext.Provider, {
+      children: /* @__PURE__ */ jsx14(Internals15.Timeline.SetTimelineContext.Provider, {
         value: setTimelineContextValue,
         children: /* @__PURE__ */ jsx14(PlayerEmitterProvider, {
           currentPlaybackRate,
@@ -3290,7 +3307,7 @@ import {
   useRef as useRef13,
   useState as useState14
 } from "react";
-import { Internals as Internals16, random as random2 } from "remotion";
+import { Internals as Internals17, random as random2 } from "remotion";
 
 // src/ThumbnailUI.tsx
 import React13, {
@@ -3301,7 +3318,7 @@ import React13, {
   useMemo as useMemo16,
   useRef as useRef12
 } from "react";
-import { Internals as Internals15 } from "remotion";
+import { Internals as Internals16 } from "remotion";
 
 // src/use-thumbnail.ts
 import { useContext as useContext7, useMemo as useMemo15 } from "react";
@@ -3334,8 +3351,8 @@ var ThumbnailUI = ({
   overflowVisible,
   overrideInternalClassName
 }, ref) => {
-  const config = Internals15.useUnsafeVideoConfig();
-  const video = Internals15.useVideo();
+  const config = Internals16.useUnsafeVideoConfig();
+  const video = Internals16.useVideo();
   const container = useRef12(null);
   const canvasSize = useElementSize(container, {
     triggerOnWindowResize: false,
@@ -3411,7 +3428,7 @@ var ThumbnailUI = ({
       children: VideoComponent ? /* @__PURE__ */ jsx15(ErrorBoundary, {
         onError,
         errorFallback,
-        children: /* @__PURE__ */ jsx15(Internals15.CurrentScaleContext.Provider, {
+        children: /* @__PURE__ */ jsx15(Internals16.CurrentScaleContext.Provider, {
           value: currentScaleContext,
           children: /* @__PURE__ */ jsx15(VideoComponent, {
             ...video?.props ?? {},
@@ -3485,12 +3502,12 @@ var ThumbnailFn = ({
     return value;
   }, [frameToDisplay, thumbnailId]);
   useImperativeHandle4(ref, () => rootRef.current, []);
-  const Component = Internals16.useLazyComponent(componentProps);
+  const Component = Internals17.useLazyComponent(componentProps);
   const [emitter] = useState14(() => new ThumbnailEmitter);
   const passedInputProps = useMemo17(() => {
     return inputProps ?? {};
   }, [inputProps]);
-  return /* @__PURE__ */ jsx16(Internals16.IsPlayerContextProvider, {
+  return /* @__PURE__ */ jsx16(Internals17.IsPlayerContextProvider, {
     children: /* @__PURE__ */ jsx16(SharedPlayerContexts, {
       timelineContext: timelineState,
       component: Component,

package/package.json

@@ -3,7 +3,7 @@
     "url": "https://github.com/remotion-dev/remotion/tree/main/packages/player"
   },
   "name": "@remotion/player",
-  "version": "4.0.251",
+  "version": "4.0.253",
   "description": "React component for embedding a Remotion preview into your app",
   "main": "dist/cjs/index.js",
   "types": "dist/cjs/index.d.ts",
@@ -28,7 +28,7 @@
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "remotion": "4.0.251"
+    "remotion": "4.0.253"
   },
   "peerDependencies": {
     "react": ">=16.8.0",
@@ -43,7 +43,7 @@
     "webpack": "5.96.1",
     "zod": "3.22.3",
     "eslint": "9.14.0",
-    "@remotion/eslint-config-internal": "4.0.251"
+    "@remotion/eslint-config-internal": "4.0.253"
   },
   "keywords": [
     "remotion",