TypeScript Types Reference
The following types are part of the API of @remotion/renderer:
Codec
import type {Codec } from '@remotion/renderer';Refer to the Encoding guide for more information.
AudioCodec
import type {AudioCodec } from '@remotion/renderer';Refer to the Encoding guide to see defaults and supported combinations.
VideoImageFormat
import type {VideoImageFormat } from '@remotion/renderer';StillImageFormat
import type {StillImageFormat } from '@remotion/renderer';PixelFormat
import type {PixelFormat } from '@remotion/renderer';FrameRange
import type {FrameRange } from '@remotion/renderer';- A single number renders only that frame
- A tuple
[start, end]renders frames fromstarttoend(inclusive) - A tuple
[start, null]renders frames fromstartto the end of the composition (from v4.0.421) - An array of ordered, non-overlapping tuples renders multiple ranges (from v4.0.502)
frame-range.tsconstframeRange :FrameRange = [ [0, 100], [150, 200], ];
Concurrency
import type {Concurrency } from '@remotion/renderer';LogLevel
import type {LogLevel } from '@remotion/renderer';OpenGlRenderer
import type {OpenGlRenderer } from '@remotion/renderer';ChromeMode
import type {ChromeMode } from '@remotion/renderer';ColorSpace
import type {ColorSpace } from '@remotion/renderer';X264Preset
import type {X264Preset } from '@remotion/renderer';Crf
import type {Crf } from '@remotion/renderer';Bitrate
import type {Bitrate } from '@remotion/renderer';ChromiumOptions
import type {ChromiumOptions } from '@remotion/renderer';OnStartData
import type {OnStartData } from '@remotion/renderer';frameCount
The number of frames that will be rendered.
parallelEncodingv4.0.52
Whether parallel encoding is enabled.
resolvedConcurrencyv4.0.180
The concurrency that will be used.
RenderMediaOnProgress
import type {RenderMediaOnProgress } from '@remotion/renderer';StitchingState
import type {StitchingState } from '@remotion/renderer';encoding: Rendering frames and encoding into videomuxing: Encoding audio and combining it with video (only when parallel encoding is used)
SlowFrame
import type {SlowFrame } from '@remotion/renderer';RenderMediaOnDownload
import type {RenderMediaOnDownload } from '@remotion/renderer';BrowserLog
import type {BrowserLog } from '@remotion/renderer';type
The console message type (log, warning, error, etc.). console.warn() is reported as warning.
text
The logged message.
stackTrace
The stack trace of the log.
FfmpegOverrideFn
import type {FfmpegOverrideFn } from '@remotion/renderer';OnArtifact
import type {OnArtifact } from '@remotion/renderer';EmittedArtifact
import type {EmittedArtifact } from '@remotion/renderer';filename
The name of the artifact file.
content
The content of the artifact as a string or Uint8Array.
frame
The frame number at which the artifact was emitted.
OnBrowserDownload
import type {OnBrowserDownload } from '@remotion/renderer';DownloadBrowserProgressFn
import type {DownloadBrowserProgressFn } from '@remotion/renderer';NumberOfGifLoops
import type {NumberOfGifLoops } from '@remotion/renderer';RenderMediaOptions
import type {RenderMediaOptions } from '@remotion/renderer';RenderStillOptions
import type {RenderStillOptions } from '@remotion/renderer';RenderFramesOptions
import type {RenderFramesOptions } from '@remotion/renderer';SelectCompositionOptions
import type {SelectCompositionOptions } from '@remotion/renderer';