Skip to main content

TypeScript Types Reference

warning

Experimental package: We reserve the right to make breaking changes in order to correct bad design decisions until this notice is gone.

The following types are part of the API of @remotion/vercel:

VercelSandbox​

import type {VercelSandbox} from '@remotion/vercel';
                  
(alias) type VercelSandbox = Sandbox & AsyncDisposable
import VercelSandbox

A Sandbox with AsyncDisposable support. Returned by createSandbox().

CreateSandboxOnProgress​

import type {CreateSandboxOnProgress} from '@remotion/vercel';
                       
(alias) type CreateSandboxOnProgress = (update: {
    progress: number;
    message: string;
}) => void
import CreateSandboxOnProgress
  • progress: A number from 0 to 1 indicating overall progress
  • message: A human-readable description of the current phase

RenderOnVercelProgress​

import type {RenderOnVercelProgress} from '@remotion/vercel';
                       
(alias) type RenderOnVercelProgress = {
    type: "opening-browser";
} | {
    type: "selecting-composition";
} | ({
    type: "render-progress";
} & {
    renderedFrames: number;
    encodedFrames: number;
    encodedDoneIn: number | null;
    renderedDoneIn: number | null;
    renderEstimatedTime: number;
    progress: number;
    stitchStage: StitchingState;
})
import RenderOnVercelProgress

A discriminated union with the following members:

  • {type: 'opening-browser'} - The browser is being opened.
  • {type: 'selecting-composition'} - The composition is being selected.
  • {type: 'render-progress'} - The render is in progress. The remaining fields are the same as RenderMediaOnProgress from @remotion/renderer.

Used as the onProgress callback type for renderMediaOnVercel().

VercelBlobAccess​

import type {VercelBlobAccess} from '@remotion/vercel';
                    
(alias) type VercelBlobAccess = "public" | "private"
import VercelBlobAccess

Either "public" or "private". Used as the access parameter for uploadToVercelBlob().

RenderMediaOnProgress​

Re-exported from @remotion/renderer.