remotion - npm Package Compare versions

Comparing version 4.0.244 to 4.0.245

dist/cjs/AbsoluteFill.d.ts

 import React from 'react';
-/**
- * @description An absolutely positioned <div> element with 100% width, height, and a column flex style
- * @see [Documentation](https://www.remotion.dev/docs/absolute-fill)
- */
 export declare const AbsoluteFill: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;

dist/cjs/AbsoluteFill.js

@@ -24,6 +24,6 @@ "use strict";
 };
-/**
- * @description An absolutely positioned <div> element with 100% width, height, and a column flex style
- * @see [Documentation](https://www.remotion.dev/docs/absolute-fill)
+/*
+ * @description A helper component which renders an absolutely positioned <div> element with full width, height, and flex display suited for content layering.
+ * @see [Documentation](https://remotion.dev/docs/absolute-fill)
  */
 exports.AbsoluteFill = (0, react_1.forwardRef)(AbsoluteFillRefForwarding);

dist/cjs/audio/Audio.d.ts

 import React from 'react';
 import type { RemotionMainAudioProps } from './props.js';
-/**
- * @description With this component, you can add audio to your video. All audio formats which are supported by Chromium are supported by the component.
- * @see [Documentation](https://www.remotion.dev/docs/audio)
- */
 export declare const Audio: React.ForwardRefExoticComponent<Omit<Omit<React.DetailedHTMLProps<React.AudioHTMLAttributes<HTMLAudioElement>, HTMLAudioElement>, "nonce" | "onEnded" | "onResize" | "onResizeCapture" | "autoPlay" | "controls"> & {
@@ -8,0 +4,0 @@ name?: string;

dist/cjs/audio/Audio.js

@@ -78,7 +78,7 @@ "use strict";
 };
-/**
+/*
  * @description With this component, you can add audio to your video. All audio formats which are supported by Chromium are supported by the component.
- * @see [Documentation](https://www.remotion.dev/docs/audio)
+ * @see [Documentation](https://remotion.dev/docs/audio)
  */
 exports.Audio = (0, react_1.forwardRef)(AudioRefForwardingFunction);
 (0, enable_sequence_stack_traces_js_1.addSequenceStackTraces)(exports.Audio);

dist/cjs/cancel-render.d.ts

@@ -1,5 +0,1 @@
-/**
- * @description When you invoke this function, Remotion will stop rendering all the frames without any retries
- * @see [Documentation](https://www.remotion.dev/docs/cancel-render)
- */
 export declare function cancelRender(err: unknown): never;

dist/cjs/cancel-render.js

@@ -32,5 +32,5 @@ "use strict";
 };
-/**
- * @description When you invoke this function, Remotion will stop rendering all the frames without any retries
- * @see [Documentation](https://www.remotion.dev/docs/cancel-render)
+/*
+ * @description When you invoke this function, Remotion will stop rendering all the frames without any retries.
+ * @see [Documentation](https://remotion.dev/docs/cancel-render)
  */
@@ -37,0 +37,0 @@ function cancelRender(err) {

dist/cjs/Composition.d.ts

@@ -54,7 +54,3 @@ import type { ComponentType } from 'react';
 } & CompositionCalculateMetadataOrExplicit<Schema, Props> & CompProps<Props> & PropsIfHasProps<Schema, Props>;
-/**
- * @description This component is used to register a video to make it renderable and make it show in the sidebar, in dev mode.
- * @see [Documentation](https://www.remotion.dev/docs/composition)
- */
 export declare const Composition: <Schema extends AnyZodObject, Props extends Record<string, unknown>>({ width, height, fps, durationInFrames, id, defaultProps, schema, ...compProps }: CompositionProps<Schema, Props>) => React.ReactPortal | null;
 export {};

dist/cjs/Composition.js

@@ -29,5 +29,5 @@ "use strict";
 };
-/**
+/*
  * @description This component is used to register a video to make it renderable and make it show in the sidebar, in dev mode.
- * @see [Documentation](https://www.remotion.dev/docs/composition)
+ * @see [Documentation](https://remotion.dev/docs/composition)
  */
