UNPKG

@remotion/player

Version:

React component for embedding a Remotion preview into your app

24 lines (23 loc) 1.18 kB
import type { CSSProperties } from 'react'; import type { CompProps } from 'remotion'; import type { AnyZodObject } 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'; type ThumbnailProps<Schema extends AnyZodObject, Props extends Record<string, unknown>> = PropsIfHasProps<Schema, Props> & CompProps<Props> & { frameToDisplay: number; style?: CSSProperties; durationInFrames: number; compositionWidth: number; compositionHeight: number; fps: number; errorFallback?: ErrorFallback; renderLoading?: RenderLoading; className?: string; }; /** * @description A component which can be rendered in a regular React App (for example: Next.js, Vite) to display a single frame of a video. * @see [Documentation](https://www.remotion.dev/docs/player/thumbnail) */ export declare const Thumbnail: <Schema extends AnyZodObject, Props extends Record<string, unknown>>(props: ThumbnailProps<Schema, Props> & import("react").RefAttributes<ThumbnailMethods>) => React.ReactElement | null; export {};