@remotion/player/dist/cjs/index.d.ts

React component for embedding a Remotion preview into your app

import './_check-rsc.js';
import type { CallbackListener, PlayerEventTypes } from './event-emitter.js';
import { PlayerEmitter } from './event-emitter.js';
export type { RenderMuteButton } from './MediaVolumeSlider.js';
export type { PlayerMethods, PlayerRef, ThumbnailMethods, ThumbnailRef, } from './player-methods.js';
export { Player } from './Player.js';
export type { PlayerProps, PlayerPropsWithoutZod } from './Player.js';
export type { RenderFullscreenButton, RenderPlayPauseButton, } from './PlayerControls.js';
export type { ErrorFallback, RenderLoading, RenderPoster } from './PlayerUI.js';
export type { RenderVolumeSlider } from './render-volume-slider.js';
export { Thumbnail } from './Thumbnail.js';
export type { ThumbnailProps, ThumbnailPropsWithoutZod } from './Thumbnail.js';
export type { Size } from './utils/use-element-size.js';
export type { CallbackListener, PlayerEventTypes as EventTypes };
export declare const PlayerInternals: {
    PlayerEventEmitterContext: import("react").Context<PlayerEmitter | undefined>;
    PlayerEmitter: typeof PlayerEmitter;
    usePlayer: () => {
        frameBack: (frames: number) => void;
        frameForward: (frames: number) => void;
        isLastFrame: boolean;
        isFirstFrame: boolean;
        emitter: PlayerEmitter;
        playing: boolean;
        play: (e?: import("react").SyntheticEvent | PointerEvent) => void;
        pause: () => void;
        pauseAndReturnToPlayStart: () => void;
        seek: (newFrame: number) => void;
        getCurrentFrame: () => number;
        isPlaying: () => boolean;
        hasPlayed: boolean;
        isBuffering: () => boolean;
        toggle: (e?: import("react").SyntheticEvent | PointerEvent) => void;
    };
    usePlayback: ({ loop, playbackRate, moveToBeginningWhenEnded, inFrame, outFrame, browserMediaControlsBehavior, getCurrentFrame, }: {
        loop: boolean;
        playbackRate: number;
        moveToBeginningWhenEnded: boolean;
        inFrame: number | null;
        outFrame: number | null;
        browserMediaControlsBehavior: import("./browser-mediasession.js").BrowserMediaControlsBehavior;
        getCurrentFrame: import("./use-frame-imperative.js").GetCurrentFrame;
    }) => void;
    useElementSize: (ref: React.RefObject<HTMLElement | null>, options: {
        triggerOnWindowResize: boolean;
        shouldApplyCssTransforms: boolean;
    }) => import("./utils/use-element-size.js").Size | null;
    calculateCanvasTransformation: ({ previewSize, compositionWidth, compositionHeight, canvasSize, }: {
        previewSize: import("remotion").PreviewSize["size"];
        compositionWidth: number;
        compositionHeight: number;
        canvasSize: import("./utils/use-element-size.js").Size;
    }) => {
        centerX: number;
        centerY: number;
        xCorrection: number;
        yCorrection: number;
        scale: number;
    };
    useHoverState: (ref: React.RefObject<HTMLDivElement | null>, hideControlsWhenPointerDoesntMove: boolean | number) => boolean;
    updateAllElementsSizes: () => void;
    PlayerEmitterProvider: import("react").FC<{
        readonly children: React.ReactNode;
        readonly currentPlaybackRate: number | null;
    }>;
    BufferingIndicator: import("react").FC<{
        readonly type: "player" | "studio";
    }>;
    useFrameImperative: () => import("./use-frame-imperative.js").GetCurrentFrame;
};