@@ -34,0 +34,0 @@ const Composition = ({ width, height, fps, durationInFrames, id, defaultProps, schema, ...compProps }) => {

dist/cjs/delay-render.d.ts

@@ -8,14 +8,3 @@ export declare const DELAY_RENDER_CALLSTACK_TOKEN = "The delayRender was called:";
 };
-/**
- * @description Call this function to tell Remotion to wait before capturing this frame until data has loaded. Use continueRender() to unblock the render.
- * @param label _optional_ A label to identify the call in case it does time out.
- * @returns {number} An identifier to be passed to continueRender().
- * @see [Documentation](https://www.remotion.dev/docs/delay-render)
- */
 export declare const delayRender: (label?: string, options?: DelayRenderOptions) => number;
-/**
- * @description Unblock a render that has been blocked by delayRender()
- * @param handle The return value of delayRender().
- * @see [Documentation](https://www.remotion.dev/docs/continue-render)
- */
 export declare const continueRender: (handle: number) => void;

dist/cjs/delay-render.js

@@ -18,7 +18,5 @@ "use strict";
 const defaultTimeout = 30000;
-/**
- * @description Call this function to tell Remotion to wait before capturing this frame until data has loaded. Use continueRender() to unblock the render.
- * @param label _optional_ A label to identify the call in case it does time out.
- * @returns {number} An identifier to be passed to continueRender().
- * @see [Documentation](https://www.remotion.dev/docs/delay-render)
+/*
+ * @description Call this function to signal that a frame should not be rendered until an asynchronous task (such as data fetching) is complete. Use continueRender(handle) to proceed with rendering once the task is complete.
+ * @see [Documentation](https://remotion.dev/docs/delay-render)
  */
