remotion 3.3.53 → 3.3.55

package/dist/esm/SequenceContext.js

@@ -0,0 +1,2 @@
+import { createContext } from 'react';
+export const SequenceContext = createContext(null);

package/dist/esm/Still.js

@@ -1,5 +1,9 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { Composition } from './Composition.js';
+/**
+ * @description A <Still /> is a <Composition /> that is only 1 frame long.
+ * @see [Documentation](https://www.remotion.dev/docs/still)
+ */
 export const Still = (props) => {
     return _jsx(Composition, { fps: 1, durationInFrames: 1, ...props });
 };

package/dist/esm/audio/Audio.js

@@ -1,7 +1,7 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { forwardRef, useCallback, useContext } from 'react';
 import { useRemotionEnvironment } from '../get-environment.js';
-import { Loop } from '../loop';
+import { Loop } from '../loop/index.js';
 import { Sequence } from '../Sequence.js';
 import { useVideoConfig } from '../use-video-config.js';
 import { validateMediaProps } from '../validate-media-props.js';
@@ -46,4 +46,8 @@ const AudioRefForwardingFunction = (props, ref) => {
     }
     return (_jsx(AudioForDevelopment, { shouldPreMountAudioTags: audioContext !== null && audioContext.numberOfAudioTags > 0, ...props, ref: ref, onError: onError, onDuration: onDuration }));
 };
