Skip to content

🎥 Make videos programmatically with React

1.8 KB
Raw Blame
import {createContext, useCallback, useContext} from 'react';
import type {cancelRender as cancelRenderOriginal} from './cancel-render.js';
import {cancelRenderInternal} from './cancel-render.js';
import type {DelayRenderOptions, DelayRenderScope} from './delay-render.js';
import {continueRenderInternal, delayRenderInternal} from './delay-render.js';
import {useLogLevel} from './log-level-context.js';
import {useRemotionEnvironment} from './use-remotion-environment.js';

type DelayRenderFn = (label?: string, options?: DelayRenderOptions) => number;
type ContinueRenderFn = (handle: number) => void;
type CancelRenderFn = typeof cancelRenderOriginal;

export const DelayRenderContextType = createContext<DelayRenderScope | null>(
	null,
);

export const useDelayRender = (): {
	delayRender: DelayRenderFn;
	continueRender: ContinueRenderFn;
	cancelRender: CancelRenderFn;
} => {
	const environment = useRemotionEnvironment();
	const scope =
		useContext(DelayRenderContextType) ??
		(typeof window !== 'undefined' ? window : undefined);
	const logLevel = useLogLevel();

	const delayRender = useCallback<DelayRenderFn>(
		(label?: string, options?: DelayRenderOptions) => {
			if (!scope) {
				return Math.random();
			}

			return delayRenderInternal({
				scope,
				environment,
				label: label ?? null,
				options: options ?? {},
			});
		},
		[environment, scope],
	);

	const continueRender = useCallback<ContinueRenderFn>(
		(handle: number) => {
			if (!scope) {
				return;
			}

			continueRenderInternal({
				scope,
				handle,
				environment,
				logLevel,
			});
		},
		[environment, logLevel, scope],
	);

	const cancelRender = useCallback<CancelRenderFn>(
		(err: unknown) => {
			return cancelRenderInternal(
				scope ?? (typeof window !== 'undefined' ? window : undefined),
				err,
			);
		},
		[scope],
	);

	return {delayRender, continueRender, cancelRender};
};