@@ -65,6 +63,5 @@ const delayRender = (label, options) => {
 exports.delayRender = delayRender;
-/**
- * @description Unblock a render that has been blocked by delayRender()
- * @param handle The return value of delayRender().
- * @see [Documentation](https://www.remotion.dev/docs/continue-render)
+/*
+ * @description Unblock a render that has been blocked by delayRender().
+ * @see [Documentation](https://remotion.dev/docs/continue-render)
  */
@@ -71,0 +68,0 @@ const continueRender = (handle) => {

dist/cjs/Folder.d.ts

@@ -11,6 +11,2 @@ import type { FC } from 'react';
 export declare const FolderContext: import("react").Context<FolderContextType>;
-/**
- * @description By wrapping a <Composition /> inside a <Folder />, you can visually categorize it in your sidebar, should you have many compositions.
- * @see [Documentation](https://www.remotion.dev/docs/folder)
- */
 export declare const Folder: FC<{
@@ -17,0 +13,0 @@ readonly name: string;

dist/cjs/Folder.js

@@ -13,5 +13,5 @@ "use strict";
 });
-/**
+/*
  * @description By wrapping a <Composition /> inside a <Folder />, you can visually categorize it in your sidebar, should you have many compositions.
- * @see [Documentation](https://www.remotion.dev/docs/folder)
+ * @see [Documentation](https://remotion.dev/docs/folder)
  */
@@ -18,0 +18,0 @@ const Folder = ({ name, children }) => {

dist/cjs/freeze.d.ts

@@ -7,7 +7,3 @@ import React from 'react';
 };
-/**
- * @description This method freezes all of its children to the frame that you specify as a prop
- * @see [Documentation](https://www.remotion.dev/docs/freeze)
- */
 export declare const Freeze: React.FC<FreezeProps>;
 export {};

dist/cjs/freeze.js

@@ -10,5 +10,5 @@ "use strict";
 const use_video_config_js_1 = require("./use-video-config.js");
-/**
- * @description This method freezes all of its children to the frame that you specify as a prop
- * @see [Documentation](https://www.remotion.dev/docs/freeze)
+/*
+ * @description Freezes its children at the specified frame when rendering videos.
+ * @see [Documentation](https://remotion.dev/docs/freeze)
  */
@@ -15,0 +15,0 @@ const Freeze = ({ frame: frameToFreeze, children, active = true, }) => {

dist/cjs/get-remotion-environment.d.ts

@@ -7,6 +7,2 @@ export type RemotionEnvironment = {
 };
-/**
- * @description Provides information about the Remotion Environment
- * @see [Documentation](https://www.remotion.dev/docs/get-remotion-environment)
- */
 export declare const getRemotionEnvironment: () => RemotionEnvironment;

dist/cjs/get-remotion-environment.js

@@ -11,5 +11,5 @@ "use strict";
 };
-/**
+/*
  * @description Provides information about the Remotion Environment
- * @see [Documentation](https://www.remotion.dev/docs/get-remotion-environment)
+ * @see [Documentation](https://remotion.dev/docs/get-remotion-environment)
  */
@@ -16,0 +16,0 @@ const getRemotionEnvironment = () => {

dist/cjs/get-static-files.d.ts

@@ -1,5 +0,1 @@
-/**
- * @description The function array containing all files in the public/ folder. You can reference them by using staticFile().
- * @see [Documentation](https://www.remotion.dev/docs/getstaticfiles)
- */
 export declare const getStaticFiles: () => StaticFile[];
@@ -6,0 +2,0 @@ export type StaticFile = {

dist/cjs/get-static-files.js

@@ -23,5 +23,5 @@ "use strict";
 };
-/**
- * @description The function array containing all files in the public/ folder. You can reference them by using staticFile().
- * @see [Documentation](https://www.remotion.dev/docs/getstaticfiles)
+/*
+ * @description Gets an array containing all files in the `public/` folder. You can reference them by using `staticFile()`.
+ * @see [Documentation](https://remotion.dev/docs/getstaticfiles)
  */
@@ -28,0 +28,0 @@ const getStaticFiles = () => {

dist/cjs/IFrame.d.ts

 import React from 'react';
-/**
- * @description The <IFrame /> can be used like a regular <iframe> HTML tag.
- * @see [Documentation](https://www.remotion.dev/docs/iframe)
- */
 export declare const IFrame: React.ForwardRefExoticComponent<Omit<React.ClassAttributes<HTMLIFrameElement> & React.IframeHTMLAttributes<HTMLIFrameElement> & {
@@ -7,0 +3,0 @@ readonly delayRenderRetries?: number;

dist/cjs/IFrame.js

@@ -28,6 +28,6 @@ "use strict";
 };
-/**
+/*
  * @description The <IFrame /> can be used like a regular <iframe> HTML tag.
- * @see [Documentation](https://www.remotion.dev/docs/iframe)
+ * @see [Documentation](https://remotion.dev/docs/iframe)
  */
 exports.IFrame = (0, react_1.forwardRef)(IFrameRefForwarding);

dist/cjs/Img.d.ts

@@ -10,6 +10,2 @@ import React from 'react';
 };
-/**
- * @description Works just like a regular HTML img tag. When you use the <Img> tag, Remotion will ensure that the image is loaded before rendering the frame.
- * @see [Documentation](https://www.remotion.dev/docs/img)
- */
 export declare const Img: React.ForwardRefExoticComponent<Omit<ImgProps, "ref"> & React.RefAttributes<HTMLImageElement>>;

dist/cjs/Img.js

@@ -152,6 +152,6 @@ "use strict";
 };
-/**
+/*
  * @description Works just like a regular HTML img tag. When you use the <Img> tag, Remotion will ensure that the image is loaded before rendering the frame.
- * @see [Documentation](https://www.remotion.dev/docs/img)
+ * @see [Documentation](https://remotion.dev/docs/img)
  */
 exports.Img = (0, react_1.forwardRef)(ImgRefForwarding);

dist/cjs/interpolate-colors.d.ts

@@ -9,6 +9,2 @@ /**
 export declare function processColor(color: string): number;
-/**
- * @description This function allows you to map a range of values to colors using a concise syntax.
- * @see [Documentation](https://www.remotion.dev/docs/interpolate-colors)
- */
 export declare const interpolateColors: (input: number, inputRange: readonly number[], outputRange: readonly string[]) => string;

dist/cjs/interpolate-colors.js

@@ -273,6 +273,7 @@ "use strict";
             // b
+            // a
             ((parse255(match[1]) << 24) | // r
                 (parse255(match[2]) << 16) | // g
                 (parse255(match[3]) << 8) |
-                0x000000ff) >>> // a
+                0x000000ff) >>>
                 0);
@@ -285,6 +286,7 @@ }
             // b
+            // a
             ((parse255(match[1]) << 24) | // r
                 (parse255(match[2]) << 16) | // g
                 (parse255(match[3]) << 8) |
-                parse1(match[4])) >>> // a
+                parse1(match[4])) >>>
                 0);