+/**
+ * @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 const Audio = forwardRef(AudioRefForwardingFunction);

package/dist/esm/audio/AudioForDevelopment.js

@@ -2,7 +2,7 @@ import { jsx as _jsx } from "react/jsx-runtime";
 import { forwardRef, useContext, useEffect, useImperativeHandle, useMemo, useRef, useState, } from 'react';
 import { usePreload } from '../prefetch.js';
 import { random } from '../random.js';
-import { SequenceContext } from '../Sequence.js';
+import { SequenceContext } from '../SequenceContext.js';
 import { useMediaInTimeline } from '../use-media-in-timeline.js';
 import { DEFAULT_ACCEPTABLE_TIMESHIFT, useMediaPlayback, } from '../use-media-playback.js';
 import { useMediaTagVolume } from '../use-media-tag-volume.js';

package/dist/esm/audio/AudioForRendering.js

@@ -5,7 +5,7 @@ import { CompositionManager } from '../CompositionManager.js';
 import { continueRender, delayRender } from '../delay-render.js';
 import { useRemotionEnvironment } from '../get-environment.js';
 import { random } from '../random.js';
-import { SequenceContext } from '../Sequence.js';
+import { SequenceContext } from '../SequenceContext.js';
 import { useTimelinePosition } from '../timeline-position-state.js';
 import { useCurrentFrame } from '../use-current-frame.js';
 import { evaluateVolume } from '../volume-prop.js';

package/dist/esm/audio/use-audio-frame.js

@@ -1,5 +1,5 @@
 import { useContext } from 'react';
-import { SequenceContext } from '../Sequence.js';
+import { SequenceContext } from '../SequenceContext.js';
 import { useCurrentFrame } from '../use-current-frame.js';
 export const useMediaStartsAt = () => {
     var _a;

package/dist/esm/cancel-render.js

@@ -23,6 +23,10 @@ const isErrorLike = (err) => {
     }
     return true;
 };
+/**
+ * @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 function cancelRender(err) {
     let error;
     if (isErrorLike(err)) {

package/dist/esm/delay-render.js

@@ -8,10 +8,10 @@ const timeouts = {};
 export const DELAY_RENDER_CALLSTACK_TOKEN = 'The delayRender was called:';
 const defaultTimeout = 30000;
 /**
- * Call this function to tell Remotion to wait before capturing this frame until data has loaded. Use continueRender() to unblock the render.
+ * @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().
- * @link https://www.remotion.dev/docs/delay-render
+ * @see [Documentation](https://www.remotion.dev/docs/delay-render)
  */
 export const delayRender = (label) => {
     var _a, _b, _c;
@@ -45,9 +45,9 @@ export const delayRender = (label) => {
     return handle;
 };
 /**
- * Unblock a render that has been blocked by delayRender()
+ * @description Unblock a render that has been blocked by delayRender()
  * @param handle The return value of delayRender().
- * @link https://www.remotion.dev/docs/continue-render
+ * @see [Documentation](https://www.remotion.dev/docs/continue-render)
  */
 export const continueRender = (handle) => {
     if (typeof handle === 'undefined') {

package/dist/esm/easing.js

@@ -1,5 +1,9 @@
 // Taken from https://github.com/facebook/react-native/blob/0b9ea60b4fee8cacc36e7160e31b91fc114dbc0d/Libraries/Animated/src/Easing.js
 import { bezier } from './bezier.js';
+/**
+ * @description The Easing module implements common easing functions. You can use it with the interpolate() API.
+ * @see [Documentation](https://www.remotion.dev/docs/easing)
+ */
 export class Easing {
     static step0(n) {
         return n > 0 ? 1 : 0;

package/dist/esm/freeze.js

@@ -1,7 +1,11 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { useContext, useMemo } from 'react';
-import { SequenceContext } from './Sequence.js';
+import { SequenceContext } from './SequenceContext.js';
 import { TimelineContext } from './timeline-position-state.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)
+ */
 export const Freeze = ({ frame, children }) => {
     if (typeof frame === 'undefined') {
         throw new Error(`The <Freeze /> component requires a 'frame' prop, but none was passed.`);

package/dist/esm/get-static-files.js

@@ -14,6 +14,10 @@ const warnPlayerOnce = () => {
     warnedPlayer = true;
     console.warn('Called getStaticFiles() while using the Remotion Player. The API is only available while using the Remotion Preview. An empty array was returned.');
 };
+/**
+ * @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 const getStaticFiles = () => {
     if (typeof document === 'undefined') {
         warnServerOnce();

package/dist/esm/index.js

@@ -5,10 +5,10 @@ import { checkMultipleRemotionVersions } from './multiple-versions-warning.js';
 import { Null } from './Null.js';
 checkMultipleRemotionVersions();
 export * from './AbsoluteFill.js';
-export * from './audio';
+export * from './audio/index.js';
 export { cancelRender } from './cancel-render.js';
 export * from './Composition.js';
-export { Config } from './config';
+export { Config } from './config.js';
 export { getInputProps } from './config/input-props.js';
 export { continueRender, delayRender } from './delay-render.js';
 export * from './easing.js';
@@ -18,24 +18,32 @@ export { getStaticFiles } from './get-static-files.js';
 export * from './IFrame.js';
 export * from './Img.js';
 export * from './internals.js';
-export * from './interpolate.js';
 export { interpolateColors } from './interpolate-colors.js';
-export { Loop } from './loop';
+export * from './interpolate.js';
+export { Loop } from './loop/index.js';
 export { prefetch } from './prefetch.js';
 export { random } from './random.js';
 export { registerRoot } from './register-root.js';
 export { Sequence } from './Sequence.js';
-export { Series } from './series';
-export * from './spring';
+export { Series } from './series/index.js';
+export * from './spring/index.js';
 export { staticFile } from './static-file.js';
 export * from './Still.js';
 export { useCurrentFrame } from './use-current-frame.js';
 export * from './use-video-config.js';
 export * from './version.js';
-export * from './video';
 export * from './video-config.js';
+export * from './video/index.js';
 export const Experimental = {
+    /**
+     * @description This is a special component that will cause Remotion to only partially capture the frame of the video.
+     * @see [Documentation](https://www.remotion.dev/docs/clipper)
+     */
     Clipper,
+    /**
+     * @description This is a special component, that, when rendered, will skip rendering the frame altogether.
+     * @see [Documentation](https://www.remotion.dev/docs/null)
+     */
     Null,
     useIsPlayer,
 };