@@ -376,5 +378,5 @@ }
 };
-/**
- * @description This function allows you to map a range of values to colors using a concise syntax.
- * @see [Documentation](https://www.remotion.dev/docs/interpolate-colors)
+/*
+ * @description Allows you to map a range of values to colors using a concise syntax.
+ * @see [Documentation](https://remotion.dev/docs/interpolate-colors)
  */
@@ -381,0 +383,0 @@ const interpolateColors = (input, inputRange, outputRange) => {

dist/cjs/interpolate.d.ts

@@ -12,13 +12,2 @@ export type ExtrapolateType = 'extend' | 'identity' | 'clamp' | 'wrap';
 }>;
-/**
- * Map a value from an input range to an output range.
- * @link https://www.remotion.dev/docs/interpolate
- * @param {!number} input value to interpolate
- * @param {!number[]} inputRange range of values that you expect the input to assume.
- * @param {!number[]} outputRange range of output values that you want the input to map to.
- * @param {?object} options
- * @param {?Function} options.easing easing function which allows you to customize the input, for example to apply a certain easing function. By default, the input is left unmodified, resulting in a pure linear interpolation {@link https://www.remotion.dev/docs/easing}
- * @param {string=} [options.extrapolateLeft="extend"] What should happen if the input value is outside left the input range, default: "extend" {@link https://www.remotion.dev/docs/interpolate#extrapolateleft}
- * @param {string=} [options.extrapolateRight="extend"] Same as extrapolateLeft, except for values outside right the input range {@link https://www.remotion.dev/docs/interpolate#extrapolateright}
- */
 export declare function interpolate(input: number, inputRange: readonly number[], outputRange: readonly number[], options?: InterpolateOptions): number;

dist/cjs/interpolate.js

@@ -80,12 +80,5 @@ "use strict";
 }
-/**
- * Map a value from an input range to an output range.
- * @link https://www.remotion.dev/docs/interpolate
- * @param {!number} input value to interpolate
- * @param {!number[]} inputRange range of values that you expect the input to assume.
- * @param {!number[]} outputRange range of output values that you want the input to map to.
- * @param {?object} options
- * @param {?Function} options.easing easing function which allows you to customize the input, for example to apply a certain easing function. By default, the input is left unmodified, resulting in a pure linear interpolation {@link https://www.remotion.dev/docs/easing}
- * @param {string=} [options.extrapolateLeft="extend"] What should happen if the input value is outside left the input range, default: "extend" {@link https://www.remotion.dev/docs/interpolate#extrapolateleft}
- * @param {string=} [options.extrapolateRight="extend"] Same as extrapolateLeft, except for values outside right the input range {@link https://www.remotion.dev/docs/interpolate#extrapolateright}
+/*
+ * @description Allows you to map a range of values to another using a concise syntax.
+ * @see [Documentation](https://remotion.dev/docs/interpolate)
  */
@@ -92,0 +85,0 @@ function interpolate(input, inputRange, outputRange, options) {

dist/cjs/loop/index.d.ts

@@ -14,6 +14,2 @@ import React from 'react';
 declare const useLoop: () => LoopContextType | null;
-/**
- * @description This component allows you to quickly lay out an animation so it repeats itself.
- * @see [Documentation](https://www.remotion.dev/docs/loop)
- */
 export declare const Loop: React.FC<LoopProps> & {
@@ -20,0 +16,0 @@ useLoop: typeof useLoop;

dist/cjs/loop/index.js

@@ -37,5 +37,5 @@ "use strict";
 };
-/**
+/*
  * @description This component allows you to quickly lay out an animation so it repeats itself.
- * @see [Documentation](https://www.remotion.dev/docs/loop)
+ * @see [Documentation](https://remotion.dev/docs/loop)
  */
@@ -42,0 +42,0 @@ const Loop = ({ durationInFrames, times = Infinity, children, name, ...props }) => {

dist/cjs/prefetch.d.ts

@@ -10,6 +10,2 @@ export declare const usePreload: (src: string) => string;
 }) => void;
-/**
- * @description When you call the preFetch() function, an asset will be fetched and kept in memory so it is ready when you want to play it in a <Player>.
- * @see [Documentation](https://www.remotion.dev/docs/prefetch)
- */
 export declare const prefetch: (src: string, options?: {
@@ -16,0 +12,0 @@ method?: "blob-url" | "base64";

dist/cjs/prefetch.js

@@ -50,4 +50,4 @@ "use strict";
 };
-/**
- * @description When you call the preFetch() function, an asset will be fetched and kept in memory so it is ready when you want to play it in a <Player>.
+/*
+ * @description When you call the prefetch() function, an asset will be fetched and kept in memory so it is ready when you want to play it in a <Player>.
  * @see [Documentation](https://www.remotion.dev/docs/prefetch)
@@ -54,0 +54,0 @@ */

dist/cjs/random.d.ts

 export type RandomSeed = number | string | null;
-/**
- * @description A deterministic pseudo-random number generator. Pass in the same seed and get the same pseudorandom number.
- * @see [Documentation](https://remotion.dev/docs/random)
- */
 export declare const random: (seed: RandomSeed, dummy?: unknown) => number;

dist/cjs/random.js

@@ -21,5 +21,5 @@ "use strict";
 }
-/**
+/*
  * @description A deterministic pseudo-random number generator. Pass in the same seed and get the same pseudorandom number.
- * @see [Documentation](https://remotion.dev/docs/random)
+ * @see [Documentation](https://www.remotion.dev/docs/random)
  */
@@ -26,0 +26,0 @@ const random = (seed, dummy) => {

dist/cjs/register-root.d.ts

 import type React from 'react';
-/**
- * @description This function registers the root component of the Remotion project
- * @see [Documentation](https://www.remotion.dev/docs/register-root)
- */
 export declare const registerRoot: (comp: React.FC) => void;
 export declare const getRoot: () => React.FC<{}> | null;
 export declare const waitForRoot: (fn: (comp: React.FC) => void) => (() => void);

dist/cjs/register-root.js

@@ -6,4 +6,4 @@ "use strict";
 let listeners = [];
-/**
- * @description This function registers the root component of the Remotion project
+/*
+ * @description Registers the root component of the Remotion project.
  * @see [Documentation](https://www.remotion.dev/docs/register-root)
@@ -10,0 +10,0 @@ */

dist/cjs/Sequence.d.ts

@@ -39,6 +39,2 @@ import React from 'react';
 } & SequencePropsWithoutDuration;
-/**
- * @description A component that time-shifts its children and wraps them in an absolutely positioned <div>.
- * @see [Documentation](https://www.remotion.dev/docs/sequence)
- */
 export declare const Sequence: React.ForwardRefExoticComponent<SequenceProps & React.RefAttributes<HTMLDivElement>>;

dist/cjs/Sequence.js

@@ -176,3 +176,3 @@ "use strict";
 };
-/**
+/*
  * @description A component that time-shifts its children and wraps them in an absolutely positioned <div>.
@@ -179,0 +179,0 @@ * @see [Documentation](https://www.remotion.dev/docs/sequence)

dist/cjs/spring/index.d.ts

 import type { SpringConfig } from './spring-utils';
-/**
- * @description Calculates a position based on physical parameters, start and end value, and time.
- * @see [Documentation](https://www.remotion.dev/docs/spring)
- * @param {number} frame The current time value. Most of the time you want to pass in the return value of useCurrentFrame.
- * @param {number} fps The framerate at which the animation runs. Pass in the value obtained by `useVideoConfig()`.
- * @param {?boolean} reverse Whether the animation plays in reverse or not. Default `false`.
- * @param {?Object} config optional object that allows you to customize the physical properties of the animation.
- * @param {number} [config.mass=1] The weight of the spring. If you reduce the mass, the animation becomes faster!
- * @param {number} [config.damping=10] How hard the animation decelerates.
- * @param {number} [config.stiffness=100] Affects bounciness of the animation.
- * @param {boolean} [config.overshootClamping=false] Whether to prevent the animation going beyond the target value.
- * @param {?number} [config.from] The initial value of the animation. Default `0`
- * @param {?number} [config.to] The end value of the animation. Default `1`
- * @param {?number} [config.durationInFrames] Stretch the duration of an animation to  a set value.. Default `undefined`
- * @param {?number} [config.durationThreshold] How close to the end the animation is considered to be done. Default `0.005`
- * @param {?number} [config.delay] Delay the animation for this amount of frames. Default `0`
- */
 export declare function spring({ frame: passedFrame, fps, config, from, to, durationInFrames: passedDurationInFrames, durationRestThreshold, delay, reverse, }: {
@@ -20,0 +3,0 @@ frame: number;

dist/cjs/spring/index.js

@@ -11,18 +11,5 @@ "use strict";
 const spring_utils_js_1 = require("./spring-utils.js");
-/**
+/*
  * @description Calculates a position based on physical parameters, start and end value, and time.
  * @see [Documentation](https://www.remotion.dev/docs/spring)
- * @param {number} frame The current time value. Most of the time you want to pass in the return value of useCurrentFrame.
- * @param {number} fps The framerate at which the animation runs. Pass in the value obtained by `useVideoConfig()`.
- * @param {?boolean} reverse Whether the animation plays in reverse or not. Default `false`.
- * @param {?Object} config optional object that allows you to customize the physical properties of the animation.
- * @param {number} [config.mass=1] The weight of the spring. If you reduce the mass, the animation becomes faster!
- * @param {number} [config.damping=10] How hard the animation decelerates.
- * @param {number} [config.stiffness=100] Affects bounciness of the animation.
- * @param {boolean} [config.overshootClamping=false] Whether to prevent the animation going beyond the target value.
- * @param {?number} [config.from] The initial value of the animation. Default `0`
- * @param {?number} [config.to] The end value of the animation. Default `1`
- * @param {?number} [config.durationInFrames] Stretch the duration of an animation to  a set value.. Default `undefined`
- * @param {?number} [config.durationThreshold] How close to the end the animation is considered to be done. Default `0.005`
- * @param {?number} [config.delay] Delay the animation for this amount of frames. Default `0`
  */
@@ -29,0 +16,0 @@ function spring({ frame: passedFrame, fps, config = {}, from = 0, to = 1, durationInFrames: passedDurationInFrames, durationRestThreshold, delay = 0, reverse = false, }) {

dist/cjs/spring/measure-spring.d.ts

@@ -12,7 +12,3 @@ import type { ENABLE_V5_BREAKING_CHANGES } from '../v5-flag.js';
 } & (false extends typeof ENABLE_V5_BREAKING_CHANGES ? V4Props : {});
-/**
- * @description The function returns how long it takes for a spring animation to settle
- * @see [Documentation](https://www.remotion.dev/docs/measure-spring)
- */
 export declare function measureSpring({ fps, config, threshold, }: MeasureSpringProps): number;
 export {};

dist/cjs/spring/measure-spring.js

@@ -7,5 +7,5 @@ "use strict";
 const cache = new Map();
-/**
- * @description The function returns how long it takes for a spring animation to settle
- * @see [Documentation](https://www.remotion.dev/docs/measure-spring)
+/*
+ * @description Based on a spring() configuration and the frame rate, return how long it takes for a spring animation to settle.
+ * @see [Documentation](https://remotion.dev/docs/measure-spring)
  */
@@ -12,0 +12,0 @@ function measureSpring({ fps, config = {}, threshold = 0.005, }) {

dist/cjs/static-file.d.ts

@@ -28,7 +28,3 @@ declare const problematicCharacters: {
 export declare const includesHexOfUnsafeChar: (path: string) => HexInfo;
-/**
- * @description Reference a file from the public/ folder. If the file does not appear in the autocomplete, type the path manually.
- * @see [Documentation](https://www.remotion.dev/docs/staticfile)
- */
 export declare const staticFile: (path: string) => string;
 export {};

dist/cjs/static-file.js

@@ -64,3 +64,3 @@ "use strict";
 };
-/**
+/*
  * @description Reference a file from the public/ folder. If the file does not appear in the autocomplete, type the path manually.
@@ -67,0 +67,0 @@ * @see [Documentation](https://www.remotion.dev/docs/staticfile)

dist/cjs/Still.d.ts

 import React from 'react';
 import type { AnyZodObject } from 'zod';
 import type { StillProps } from './Composition.js';
-/**
- * @description A `<Still />` is a `<Composition />` that is only 1 frame long.
- * @see [Documentation](https://www.remotion.dev/docs/still)
- */
 export declare const Still: <Schema extends AnyZodObject, Props extends Record<string, unknown>>(props: StillProps<Schema, Props>) => React.DetailedReactHTMLElement<React.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>;

dist/cjs/Still.js

@@ -9,3 +9,3 @@ "use strict";
 const Composition_js_1 = require("./Composition.js");
-/**
+/*
  * @description A `<Still />` is a `<Composition />` that is only 1 frame long.
@@ -12,0 +12,0 @@ * @see [Documentation](https://www.remotion.dev/docs/still)

dist/cjs/use-current-frame.d.ts

@@ -1,5 +0,1 @@
-/**
- * @description Get the current frame of the video. Frames are 0-indexed, meaning the first frame is 0, the last frame is the duration of the composition in frames minus one.
- * @see [Documentation](https://remotion.dev/docs/use-current-frame)
- */
 export declare const useCurrentFrame: () => number;

dist/cjs/use-current-frame.js

@@ -9,5 +9,5 @@ "use strict";
 const timeline_position_state_js_1 = require("./timeline-position-state.js");
-/**
- * @description Get the current frame of the video. Frames are 0-indexed, meaning the first frame is 0, the last frame is the duration of the composition in frames minus one.
- * @see [Documentation](https://remotion.dev/docs/use-current-frame)
+/*
+ * @description Retrieves the current frame of the video within a component. Frames are 0-indexed, and if the component is wrapped in a `<Sequence>`, it returns the frame relative to when the Sequence starts.
+ * @see [Documentation](https://www.remotion.dev/docs/use-current-frame)
  */
@@ -14,0 +14,0 @@ const useCurrentFrame = () => {

dist/cjs/use-current-scale.d.ts

@@ -46,7 +46,3 @@ import React from 'react';
 }) => number;
-/**
- * Gets the current scale of the container in which the component is being rendered.
- * Only works in the Remotion Studio and in the Remotion Player.
- */
 export declare const useCurrentScale: (options?: Options) => number;
 export {};

dist/cjs/use-current-scale.js

@@ -42,5 +42,5 @@ "use strict";
 exports.calculateScale = calculateScale;
-/**
- * Gets the current scale of the container in which the component is being rendered.
- * Only works in the Remotion Studio and in the Remotion Player.
+/*
+ * @description Retrieves the current scale of the canvas within Remotion's Studio or Player context. In the Studio, it corresponds to the zoom level (1 equals no scaling, i.e., 100% zoom). In the Player, it indicates the scaling necessary to fit the video into the player. If called outside of a Remotion context, by default, it throws an error unless configured not to.
+ * @see [Documentation](https://www.remotion.dev/docs/use-current-scale)
  */
@@ -47,0 +47,0 @@ const useCurrentScale = (options) => {

dist/cjs/use-video-config.d.ts

 import type { VideoConfig } from './video-config.js';
-/**
- * @description Get some info about the context of the video that you are making.
- * @see [Documentation](https://www.remotion.dev/docs/use-video-config)
- * @returns Returns an object containing `fps`, `width`, `height`, `durationInFrames`, `id` and `defaultProps`.
- */
 export declare const useVideoConfig: () => VideoConfig;

dist/cjs/use-video-config.js

@@ -8,6 +8,5 @@ "use strict";
 const use_unsafe_video_config_js_1 = require("./use-unsafe-video-config.js");
-/**
- * @description Get some info about the context of the video that you are making.
+/*
+ * @description Retrieves information about the composition context in which it is used, including dimensions, frame rate, duration, and more.
  * @see [Documentation](https://www.remotion.dev/docs/use-video-config)
- * @returns Returns an object containing `fps`, `width`, `height`, `durationInFrames`, `id` and `defaultProps`.
  */
@@ -14,0 +13,0 @@ const useVideoConfig = () => {

dist/cjs/version.d.ts

@@ -6,2 +6,2 @@ /**
  */
-export declare const VERSION = "4.0.244";
+export declare const VERSION = "4.0.245";

dist/cjs/version.js

@@ -10,2 +10,2 @@ "use strict";
  */
-exports.VERSION = '4.0.244';
+exports.VERSION = '4.0.245';

dist/cjs/video/OffthreadVideo.d.ts

 import React from 'react';
 import type { OffthreadVideoProps } from './props.js';
-/**
- * @description This method imports and displays a video, similar to <Video />. During rendering, it extracts the exact frame from the video and displays it in an <img> tag
- * @see [Documentation](https://www.remotion.dev/docs/offthreadvideo)
- */
 export declare const OffthreadVideo: React.FC<OffthreadVideoProps>;

dist/cjs/video/OffthreadVideo.js

@@ -12,3 +12,3 @@ "use strict";
 const VideoForPreview_js_1 = require("./VideoForPreview.js");
-/**
+/*
  * @description This method imports and displays a video, similar to <Video />. During rendering, it extracts the exact frame from the video and displays it in an <img> tag
@@ -15,0 +15,0 @@ * @see [Documentation](https://www.remotion.dev/docs/offthreadvideo)

dist/cjs/video/Video.d.ts

 import React from 'react';
 import type { RemotionMainVideoProps } from './props';
-/**
- * @description allows you to include a video file in your Remotion project. It wraps the native HTMLVideoElement.
- * @see [Documentation](https://www.remotion.dev/docs/video)
- */
 export declare const Video: React.ForwardRefExoticComponent<Omit<Omit<React.DetailedHTMLProps<React.VideoHTMLAttributes<HTMLVideoElement>, HTMLVideoElement>, "nonce" | "onError" | "onEnded" | "autoPlay" | "controls" | "disableRemotePlayback"> & {
@@ -8,0 +4,0 @@ name?: string;

dist/cjs/video/Video.js

@@ -65,4 +65,4 @@ "use strict";
 };
-/**
- * @description allows you to include a video file in your Remotion project. It wraps the native HTMLVideoElement.
+/*
+ * @description Wraps the native `<video>` element to include video in your component that is synchronized with Remotion's time.
  * @see [Documentation](https://www.remotion.dev/docs/video)
@@ -69,0 +69,0 @@ */

dist/cjs/watch-static-file.d.ts

@@ -7,9 +7,2 @@ import type { StaticFile } from './get-static-files';
 };
-/**
- * @description Watch for changes in a specific static file.
- * @param {string} fileName - The name of the static file to watch for changes.
- * @param {WatcherCallback} callback - A callback function to be called when the file changes.
- * @returns {{cancel: () => void}} A function that can be used to cancel the event listener.
- * @see [Documentation](https://www.remotion.dev/docs/watchstaticfile)
- */
 export declare const watchStaticFile: (fileName: string, callback: WatcherCallback) => {
@@ -16,0 +9,0 @@ cancel: () => void;

dist/cjs/watch-static-file.js

@@ -7,7 +7,4 @@ "use strict";
 exports.WATCH_REMOTION_STATIC_FILES = 'remotion_staticFilesChanged';
-/**
- * @description Watch for changes in a specific static file.
- * @param {string} fileName - The name of the static file to watch for changes.
- * @param {WatcherCallback} callback - A callback function to be called when the file changes.
- * @returns {{cancel: () => void}} A function that can be used to cancel the event listener.
+/*
+ * @description Watches for changes in a specific static file and invokes a callback function when the file changes, enabling dynamic updates in your Remotion projects.
  * @see [Documentation](https://www.remotion.dev/docs/watchstaticfile)
@@ -14,0 +11,0 @@ */

LICENSE.md

@@ -14,3 +14,3 @@ # Remotion License
 
-Copyright © 2024 [Remotion](https://www.remotion.dev)
+Copyright © 2025 [Remotion](https://www.remotion.dev)
 
@@ -17,0 +17,0 @@ ### Eligibility

package.json

@@ -6,3 +6,3 @@ {
   "name": "remotion",
-  "version": "4.0.244",
+  "version": "4.0.245",
   "description": "Make videos programmatically",
@@ -33,3 +33,3 @@ "main": "dist/cjs/index.js",
     "eslint": "9.14.0",
-    "@remotion/eslint-config-internal": "4.0.244"
+    "@remotion/eslint-config-internal": "4.0.245"
   },
@@ -36,0 +36,0 @@ "keywords": [

No alert changes

Worsened metrics

Total package byte prevSize

650223

decreased by-1.57%

Lines of code

16561

decreased by-1%

No dependency changes