Skip to content
Apexify.jsDocs
Apexify.js version v5.4.5

ApexPainter member

ApexPainter.createVideo

Published ApexPainter.createVideo method.

apexify.jsCURRENTnode22node24node26
Source: lib-next/apex-painter/main.ts (opens in a new tab)

Signature

TypeScript
(options: VideoCreationOptions, painterOpts?: PainterAssetRefsOptions) => Promise<SceneToVideoResult>

Parameters

Options

661 / 661 option paths
OptionTypeContractAllowed valuesRuntime & capabilities
options
options.addAnimatedTextPublished options.addAnimatedText option.Deprecated{ text: string; animation?: "zoom" | "rotate" | "fadeIn" | "fadeOut" | "slideIn" | "slideOut" | "bounce" | "typewriter"; startTime: number; endTime: number; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center" | { x: number; y: number; }; fontSize?: number; fontColor?: string; fontPath?: string; fontName?: string; fontFamily?: string; backgroundColor?: string; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.addAnimatedText.animationPublished options.addAnimatedText.animation option."zoom" | "rotate" | "fadeIn" | "fadeOut" | "slideIn" | "slideOut" | "bounce" | "typewriter"OptionalDefault—
8 values
"zoom" "rotate" "fadeIn" "fadeOut" "slideIn" "slideOut" "bounce" "typewriter"
node22 · node24 · node26
options.addAnimatedText.backgroundColorPublished options.addAnimatedText.backgroundColor option.stringOptionalDefault——node22 · node24 · node26
options.addAnimatedText.endTimePublished options.addAnimatedText.endTime option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addAnimatedText.fontColorPublished options.addAnimatedText.fontColor option.stringOptionalDefault——node22 · node24 · node26
options.addAnimatedText.fontFamilyPublished options.addAnimatedText.fontFamily option.stringOptionalDefault——node22 · node24 · node26
options.addAnimatedText.fontNamePublished options.addAnimatedText.fontName option.stringOptionalDefault——node22 · node24 · node26
options.addAnimatedText.fontPathPublished options.addAnimatedText.fontPath option.stringOptionalDefault——node22 · node24 · node26
options.addAnimatedText.fontSizePublished options.addAnimatedText.fontSize option.numberOptionalDefault——node22 · node24 · node26
options.addAnimatedText.outputPathPublished options.addAnimatedText.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addAnimatedText.positionPublished options.addAnimatedText.position option."center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center" | { x: number; y: number; }OptionalDefault——node22 · node24 · node26
options.addAnimatedText.position.xPublished options.addAnimatedText.position.x option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addAnimatedText.position.yPublished options.addAnimatedText.position.y option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addAnimatedText.startTimePublished options.addAnimatedText.startTime option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addAnimatedText.textPublished options.addAnimatedText.text option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addFadePublished options.addFade option.{ fadeIn?: number; fadeOut?: number; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.addFade.fadeInPublished options.addFade.fadeIn option.numberOptionalDefault——node22 · node24 · node26
options.addFade.fadeOutPublished options.addFade.fadeOut option.numberOptionalDefault——node22 · node24 · node26
options.addFade.outputPathPublished options.addFade.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextPublished options.addText option.Deprecated{ text: string; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center"; fontSize?: number; fontColor?: string; backgroundColor?: string; startTime?: number; endTime?: number; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.addText.backgroundColorPublished options.addText.backgroundColor option.stringOptionalDefault——node22 · node24 · node26
options.addText.endTimePublished options.addText.endTime option.numberOptionalDefault——node22 · node24 · node26
options.addText.fontColorPublished options.addText.fontColor option.stringOptionalDefault——node22 · node24 · node26
options.addText.fontSizePublished options.addText.fontSize option.numberOptionalDefault——node22 · node24 · node26
options.addText.outputPathPublished options.addText.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addText.positionPublished options.addText.position option."center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center"OptionalDefault—
7 values
"center" "top-left" "top-right" "bottom-left" "bottom-right" "top-center" "bottom-center"
node22 · node24 · node26
options.addText.startTimePublished options.addText.startTime option.numberOptionalDefault——node22 · node24 · node26
options.addText.textPublished options.addText.text option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlayPublished options.addTextOverlay option.VideoTextOverlayOperationOptionalDefault——node22 · node24 · node26
options.addTextOverlay.outputPathPublished options.addTextOverlay.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlaysPublished options.addTextOverlay.overlays option.VideoTextOverlayClip[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.boldPublished options.addTextOverlay.overlays.bold option.DeprecatedbooleanOptionalDefault—false truenode22 · node24 · node26
options.addTextOverlay.overlays.colorPublished options.addTextOverlay.overlays.color option.DeprecatedstringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorationsGrouped line decorations (`underline` / `overline` / `strikethrough`) and optional `bold` / `italic` flags for the canvas font string. Nested keys override the legacy flat fields (see {@link resolveTextDecorations}).TextDecorationsOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.boldPublished options.addTextOverlay.overlays.decorations.bold option.booleanOptionalDefault—false truenode22 · node24 · node26
options.addTextOverlay.overlays.decorations.italicPublished options.addTextOverlay.overlays.decorations.italic option.booleanOptionalDefault—false truenode22 · node24 · node26
options.addTextOverlay.overlays.decorations.overlinePublished options.addTextOverlay.overlays.decorations.overline option.TextLineDecorationOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.colorPublished options.addTextOverlay.overlays.decorations.overline.color option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradientPublished options.addTextOverlay.overlays.decorations.overline.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.colorsPublished options.addTextOverlay.overlays.decorations.overline.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.colors.colorPublished options.addTextOverlay.overlays.decorations.overline.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.colors.stopPublished options.addTextOverlay.overlays.decorations.overline.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.endXPublished options.addTextOverlay.overlays.decorations.overline.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.endYPublished options.addTextOverlay.overlays.decorations.overline.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.pivotXPublished options.addTextOverlay.overlays.decorations.overline.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.pivotYPublished options.addTextOverlay.overlays.decorations.overline.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.repeatPublished options.addTextOverlay.overlays.decorations.overline.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.rotatePublished options.addTextOverlay.overlays.decorations.overline.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.startXPublished options.addTextOverlay.overlays.decorations.overline.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.startYPublished options.addTextOverlay.overlays.decorations.overline.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.typePublished options.addTextOverlay.overlays.decorations.overline.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.endRadiusPublished options.addTextOverlay.overlays.decorations.overline.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.startRadiusPublished options.addTextOverlay.overlays.decorations.overline.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.centerXPublished options.addTextOverlay.overlays.decorations.overline.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.centerYPublished options.addTextOverlay.overlays.decorations.overline.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.gradient.startAnglePublished options.addTextOverlay.overlays.decorations.overline.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.overline.widthPublished options.addTextOverlay.overlays.decorations.overline.width option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethroughPublished options.addTextOverlay.overlays.decorations.strikethrough option.TextLineDecorationOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.colorPublished options.addTextOverlay.overlays.decorations.strikethrough.color option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradientPublished options.addTextOverlay.overlays.decorations.strikethrough.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.colorsPublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.colors.colorPublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.colors.stopPublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.endXPublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.endYPublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.pivotXPublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.pivotYPublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.repeatPublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.rotatePublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.startXPublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.startYPublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.typePublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.endRadiusPublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.startRadiusPublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.centerXPublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.centerYPublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.gradient.startAnglePublished options.addTextOverlay.overlays.decorations.strikethrough.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.strikethrough.widthPublished options.addTextOverlay.overlays.decorations.strikethrough.width option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underlinePublished options.addTextOverlay.overlays.decorations.underline option.TextLineDecorationOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.colorPublished options.addTextOverlay.overlays.decorations.underline.color option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradientPublished options.addTextOverlay.overlays.decorations.underline.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.colorsPublished options.addTextOverlay.overlays.decorations.underline.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.colors.colorPublished options.addTextOverlay.overlays.decorations.underline.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.colors.stopPublished options.addTextOverlay.overlays.decorations.underline.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.endXPublished options.addTextOverlay.overlays.decorations.underline.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.endYPublished options.addTextOverlay.overlays.decorations.underline.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.pivotXPublished options.addTextOverlay.overlays.decorations.underline.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.pivotYPublished options.addTextOverlay.overlays.decorations.underline.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.repeatPublished options.addTextOverlay.overlays.decorations.underline.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.rotatePublished options.addTextOverlay.overlays.decorations.underline.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.startXPublished options.addTextOverlay.overlays.decorations.underline.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.startYPublished options.addTextOverlay.overlays.decorations.underline.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.typePublished options.addTextOverlay.overlays.decorations.underline.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.endRadiusPublished options.addTextOverlay.overlays.decorations.underline.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.startRadiusPublished options.addTextOverlay.overlays.decorations.underline.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.centerXPublished options.addTextOverlay.overlays.decorations.underline.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.centerYPublished options.addTextOverlay.overlays.decorations.underline.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.gradient.startAnglePublished options.addTextOverlay.overlays.decorations.underline.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.decorations.underline.widthPublished options.addTextOverlay.overlays.decorations.underline.width option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effectsGrouped highlight, glow, and shadow. When set, entries override the legacy flat fields (see {@link resolveTextEffects}).TextEffectsOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glowPublished options.addTextOverlay.overlays.effects.glow option.TextGlowStyleOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.colorPublished options.addTextOverlay.overlays.effects.glow.color option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradientPublished options.addTextOverlay.overlays.effects.glow.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.colorsPublished options.addTextOverlay.overlays.effects.glow.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.colors.colorPublished options.addTextOverlay.overlays.effects.glow.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.colors.stopPublished options.addTextOverlay.overlays.effects.glow.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.endXPublished options.addTextOverlay.overlays.effects.glow.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.endYPublished options.addTextOverlay.overlays.effects.glow.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.pivotXPublished options.addTextOverlay.overlays.effects.glow.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.pivotYPublished options.addTextOverlay.overlays.effects.glow.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.repeatPublished options.addTextOverlay.overlays.effects.glow.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.rotatePublished options.addTextOverlay.overlays.effects.glow.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.startXPublished options.addTextOverlay.overlays.effects.glow.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.startYPublished options.addTextOverlay.overlays.effects.glow.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.typePublished options.addTextOverlay.overlays.effects.glow.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.endRadiusPublished options.addTextOverlay.overlays.effects.glow.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.startRadiusPublished options.addTextOverlay.overlays.effects.glow.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.centerXPublished options.addTextOverlay.overlays.effects.glow.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.centerYPublished options.addTextOverlay.overlays.effects.glow.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.gradient.startAnglePublished options.addTextOverlay.overlays.effects.glow.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.intensityPublished options.addTextOverlay.overlays.effects.glow.intensity option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.glow.opacityPublished options.addTextOverlay.overlays.effects.glow.opacity option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlightPublished options.addTextOverlay.overlays.effects.highlight option.TextHighlightStyleOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.colorPublished options.addTextOverlay.overlays.effects.highlight.color option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradientPublished options.addTextOverlay.overlays.effects.highlight.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.colorsPublished options.addTextOverlay.overlays.effects.highlight.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.colors.colorPublished options.addTextOverlay.overlays.effects.highlight.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.colors.stopPublished options.addTextOverlay.overlays.effects.highlight.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.endXPublished options.addTextOverlay.overlays.effects.highlight.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.endYPublished options.addTextOverlay.overlays.effects.highlight.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.pivotXPublished options.addTextOverlay.overlays.effects.highlight.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.pivotYPublished options.addTextOverlay.overlays.effects.highlight.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.repeatPublished options.addTextOverlay.overlays.effects.highlight.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.rotatePublished options.addTextOverlay.overlays.effects.highlight.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.startXPublished options.addTextOverlay.overlays.effects.highlight.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.startYPublished options.addTextOverlay.overlays.effects.highlight.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.typePublished options.addTextOverlay.overlays.effects.highlight.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.endRadiusPublished options.addTextOverlay.overlays.effects.highlight.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.startRadiusPublished options.addTextOverlay.overlays.effects.highlight.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.centerXPublished options.addTextOverlay.overlays.effects.highlight.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.centerYPublished options.addTextOverlay.overlays.effects.highlight.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.gradient.startAnglePublished options.addTextOverlay.overlays.effects.highlight.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.highlight.opacityPublished options.addTextOverlay.overlays.effects.highlight.opacity option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadowPublished options.addTextOverlay.overlays.effects.shadow option.TextShadowStyleOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.blurPublished options.addTextOverlay.overlays.effects.shadow.blur option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.colorPublished options.addTextOverlay.overlays.effects.shadow.color option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradientPublished options.addTextOverlay.overlays.effects.shadow.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.colorsPublished options.addTextOverlay.overlays.effects.shadow.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.colors.colorPublished options.addTextOverlay.overlays.effects.shadow.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.colors.stopPublished options.addTextOverlay.overlays.effects.shadow.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.endXPublished options.addTextOverlay.overlays.effects.shadow.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.endYPublished options.addTextOverlay.overlays.effects.shadow.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.pivotXPublished options.addTextOverlay.overlays.effects.shadow.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.pivotYPublished options.addTextOverlay.overlays.effects.shadow.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.repeatPublished options.addTextOverlay.overlays.effects.shadow.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.rotatePublished options.addTextOverlay.overlays.effects.shadow.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.startXPublished options.addTextOverlay.overlays.effects.shadow.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.startYPublished options.addTextOverlay.overlays.effects.shadow.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.typePublished options.addTextOverlay.overlays.effects.shadow.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.endRadiusPublished options.addTextOverlay.overlays.effects.shadow.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.startRadiusPublished options.addTextOverlay.overlays.effects.shadow.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.centerXPublished options.addTextOverlay.overlays.effects.shadow.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.centerYPublished options.addTextOverlay.overlays.effects.shadow.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.gradient.startAnglePublished options.addTextOverlay.overlays.effects.shadow.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.offsetXPublished options.addTextOverlay.overlays.effects.shadow.offsetX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.offsetYPublished options.addTextOverlay.overlays.effects.shadow.offsetY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.effects.shadow.opacityPublished options.addTextOverlay.overlays.effects.shadow.opacity option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.endTimeSeconds when this overlay is hidden.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.fillGrouped fill color / gradient and draw opacity (see {@link resolveTextFill}).TextFillOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fill.colorPublished options.addTextOverlay.overlays.fill.color option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradientPublished options.addTextOverlay.overlays.fill.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.colorsPublished options.addTextOverlay.overlays.fill.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.colors.colorPublished options.addTextOverlay.overlays.fill.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.colors.stopPublished options.addTextOverlay.overlays.fill.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.endXPublished options.addTextOverlay.overlays.fill.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.endYPublished options.addTextOverlay.overlays.fill.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.pivotXPublished options.addTextOverlay.overlays.fill.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.pivotYPublished options.addTextOverlay.overlays.fill.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.repeatPublished options.addTextOverlay.overlays.fill.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.rotatePublished options.addTextOverlay.overlays.fill.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.startXPublished options.addTextOverlay.overlays.fill.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.startYPublished options.addTextOverlay.overlays.fill.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.typePublished options.addTextOverlay.overlays.fill.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.endRadiusPublished options.addTextOverlay.overlays.fill.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.startRadiusPublished options.addTextOverlay.overlays.fill.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.centerXPublished options.addTextOverlay.overlays.fill.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.centerYPublished options.addTextOverlay.overlays.fill.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fill.gradient.startAnglePublished options.addTextOverlay.overlays.fill.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fill.opacityPublished options.addTextOverlay.overlays.fill.opacity option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fontPublished options.addTextOverlay.overlays.font option.{ size?: number; family?: string; name?: string; path?: string; }OptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.font.familyPublished options.addTextOverlay.overlays.font.family option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.font.namePublished options.addTextOverlay.overlays.font.name option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.font.pathPublished options.addTextOverlay.overlays.font.path option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.font.sizePublished options.addTextOverlay.overlays.font.size option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fontFamilyPublished options.addTextOverlay.overlays.fontFamily option.DeprecatedstringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fontNamePublished options.addTextOverlay.overlays.fontName option.DeprecatedstringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fontPathPublished options.addTextOverlay.overlays.fontPath option.DeprecatedstringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.fontSizePublished options.addTextOverlay.overlays.fontSize option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glowPublished options.addTextOverlay.overlays.glow option.DeprecatedTextGlowStyleOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.colorPublished options.addTextOverlay.overlays.glow.color option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradientPublished options.addTextOverlay.overlays.glow.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.colorsPublished options.addTextOverlay.overlays.glow.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.colors.colorPublished options.addTextOverlay.overlays.glow.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.colors.stopPublished options.addTextOverlay.overlays.glow.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.endXPublished options.addTextOverlay.overlays.glow.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.endYPublished options.addTextOverlay.overlays.glow.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.pivotXPublished options.addTextOverlay.overlays.glow.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.pivotYPublished options.addTextOverlay.overlays.glow.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.repeatPublished options.addTextOverlay.overlays.glow.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.rotatePublished options.addTextOverlay.overlays.glow.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.startXPublished options.addTextOverlay.overlays.glow.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.startYPublished options.addTextOverlay.overlays.glow.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.typePublished options.addTextOverlay.overlays.glow.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.endRadiusPublished options.addTextOverlay.overlays.glow.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.startRadiusPublished options.addTextOverlay.overlays.glow.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.centerXPublished options.addTextOverlay.overlays.glow.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.centerYPublished options.addTextOverlay.overlays.glow.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.gradient.startAnglePublished options.addTextOverlay.overlays.glow.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.intensityPublished options.addTextOverlay.overlays.glow.intensity option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.glow.opacityPublished options.addTextOverlay.overlays.glow.opacity option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.gradientPublished options.addTextOverlay.overlays.gradient option.DeprecatedgradientOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.gradient.colorsPublished options.addTextOverlay.overlays.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.gradient.colors.colorPublished options.addTextOverlay.overlays.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.gradient.colors.stopPublished options.addTextOverlay.overlays.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.gradient.endXPublished options.addTextOverlay.overlays.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.gradient.endYPublished options.addTextOverlay.overlays.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.gradient.pivotXPublished options.addTextOverlay.overlays.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.gradient.pivotYPublished options.addTextOverlay.overlays.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.gradient.repeatPublished options.addTextOverlay.overlays.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.addTextOverlay.overlays.gradient.rotatePublished options.addTextOverlay.overlays.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.gradient.startXPublished options.addTextOverlay.overlays.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.gradient.startYPublished options.addTextOverlay.overlays.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.gradient.typePublished options.addTextOverlay.overlays.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.addTextOverlay.overlays.gradient.endRadiusPublished options.addTextOverlay.overlays.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.gradient.startRadiusPublished options.addTextOverlay.overlays.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.gradient.centerXPublished options.addTextOverlay.overlays.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.gradient.centerYPublished options.addTextOverlay.overlays.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.gradient.startAnglePublished options.addTextOverlay.overlays.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlightPublished options.addTextOverlay.overlays.highlight option.DeprecatedTextHighlightStyleOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlight.colorPublished options.addTextOverlay.overlays.highlight.color option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradientPublished options.addTextOverlay.overlays.highlight.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.colorsPublished options.addTextOverlay.overlays.highlight.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.colors.colorPublished options.addTextOverlay.overlays.highlight.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.colors.stopPublished options.addTextOverlay.overlays.highlight.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.endXPublished options.addTextOverlay.overlays.highlight.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.endYPublished options.addTextOverlay.overlays.highlight.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.pivotXPublished options.addTextOverlay.overlays.highlight.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.pivotYPublished options.addTextOverlay.overlays.highlight.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.repeatPublished options.addTextOverlay.overlays.highlight.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.rotatePublished options.addTextOverlay.overlays.highlight.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.startXPublished options.addTextOverlay.overlays.highlight.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.startYPublished options.addTextOverlay.overlays.highlight.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.typePublished options.addTextOverlay.overlays.highlight.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.endRadiusPublished options.addTextOverlay.overlays.highlight.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.startRadiusPublished options.addTextOverlay.overlays.highlight.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.centerXPublished options.addTextOverlay.overlays.highlight.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.centerYPublished options.addTextOverlay.overlays.highlight.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlight.gradient.startAnglePublished options.addTextOverlay.overlays.highlight.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.highlight.opacityPublished options.addTextOverlay.overlays.highlight.opacity option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.includeCharMetricsPublished options.addTextOverlay.overlays.includeCharMetrics option.booleanOptionalDefault—false truenode22 · node24 · node26
options.addTextOverlay.overlays.italicPublished options.addTextOverlay.overlays.italic option.DeprecatedbooleanOptionalDefault—false truenode22 · node24 · node26
options.addTextOverlay.overlays.layoutGrouped line height, spacing, and wrap bounds (see {@link resolveTextLayout}).TextLayoutOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.layout.letterSpacingPublished options.addTextOverlay.overlays.layout.letterSpacing option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.layout.lineHeightPublished options.addTextOverlay.overlays.layout.lineHeight option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.layout.maxHeightPublished options.addTextOverlay.overlays.layout.maxHeight option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.layout.maxWidthPublished options.addTextOverlay.overlays.layout.maxWidth option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.layout.wordSpacingPublished options.addTextOverlay.overlays.layout.wordSpacing option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.letterSpacingPublished options.addTextOverlay.overlays.letterSpacing option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.lineHeightPublished options.addTextOverlay.overlays.lineHeight option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.maxHeightPublished options.addTextOverlay.overlays.maxHeight option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.maxWidthPublished options.addTextOverlay.overlays.maxWidth option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.measurementCanvasPublished options.addTextOverlay.overlays.measurementCanvas option.{ width?: number; height?: number; }OptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.measurementCanvas.heightPublished options.addTextOverlay.overlays.measurementCanvas.height option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.measurementCanvas.widthPublished options.addTextOverlay.overlays.measurementCanvas.width option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.opacityPublished options.addTextOverlay.overlays.opacity option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overlayOpacityMaster overlay opacity 0–1 (default `1`), multiplied with transition fades. Distinct from {@link TextProperties.fill} / `opacity` on glyphs.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overlinePublished options.addTextOverlay.overlays.overline option.DeprecatedTextLineDecorationOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overline.colorPublished options.addTextOverlay.overlays.overline.color option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradientPublished options.addTextOverlay.overlays.overline.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.colorsPublished options.addTextOverlay.overlays.overline.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.colors.colorPublished options.addTextOverlay.overlays.overline.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.colors.stopPublished options.addTextOverlay.overlays.overline.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.endXPublished options.addTextOverlay.overlays.overline.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.endYPublished options.addTextOverlay.overlays.overline.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.pivotXPublished options.addTextOverlay.overlays.overline.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.pivotYPublished options.addTextOverlay.overlays.overline.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.repeatPublished options.addTextOverlay.overlays.overline.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.rotatePublished options.addTextOverlay.overlays.overline.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.startXPublished options.addTextOverlay.overlays.overline.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.startYPublished options.addTextOverlay.overlays.overline.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.typePublished options.addTextOverlay.overlays.overline.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.endRadiusPublished options.addTextOverlay.overlays.overline.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.startRadiusPublished options.addTextOverlay.overlays.overline.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.centerXPublished options.addTextOverlay.overlays.overline.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.centerYPublished options.addTextOverlay.overlays.overline.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overline.gradient.startAnglePublished options.addTextOverlay.overlays.overline.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.overline.widthPublished options.addTextOverlay.overlays.overline.width option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.placementGrouped alignment, baseline, and rotation (see {@link resolveTextPlacement}).TextPlacementOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.placement.rotationPublished options.addTextOverlay.overlays.placement.rotation option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.placement.textAlignPublished options.addTextOverlay.overlays.placement.textAlign option.TextAlignModeOptionalDefault—
5 values
"center" "left" "right" "start" "end"
node22 · node24 · node26
options.addTextOverlay.overlays.placement.textBaselinePublished options.addTextOverlay.overlays.placement.textBaseline option.TextBaselineModeOptionalDefault—
6 values
"top" "bottom" "alphabetic" "hanging" "ideographic" "middle"
node22 · node24 · node26
options.addTextOverlay.overlays.rotationPublished options.addTextOverlay.overlays.rotation option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadowPublished options.addTextOverlay.overlays.shadow option.DeprecatedTextShadowStyleOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.blurPublished options.addTextOverlay.overlays.shadow.blur option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.colorPublished options.addTextOverlay.overlays.shadow.color option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradientPublished options.addTextOverlay.overlays.shadow.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.colorsPublished options.addTextOverlay.overlays.shadow.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.colors.colorPublished options.addTextOverlay.overlays.shadow.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.colors.stopPublished options.addTextOverlay.overlays.shadow.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.endXPublished options.addTextOverlay.overlays.shadow.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.endYPublished options.addTextOverlay.overlays.shadow.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.pivotXPublished options.addTextOverlay.overlays.shadow.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.pivotYPublished options.addTextOverlay.overlays.shadow.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.repeatPublished options.addTextOverlay.overlays.shadow.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.rotatePublished options.addTextOverlay.overlays.shadow.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.startXPublished options.addTextOverlay.overlays.shadow.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.startYPublished options.addTextOverlay.overlays.shadow.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.typePublished options.addTextOverlay.overlays.shadow.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.endRadiusPublished options.addTextOverlay.overlays.shadow.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.startRadiusPublished options.addTextOverlay.overlays.shadow.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.centerXPublished options.addTextOverlay.overlays.shadow.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.centerYPublished options.addTextOverlay.overlays.shadow.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.gradient.startAnglePublished options.addTextOverlay.overlays.shadow.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.offsetXPublished options.addTextOverlay.overlays.shadow.offsetX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.offsetYPublished options.addTextOverlay.overlays.shadow.offsetY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.shadow.opacityPublished options.addTextOverlay.overlays.shadow.opacity option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.startTimeSeconds when this overlay becomes visible.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.strikethroughPublished options.addTextOverlay.overlays.strikethrough option.DeprecatedTextLineDecorationOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.colorPublished options.addTextOverlay.overlays.strikethrough.color option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradientPublished options.addTextOverlay.overlays.strikethrough.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.colorsPublished options.addTextOverlay.overlays.strikethrough.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.colors.colorPublished options.addTextOverlay.overlays.strikethrough.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.colors.stopPublished options.addTextOverlay.overlays.strikethrough.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.endXPublished options.addTextOverlay.overlays.strikethrough.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.endYPublished options.addTextOverlay.overlays.strikethrough.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.pivotXPublished options.addTextOverlay.overlays.strikethrough.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.pivotYPublished options.addTextOverlay.overlays.strikethrough.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.repeatPublished options.addTextOverlay.overlays.strikethrough.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.rotatePublished options.addTextOverlay.overlays.strikethrough.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.startXPublished options.addTextOverlay.overlays.strikethrough.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.startYPublished options.addTextOverlay.overlays.strikethrough.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.typePublished options.addTextOverlay.overlays.strikethrough.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.endRadiusPublished options.addTextOverlay.overlays.strikethrough.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.startRadiusPublished options.addTextOverlay.overlays.strikethrough.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.centerXPublished options.addTextOverlay.overlays.strikethrough.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.centerYPublished options.addTextOverlay.overlays.strikethrough.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.gradient.startAnglePublished options.addTextOverlay.overlays.strikethrough.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strikethrough.widthPublished options.addTextOverlay.overlays.strikethrough.width option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.strokePublished options.addTextOverlay.overlays.stroke option.TextStrokeStyleOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.colorPublished options.addTextOverlay.overlays.stroke.color option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradientPublished options.addTextOverlay.overlays.stroke.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.colorsPublished options.addTextOverlay.overlays.stroke.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.colors.colorPublished options.addTextOverlay.overlays.stroke.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.colors.stopPublished options.addTextOverlay.overlays.stroke.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.endXPublished options.addTextOverlay.overlays.stroke.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.endYPublished options.addTextOverlay.overlays.stroke.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.pivotXPublished options.addTextOverlay.overlays.stroke.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.pivotYPublished options.addTextOverlay.overlays.stroke.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.repeatPublished options.addTextOverlay.overlays.stroke.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.rotatePublished options.addTextOverlay.overlays.stroke.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.startXPublished options.addTextOverlay.overlays.stroke.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.startYPublished options.addTextOverlay.overlays.stroke.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.typePublished options.addTextOverlay.overlays.stroke.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.endRadiusPublished options.addTextOverlay.overlays.stroke.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.startRadiusPublished options.addTextOverlay.overlays.stroke.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.centerXPublished options.addTextOverlay.overlays.stroke.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.centerYPublished options.addTextOverlay.overlays.stroke.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.gradient.startAnglePublished options.addTextOverlay.overlays.stroke.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.opacityPublished options.addTextOverlay.overlays.stroke.opacity option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.stroke.stylePublished options.addTextOverlay.overlays.stroke.style option."solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"OptionalDefault—
6 values
"solid" "dashed" "dotted" "groove" "ridge" "double"
node22 · node24 · node26
options.addTextOverlay.overlays.stroke.widthPublished options.addTextOverlay.overlays.stroke.width option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.textPublished options.addTextOverlay.overlays.text option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.textAlignPublished options.addTextOverlay.overlays.textAlign option.DeprecatedTextAlignModeOptionalDefault—
5 values
"center" "left" "right" "start" "end"
node22 · node24 · node26
options.addTextOverlay.overlays.textBaselinePublished options.addTextOverlay.overlays.textBaseline option.DeprecatedTextBaselineModeOptionalDefault—
6 values
"top" "bottom" "alphabetic" "hanging" "ideographic" "middle"
node22 · node24 · node26
options.addTextOverlay.overlays.textOnCurvePublished options.addTextOverlay.overlays.textOnCurve option.DeprecatedTextCurveConfigOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.textOnCurve.baselineOffsetPublished options.addTextOverlay.overlays.textOnCurve.baselineOffset option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.textOnCurve.layoutModePublished options.addTextOverlay.overlays.textOnCurve.layoutMode option.CurvedTextLayoutModeOptionalDefault—"fit" "clamp" "override"node22 · node24 · node26
options.addTextOverlay.overlays.textOnCurve.radiusPublished options.addTextOverlay.overlays.textOnCurve.radius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.textOnCurve.startAngleDegPublished options.addTextOverlay.overlays.textOnCurve.startAngleDeg option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.textOnCurve.sweepAnglePublished options.addTextOverlay.overlays.textOnCurve.sweepAngle option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.textOnCurve.upPublished options.addTextOverlay.overlays.textOnCurve.up option.booleanOptionalDefault—false truenode22 · node24 · node26
options.addTextOverlay.overlays.transitionInPublished options.addTextOverlay.overlays.transitionIn option.VideoTextTransitionOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.transitionIn.customAdvanced: override auto-built expressions (`t` variable, main video `w`/`h`). When set, merged with preset (preset fills missing keys).{ x?: string; y?: string; alpha?: string; scale?: string; }OptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.transitionIn.custom.alphaPublished options.addTextOverlay.overlays.transitionIn.custom.alpha option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.transitionIn.custom.scalePublished options.addTextOverlay.overlays.transitionIn.custom.scale option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.transitionIn.custom.xPublished options.addTextOverlay.overlays.transitionIn.custom.x option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.transitionIn.custom.yPublished options.addTextOverlay.overlays.transitionIn.custom.y option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.transitionIn.durationSeconds (default `0.35`).numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.transitionIn.typePublished options.addTextOverlay.overlays.transitionIn.type option.VideoTextTransitionPresetRequiredDefaultRequired
14 values
"none" "fade" "fadeIn" "fadeOut" "slideIn" "slideOut" "slideLeft" "slideRight" "slideUp" "slideDown" "zoomIn" "zoomOut" "bounce" "typewriter"
node22 · node24 · node26
options.addTextOverlay.overlays.transitionOutPublished options.addTextOverlay.overlays.transitionOut option.VideoTextTransitionOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.transitionOut.customAdvanced: override auto-built expressions (`t` variable, main video `w`/`h`). When set, merged with preset (preset fills missing keys).{ x?: string; y?: string; alpha?: string; scale?: string; }OptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.transitionOut.custom.alphaPublished options.addTextOverlay.overlays.transitionOut.custom.alpha option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.transitionOut.custom.scalePublished options.addTextOverlay.overlays.transitionOut.custom.scale option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.transitionOut.custom.xPublished options.addTextOverlay.overlays.transitionOut.custom.x option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.transitionOut.custom.yPublished options.addTextOverlay.overlays.transitionOut.custom.y option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.transitionOut.durationSeconds (default `0.35`).numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.transitionOut.typePublished options.addTextOverlay.overlays.transitionOut.type option.VideoTextTransitionPresetRequiredDefaultRequired
14 values
"none" "fade" "fadeIn" "fadeOut" "slideIn" "slideOut" "slideLeft" "slideRight" "slideUp" "slideDown" "zoomIn" "zoomOut" "bounce" "typewriter"
node22 · node24 · node26
options.addTextOverlay.overlays.underlinePublished options.addTextOverlay.overlays.underline option.DeprecatedTextLineDecorationOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.underline.colorPublished options.addTextOverlay.overlays.underline.color option.stringOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradientPublished options.addTextOverlay.overlays.underline.gradient option.gradientOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.colorsPublished options.addTextOverlay.overlays.underline.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.colors.colorPublished options.addTextOverlay.overlays.underline.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.colors.stopPublished options.addTextOverlay.overlays.underline.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.endXPublished options.addTextOverlay.overlays.underline.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.endYPublished options.addTextOverlay.overlays.underline.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.pivotXPublished options.addTextOverlay.overlays.underline.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.pivotYPublished options.addTextOverlay.overlays.underline.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.repeatPublished options.addTextOverlay.overlays.underline.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.rotatePublished options.addTextOverlay.overlays.underline.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.startXPublished options.addTextOverlay.overlays.underline.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.startYPublished options.addTextOverlay.overlays.underline.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.typePublished options.addTextOverlay.overlays.underline.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.endRadiusPublished options.addTextOverlay.overlays.underline.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.startRadiusPublished options.addTextOverlay.overlays.underline.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.centerXPublished options.addTextOverlay.overlays.underline.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.centerYPublished options.addTextOverlay.overlays.underline.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.underline.gradient.startAnglePublished options.addTextOverlay.overlays.underline.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.underline.widthPublished options.addTextOverlay.overlays.underline.width option.numberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.wordSpacingPublished options.addTextOverlay.overlays.wordSpacing option.DeprecatednumberOptionalDefault——node22 · node24 · node26
options.addTextOverlay.overlays.xPublished options.addTextOverlay.overlays.x option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTextOverlay.overlays.yPublished options.addTextOverlay.overlays.y option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTransitionPublished options.addTransition option.{ type: "circle" | "blur" | "zoom" | "fade" | "wipe" | "slide" | "rotate" | "dissolve" | "pixelize"; duration: number; direction?: "left" | "right" | "up" | "down" | "in" | "out"; secondVideo?: VideoSource; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.addTransition.directionPublished options.addTransition.direction option."left" | "right" | "up" | "down" | "in" | "out"OptionalDefault—
6 values
"left" "right" "up" "down" "in" "out"
node22 · node24 · node26
options.addTransition.durationPublished options.addTransition.duration option.numberRequiredDefaultRequired—node22 · node24 · node26
options.addTransition.outputPathPublished options.addTransition.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addTransition.secondVideoPublished options.addTransition.secondVideo option.VideoSourceOptionalDefault——node22 · node24 · node26
options.addTransition.typePublished options.addTransition.type option."circle" | "blur" | "zoom" | "fade" | "wipe" | "slide" | "rotate" | "dissolve" | "pixelize"RequiredDefaultRequired
9 values
"circle" "blur" "zoom" "fade" "wipe" "slide" "rotate" "dissolve" "pixelize"
node22 · node24 · node26
options.addWatermarkPublished options.addWatermark option.{ watermarkPath: VideoSource; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; opacity?: number; size?: { width?: number; height?: number; fit?: VideoFit; }; marginX?: number; marginY?: number; startTime?: number; endTime?: number; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.addWatermark.endTimePublished options.addWatermark.endTime option.numberOptionalDefault——node22 · node24 · node26
options.addWatermark.marginXPublished options.addWatermark.marginX option.numberOptionalDefault——node22 · node24 · node26
options.addWatermark.marginYPublished options.addWatermark.marginY option.numberOptionalDefault——node22 · node24 · node26
options.addWatermark.opacityPublished options.addWatermark.opacity option.numberOptionalDefault——node22 · node24 · node26
options.addWatermark.outputPathPublished options.addWatermark.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.addWatermark.positionPublished options.addWatermark.position option."center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"OptionalDefault—
5 values
"center" "top-left" "top-right" "bottom-left" "bottom-right"
node22 · node24 · node26
options.addWatermark.sizePublished options.addWatermark.size option.{ width?: number; height?: number; fit?: VideoFit; }OptionalDefault——node22 · node24 · node26
options.addWatermark.size.fitPublished options.addWatermark.size.fit option.VideoFitOptionalDefault—"contain" "cover" "stretch"node22 · node24 · node26
options.addWatermark.size.heightPublished options.addWatermark.size.height option.numberOptionalDefault——node22 · node24 · node26
options.addWatermark.size.widthPublished options.addWatermark.size.width option.numberOptionalDefault——node22 · node24 · node26
options.addWatermark.startTimePublished options.addWatermark.startTime option.numberOptionalDefault——node22 · node24 · node26
options.addWatermark.watermarkPathPublished options.addWatermark.watermarkPath option.VideoSourceRequiredDefaultRequired—node22 · node24 · node26
options.adjustVolumePublished options.adjustVolume option.{ outputPath: string; volume?: number; ranges?: { start: number; end: number; volume: number; speed?: number; pitchSemitones?: number; }[]; }OptionalDefault——node22 · node24 · node26
options.adjustVolume.outputPathPublished options.adjustVolume.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.adjustVolume.rangesPublished options.adjustVolume.ranges option.{ start: number; end: number; volume: number; speed?: number; pitchSemitones?: number; }[]OptionalDefault——node22 · node24 · node26
options.adjustVolume.ranges.endPublished options.adjustVolume.ranges.end option.numberRequiredDefaultRequired—node22 · node24 · node26
options.adjustVolume.ranges.pitchSemitonesPublished options.adjustVolume.ranges.pitchSemitones option.numberOptionalDefault——node22 · node24 · node26
options.adjustVolume.ranges.speedPublished options.adjustVolume.ranges.speed option.numberOptionalDefault——node22 · node24 · node26
options.adjustVolume.ranges.startPublished options.adjustVolume.ranges.start option.numberRequiredDefaultRequired—node22 · node24 · node26
options.adjustVolume.ranges.volumePublished options.adjustVolume.ranges.volume option.numberRequiredDefaultRequired—node22 · node24 · node26
options.adjustVolume.volumePublished options.adjustVolume.volume option.numberOptionalDefault——node22 · node24 · node26
options.applyEffectsPublished options.applyEffects option.{ filters: { type: "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"; intensity?: number; value?: number; }[]; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.applyEffects.filtersPublished options.applyEffects.filters option.{ type: "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"; intensity?: number; value?: number; }[]RequiredDefaultRequired—node22 · node24 · node26
options.applyEffects.filters.intensityPublished options.applyEffects.filters.intensity option.numberOptionalDefault——node22 · node24 · node26
options.applyEffects.filters.typePublished options.applyEffects.filters.type option."saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"RequiredDefaultRequired
9 values
"saturation" "sharpen" "noise" "invert" "grayscale" "sepia" "brightness" "contrast" "blur"
node22 · node24 · node26
options.applyEffects.filters.valuePublished options.applyEffects.filters.value option.numberOptionalDefault——node22 · node24 · node26
options.applyEffects.outputPathPublished options.applyEffects.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.applyLUTPublished options.applyLUT option.{ lutPath: string; intensity?: number; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.applyLUT.intensityPublished options.applyLUT.intensity option.numberOptionalDefault——node22 · node24 · node26
options.applyLUT.lutPathPublished options.applyLUT.lutPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.applyLUT.outputPathPublished options.applyLUT.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.batchPublished options.batch option.{ videos: { source: VideoSource; operations: Record<string, unknown>; }[]; outputDirectory: string; }OptionalDefault——node22 · node24 · node26
options.batch.outputDirectoryPublished options.batch.outputDirectory option.stringRequiredDefaultRequired—node22 · node24 · node26
options.batch.videosPublished options.batch.videos option.{ source: VideoSource; operations: Record<string, unknown>; }[]RequiredDefaultRequired—node22 · node24 · node26
options.batch.videos.operationsPublished options.batch.videos.operations option.Record<string, unknown>RequiredDefaultRequired—node22 · node24 · node26
options.batch.videos.sourcePublished options.batch.videos.source option.VideoSourceRequiredDefaultRequired—node22 · node24 · node26
options.changeSpeedPublished options.changeSpeed option.{ speed: number; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.changeSpeed.outputPathPublished options.changeSpeed.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.changeSpeed.speedPublished options.changeSpeed.speed option.numberRequiredDefaultRequired—node22 · node24 · node26
options.colorCorrectPublished options.colorCorrect option.{ brightness?: number; contrast?: number; saturation?: number; hue?: number; temperature?: number; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.colorCorrect.brightnessPublished options.colorCorrect.brightness option.numberOptionalDefault——node22 · node24 · node26
options.colorCorrect.contrastPublished options.colorCorrect.contrast option.numberOptionalDefault——node22 · node24 · node26
options.colorCorrect.huePublished options.colorCorrect.hue option.numberOptionalDefault——node22 · node24 · node26
options.colorCorrect.outputPathPublished options.colorCorrect.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.colorCorrect.saturationPublished options.colorCorrect.saturation option.numberOptionalDefault——node22 · node24 · node26
options.colorCorrect.temperaturePublished options.colorCorrect.temperature option.numberOptionalDefault——node22 · node24 · node26
options.compressPublished options.compress option.{ outputPath: string; quality?: VideoQuality; targetSize?: number; maxBitrate?: number; }OptionalDefault——node22 · node24 · node26
options.compress.maxBitratePublished options.compress.maxBitrate option.numberOptionalDefault——node22 · node24 · node26
options.compress.outputPathPublished options.compress.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.compress.qualityPublished options.compress.quality option.VideoQualityOptionalDefault—"low" "medium" "high" "ultra"node22 · node24 · node26
options.compress.targetSizePublished options.compress.targetSize option.numberOptionalDefault——node22 · node24 · node26
options.convertPublished options.convert option.{ outputPath: string; format?: VideoOutputFormat; videoCodec?: "copy" | "libx264" | "libx265" | "libvpx-vp9" | "libaom-av1"; audioCodec?: "copy" | "none" | "aac" | "libopus" | "libvorbis" | "mp3"; pixelFormat?: "yuv420p" | "yuv422p" | "yuv444p" | "rgba"; quality?: VideoQuality; bitrate?: number; fps?: number; resolution?: { width?: number; height?: number; fit?: VideoFit; }; }OptionalDefault——node22 · node24 · node26
options.convert.audioCodecPublished options.convert.audioCodec option."copy" | "none" | "aac" | "libopus" | "libvorbis" | "mp3"OptionalDefault—
6 values
"copy" "none" "aac" "libopus" "libvorbis" "mp3"
node22 · node24 · node26
options.convert.bitratePublished options.convert.bitrate option.numberOptionalDefault——node22 · node24 · node26
options.convert.formatPublished options.convert.format option.VideoOutputFormatOptionalDefault—
5 values
"mp4" "webm" "avi" "mov" "mkv"
node22 · node24 · node26
options.convert.fpsPublished options.convert.fps option.numberOptionalDefault——node22 · node24 · node26
options.convert.outputPathPublished options.convert.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.convert.pixelFormatPublished options.convert.pixelFormat option."yuv420p" | "yuv422p" | "yuv444p" | "rgba"OptionalDefault—"yuv420p" "yuv422p" "yuv444p" "rgba"node22 · node24 · node26
options.convert.qualityPublished options.convert.quality option.VideoQualityOptionalDefault—"low" "medium" "high" "ultra"node22 · node24 · node26
options.convert.resolutionPublished options.convert.resolution option.{ width?: number; height?: number; fit?: VideoFit; }OptionalDefault——node22 · node24 · node26
options.convert.resolution.fitPublished options.convert.resolution.fit option.VideoFitOptionalDefault—"contain" "cover" "stretch"node22 · node24 · node26
options.convert.resolution.heightPublished options.convert.resolution.height option.numberOptionalDefault——node22 · node24 · node26
options.convert.resolution.widthPublished options.convert.resolution.width option.numberOptionalDefault——node22 · node24 · node26
options.convert.videoCodecPublished options.convert.videoCodec option."copy" | "libx264" | "libx265" | "libvpx-vp9" | "libaom-av1"OptionalDefault—
5 values
"copy" "libx264" "libx265" "libvpx-vp9" "libaom-av1"
node22 · node24 · node26
options.createFromFramesPublished options.createFromFrames option.{ frames: VideoSource[]; outputPath: string; fps?: number; format?: VideoOutputFormat; quality?: VideoQuality; bitrate?: number; resolution?: { width?: number; height?: number; fit?: VideoFit; }; }OptionalDefault——node22 · node24 · node26
options.createFromFrames.bitratePublished options.createFromFrames.bitrate option.numberOptionalDefault——node22 · node24 · node26
options.createFromFrames.formatPublished options.createFromFrames.format option.VideoOutputFormatOptionalDefault—
5 values
"mp4" "webm" "avi" "mov" "mkv"
node22 · node24 · node26
options.createFromFrames.fpsPublished options.createFromFrames.fps option.numberOptionalDefault——node22 · node24 · node26
options.createFromFrames.framesPublished options.createFromFrames.frames option.VideoSource[]RequiredDefaultRequired—node22 · node24 · node26
options.createFromFrames.outputPathPublished options.createFromFrames.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.createFromFrames.qualityPublished options.createFromFrames.quality option.VideoQualityOptionalDefault—"low" "medium" "high" "ultra"node22 · node24 · node26
options.createFromFrames.resolutionPublished options.createFromFrames.resolution option.{ width?: number; height?: number; fit?: VideoFit; }OptionalDefault——node22 · node24 · node26
options.createFromFrames.resolution.fitPublished options.createFromFrames.resolution.fit option.VideoFitOptionalDefault—"contain" "cover" "stretch"node22 · node24 · node26
options.createFromFrames.resolution.heightPublished options.createFromFrames.resolution.height option.numberOptionalDefault——node22 · node24 · node26
options.createFromFrames.resolution.widthPublished options.createFromFrames.resolution.width option.numberOptionalDefault——node22 · node24 · node26
options.createLoopPublished options.createLoop option.{ outputPath: string; smooth?: boolean; }OptionalDefault——node22 · node24 · node26
options.createLoop.outputPathPublished options.createLoop.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.createLoop.smoothPublished options.createLoop.smooth option.booleanOptionalDefault—false truenode22 · node24 · node26
options.createTimeLapsePublished options.createTimeLapse option.{ speed?: number; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.createTimeLapse.outputPathPublished options.createTimeLapse.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.createTimeLapse.speedPublished options.createTimeLapse.speed option.numberOptionalDefault——node22 · node24 · node26
options.cropPublished options.crop option.{ x: number; y: number; width: number; height: number; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.crop.heightPublished options.crop.height option.numberRequiredDefaultRequired—node22 · node24 · node26
options.crop.outputPathPublished options.crop.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.crop.widthPublished options.crop.width option.numberRequiredDefaultRequired—node22 · node24 · node26
options.crop.xPublished options.crop.x option.numberRequiredDefaultRequired—node22 · node24 · node26
options.crop.yPublished options.crop.y option.numberRequiredDefaultRequired—node22 · node24 · node26
options.detectFormatPublished options.detectFormat option.booleanOptionalDefault—false truenode22 · node24 · node26
options.detectScenesPublished options.detectScenes option.{ threshold?: number; outputPath?: string; }OptionalDefault——node22 · node24 · node26
options.detectScenes.outputPathPublished options.detectScenes.outputPath option.stringOptionalDefault——node22 · node24 · node26
options.detectScenes.thresholdPublished options.detectScenes.threshold option.numberOptionalDefault——node22 · node24 · node26
options.exportPresetPublished options.exportPreset option.{ preset: "youtube" | "instagram" | "tiktok" | "twitter" | "facebook" | "4k" | "1080p" | "720p" | "mobile" | "web"; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.exportPreset.outputPathPublished options.exportPreset.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.exportPreset.presetPublished options.exportPreset.preset option."youtube" | "instagram" | "tiktok" | "twitter" | "facebook" | "4k" | "1080p" | "720p" | "mobile" | "web"RequiredDefaultRequired
10 values
"youtube" "instagram" "tiktok" "twitter" "facebook" "4k" "1080p" "720p" "mobile" "web"
node22 · node24 · node26
options.extractAllFramesPublished options.extractAllFrames option.{ outputFormat?: "jpg" | "png"; outputDirectory?: string; quality?: number; prefix?: string; startTime?: number; endTime?: number; }OptionalDefault——node22 · node24 · node26
options.extractAllFrames.endTimePublished options.extractAllFrames.endTime option.numberOptionalDefault——node22 · node24 · node26
options.extractAllFrames.outputDirectoryPublished options.extractAllFrames.outputDirectory option.stringOptionalDefault——node22 · node24 · node26
options.extractAllFrames.outputFormatPublished options.extractAllFrames.outputFormat option."jpg" | "png"OptionalDefault—"jpg" "png"node22 · node24 · node26
options.extractAllFrames.prefixPublished options.extractAllFrames.prefix option.stringOptionalDefault——node22 · node24 · node26
options.extractAllFrames.qualityPublished options.extractAllFrames.quality option.numberOptionalDefault——node22 · node24 · node26
options.extractAllFrames.startTimePublished options.extractAllFrames.startTime option.numberOptionalDefault——node22 · node24 · node26
options.extractAudioPublished options.extractAudio option.{ outputPath: string; format?: "aac" | "mp3" | "wav" | "ogg"; bitrate?: number; }OptionalDefault——node22 · node24 · node26
options.extractAudio.bitratePublished options.extractAudio.bitrate option.numberOptionalDefault——node22 · node24 · node26
options.extractAudio.formatPublished options.extractAudio.format option."aac" | "mp3" | "wav" | "ogg"OptionalDefault—"aac" "mp3" "wav" "ogg"node22 · node24 · node26
options.extractAudio.outputPathPublished options.extractAudio.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.extractFramePublished options.extractFrame option.{ time?: number; frame?: number; width?: number; height?: number; outputFormat?: "jpg" | "png"; quality?: number; }OptionalDefault——node22 · node24 · node26
options.extractFrame.framePublished options.extractFrame.frame option.numberOptionalDefault——node22 · node24 · node26
options.extractFrame.heightPublished options.extractFrame.height option.numberOptionalDefault——node22 · node24 · node26
options.extractFrame.outputFormatPublished options.extractFrame.outputFormat option."jpg" | "png"OptionalDefault—"jpg" "png"node22 · node24 · node26
options.extractFrame.qualityPublished options.extractFrame.quality option.numberOptionalDefault——node22 · node24 · node26
options.extractFrame.timePublished options.extractFrame.time option.numberOptionalDefault——node22 · node24 · node26
options.extractFrame.widthPublished options.extractFrame.width option.numberOptionalDefault——node22 · node24 · node26
options.extractFramesPublished options.extractFrames option.{ times?: number[]; interval?: number; frameSelection?: { start?: number; end?: number; }; outputFormat?: "jpg" | "png"; quality?: number; outputDirectory?: string; }OptionalDefault——node22 · node24 · node26
options.extractFrames.frameSelectionPublished options.extractFrames.frameSelection option.{ start?: number; end?: number; }OptionalDefault——node22 · node24 · node26
options.extractFrames.frameSelection.endPublished options.extractFrames.frameSelection.end option.numberOptionalDefault——node22 · node24 · node26
options.extractFrames.frameSelection.startPublished options.extractFrames.frameSelection.start option.numberOptionalDefault——node22 · node24 · node26
options.extractFrames.intervalPublished options.extractFrames.interval option.numberOptionalDefault——node22 · node24 · node26
options.extractFrames.outputDirectoryPublished options.extractFrames.outputDirectory option.stringOptionalDefault——node22 · node24 · node26
options.extractFrames.outputFormatPublished options.extractFrames.outputFormat option."jpg" | "png"OptionalDefault—"jpg" "png"node22 · node24 · node26
options.extractFrames.qualityPublished options.extractFrames.quality option.numberOptionalDefault——node22 · node24 · node26
options.extractFrames.timesPublished options.extractFrames.times option.number[]OptionalDefault——node22 · node24 · node26
options.freezeFramePublished options.freezeFrame option.{ time: number; duration: number; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.freezeFrame.durationPublished options.freezeFrame.duration option.numberRequiredDefaultRequired—node22 · node24 · node26
options.freezeFrame.outputPathPublished options.freezeFrame.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.freezeFrame.timePublished options.freezeFrame.time option.numberRequiredDefaultRequired—node22 · node24 · node26
options.generatePreviewPublished options.generatePreview option.{ count?: number; outputDirectory?: string; outputFormat?: "jpg" | "png"; quality?: number; }OptionalDefault——node22 · node24 · node26
options.generatePreview.countPublished options.generatePreview.count option.numberOptionalDefault——node22 · node24 · node26
options.generatePreview.outputDirectoryPublished options.generatePreview.outputDirectory option.stringOptionalDefault——node22 · node24 · node26
options.generatePreview.outputFormatPublished options.generatePreview.outputFormat option."jpg" | "png"OptionalDefault—"jpg" "png"node22 · node24 · node26
options.generatePreview.qualityPublished options.generatePreview.quality option.numberOptionalDefault——node22 · node24 · node26
options.generateThumbnailPublished options.generateThumbnail option.{ count?: number; grid?: { cols: number; rows: number; }; width?: number; height?: number; outputFormat?: "jpg" | "png"; quality?: number; }OptionalDefault——node22 · node24 · node26
options.generateThumbnail.countPublished options.generateThumbnail.count option.numberOptionalDefault——node22 · node24 · node26
options.generateThumbnail.gridPublished options.generateThumbnail.grid option.{ cols: number; rows: number; }OptionalDefault——node22 · node24 · node26
options.generateThumbnail.grid.colsPublished options.generateThumbnail.grid.cols option.numberRequiredDefaultRequired—node22 · node24 · node26
options.generateThumbnail.grid.rowsPublished options.generateThumbnail.grid.rows option.numberRequiredDefaultRequired—node22 · node24 · node26
options.generateThumbnail.heightPublished options.generateThumbnail.height option.numberOptionalDefault——node22 · node24 · node26
options.generateThumbnail.outputFormatPublished options.generateThumbnail.outputFormat option."jpg" | "png"OptionalDefault—"jpg" "png"node22 · node24 · node26
options.generateThumbnail.qualityPublished options.generateThumbnail.quality option.numberOptionalDefault——node22 · node24 · node26
options.generateThumbnail.widthPublished options.generateThumbnail.width option.numberOptionalDefault——node22 · node24 · node26
options.getInfoPublished options.getInfo option.booleanOptionalDefault—false truenode22 · node24 · node26
options.mergePublished options.merge option.{ videos: VideoSource[]; outputPath: string; mode?: "grid" | "sequential" | "side-by-side"; direction?: "horizontal" | "vertical"; grid?: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }; audioPolicy?: VideoAudioPolicy; }OptionalDefault——node22 · node24 · node26
options.merge.audioPolicyPublished options.merge.audioPolicy option.VideoAudioPolicyOptionalDefault—"none" "preserve" "first" "mix"node22 · node24 · node26
options.merge.directionPublished options.merge.direction option."horizontal" | "vertical"OptionalDefault—"horizontal" "vertical"node22 · node24 · node26
options.merge.gridPublished options.merge.grid option.{ cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }OptionalDefault——node22 · node24 · node26
options.merge.grid.backgroundPublished options.merge.grid.background option.stringOptionalDefault——node22 · node24 · node26
options.merge.grid.cellHeightPublished options.merge.grid.cellHeight option.numberOptionalDefault——node22 · node24 · node26
options.merge.grid.cellWidthPublished options.merge.grid.cellWidth option.numberOptionalDefault——node22 · node24 · node26
options.merge.grid.colsPublished options.merge.grid.cols option.numberOptionalDefault——node22 · node24 · node26
options.merge.grid.gapPublished options.merge.grid.gap option.numberOptionalDefault——node22 · node24 · node26
options.merge.grid.rowsPublished options.merge.grid.rows option.numberOptionalDefault——node22 · node24 · node26
options.merge.modePublished options.merge.mode option."grid" | "sequential" | "side-by-side"OptionalDefault—"grid" "sequential" "side-by-side"node22 · node24 · node26
options.merge.outputPathPublished options.merge.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.merge.videosPublished options.merge.videos option.VideoSource[]RequiredDefaultRequired—node22 · node24 · node26
options.mixAudioPublished options.mixAudio option.MixAudioOperationOptionalDefault——node22 · node24 · node26
options.mixAudio.durationPolicyOutput length policy. `video` is the stable default."video" | "shortest" | "longest"OptionalDefault—"video" "shortest" "longest"node22 · node24 · node26
options.mixAudio.keepOriginalAudioPublished options.mixAudio.keepOriginalAudio option.booleanOptionalDefault—false truenode22 · node24 · node26
options.mixAudio.originalPitchSemitonesPublished options.mixAudio.originalPitchSemitones option.numberOptionalDefault——node22 · node24 · node26
options.mixAudio.originalSpeedPublished options.mixAudio.originalSpeed option.numberOptionalDefault——node22 · node24 · node26
options.mixAudio.originalVolumePublished options.mixAudio.originalVolume option.numberOptionalDefault——node22 · node24 · node26
options.mixAudio.outputPathPublished options.mixAudio.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.mixAudio.overlaysPublished options.mixAudio.overlays option.MixAudioOverlayClip[]RequiredDefaultRequired—node22 · node24 · node26
options.mixAudio.overlays.durationPublished options.mixAudio.overlays.duration option.numberOptionalDefault——node22 · node24 · node26
options.mixAudio.overlays.fadeInPublished options.mixAudio.overlays.fadeIn option.numberOptionalDefault——node22 · node24 · node26
options.mixAudio.overlays.fadeOutPublished options.mixAudio.overlays.fadeOut option.numberOptionalDefault——node22 · node24 · node26
options.mixAudio.overlays.panStereo pan from -1 (left) to +1 (right).numberOptionalDefault——node22 · node24 · node26
options.mixAudio.overlays.pitchSemitonesPublished options.mixAudio.overlays.pitchSemitones option.numberOptionalDefault——node22 · node24 · node26
options.mixAudio.overlays.sourcePublished options.mixAudio.overlays.source option.VideoSourceRequiredDefaultRequired—node22 · node24 · node26
options.mixAudio.overlays.sourceStartPublished options.mixAudio.overlays.sourceStart option.numberOptionalDefault——node22 · node24 · node26
options.mixAudio.overlays.speedPublished options.mixAudio.overlays.speed option.numberOptionalDefault——node22 · node24 · node26
options.mixAudio.overlays.startTimePublished options.mixAudio.overlays.startTime option.numberRequiredDefaultRequired—node22 · node24 · node26
options.mixAudio.overlays.volumePublished options.mixAudio.overlays.volume option.numberOptionalDefault——node22 · node24 · node26
options.mutePublished options.mute option.{ outputPath: string; ranges?: { start: number; end: number; }[]; }OptionalDefault——node22 · node24 · node26
options.mute.outputPathPublished options.mute.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.mute.rangesPublished options.mute.ranges option.{ start: number; end: number; }[]OptionalDefault——node22 · node24 · node26
options.mute.ranges.endPublished options.mute.ranges.end option.numberRequiredDefaultRequired—node22 · node24 · node26
options.mute.ranges.startPublished options.mute.ranges.start option.numberRequiredDefaultRequired—node22 · node24 · node26
options.normalizeAudioPublished options.normalizeAudio option.{ targetLevel?: number; method?: "peak" | "rms" | "lufs"; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.normalizeAudio.methodPublished options.normalizeAudio.method option."peak" | "rms" | "lufs"OptionalDefault—"peak" "rms" "lufs"node22 · node24 · node26
options.normalizeAudio.outputPathPublished options.normalizeAudio.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.normalizeAudio.targetLevelPublished options.normalizeAudio.targetLevel option.numberOptionalDefault——node22 · node24 · node26
options.onProgressPublished options.onProgress option.(progress: FfmpegProgress) => voidOptionalDefault——node22 · node24 · node26
options.overwriteExisting output policy. Defaults to true for backward compatibility.booleanOptionalDefault—false truenode22 · node24 · node26
options.pictureInPicturePublished options.pictureInPicture option.{ overlayVideo: VideoSource; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; size?: { width?: number; height?: number; fit?: VideoFit; }; opacity?: number; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.pictureInPicture.opacityPublished options.pictureInPicture.opacity option.numberOptionalDefault——node22 · node24 · node26
options.pictureInPicture.outputPathPublished options.pictureInPicture.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.pictureInPicture.overlayVideoPublished options.pictureInPicture.overlayVideo option.VideoSourceRequiredDefaultRequired—node22 · node24 · node26
options.pictureInPicture.positionPublished options.pictureInPicture.position option."center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"OptionalDefault—
5 values
"center" "top-left" "top-right" "bottom-left" "bottom-right"
node22 · node24 · node26
options.pictureInPicture.sizePublished options.pictureInPicture.size option.{ width?: number; height?: number; fit?: VideoFit; }OptionalDefault——node22 · node24 · node26
options.pictureInPicture.size.fitPublished options.pictureInPicture.size.fit option.VideoFitOptionalDefault—"contain" "cover" "stretch"node22 · node24 · node26
options.pictureInPicture.size.heightPublished options.pictureInPicture.size.height option.numberOptionalDefault——node22 · node24 · node26
options.pictureInPicture.size.widthPublished options.pictureInPicture.size.width option.numberOptionalDefault——node22 · node24 · node26
options.removeAudioPublished options.removeAudio option.{ outputPath: string; }OptionalDefault——node22 · node24 · node26
options.removeAudio.outputPathPublished options.removeAudio.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.replaceSegmentPublished options.replaceSegment option.{ replacementVideo?: VideoSource; replacementStartTime?: number; replacementDuration?: number; replacementFrames?: VideoSource[]; replacementFps?: number; targetStartTime: number; targetEndTime: number; durationPolicy?: "fit" | "preserve" | "trim"; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.replaceSegment.durationPolicyfit scales replacement time to the target span; trim truncates/pads; preserve changes total duration."fit" | "preserve" | "trim"OptionalDefault—"fit" "preserve" "trim"node22 · node24 · node26
options.replaceSegment.outputPathPublished options.replaceSegment.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.replaceSegment.replacementDurationPublished options.replaceSegment.replacementDuration option.numberOptionalDefault——node22 · node24 · node26
options.replaceSegment.replacementFpsPublished options.replaceSegment.replacementFps option.numberOptionalDefault——node22 · node24 · node26
options.replaceSegment.replacementFramesPublished options.replaceSegment.replacementFrames option.VideoSource[]OptionalDefault——node22 · node24 · node26
options.replaceSegment.replacementStartTimePublished options.replaceSegment.replacementStartTime option.numberOptionalDefault——node22 · node24 · node26
options.replaceSegment.replacementVideoPublished options.replaceSegment.replacementVideo option.VideoSourceOptionalDefault——node22 · node24 · node26
options.replaceSegment.targetEndTimePublished options.replaceSegment.targetEndTime option.numberRequiredDefaultRequired—node22 · node24 · node26
options.replaceSegment.targetStartTimePublished options.replaceSegment.targetStartTime option.numberRequiredDefaultRequired—node22 · node24 · node26
options.reversePublished options.reverse option.{ outputPath: string; }OptionalDefault——node22 · node24 · node26
options.reverse.outputPathPublished options.reverse.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.rotatePublished options.rotate option.{ angle?: 90 | 180 | 270; flip?: "horizontal" | "vertical" | "both"; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.rotate.anglePublished options.rotate.angle option.90 | 180 | 270OptionalDefault—90 180 270node22 · node24 · node26
options.rotate.flipPublished options.rotate.flip option."horizontal" | "vertical" | "both"OptionalDefault—"horizontal" "vertical" "both"node22 · node24 · node26
options.rotate.outputPathPublished options.rotate.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.signalAbort remote resolution and the active FFmpeg/ffprobe process.AbortSignalOptionalDefault——node22 · node24 · node26
options.sourcePublished options.source option.VideoSourceRequiredDefaultRequired—node22 · node24 · node26
options.splitScreenPublished options.splitScreen option.{ videos: VideoSource[]; layout?: "grid" | "side-by-side" | "top-bottom"; grid?: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }; audioPolicy?: VideoAudioPolicy; outputPath: string; }OptionalDefault——node22 · node24 · node26
options.splitScreen.audioPolicyPublished options.splitScreen.audioPolicy option.VideoAudioPolicyOptionalDefault—"none" "preserve" "first" "mix"node22 · node24 · node26
options.splitScreen.gridPublished options.splitScreen.grid option.{ cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }OptionalDefault——node22 · node24 · node26
options.splitScreen.grid.backgroundPublished options.splitScreen.grid.background option.stringOptionalDefault——node22 · node24 · node26
options.splitScreen.grid.cellHeightPublished options.splitScreen.grid.cellHeight option.numberOptionalDefault——node22 · node24 · node26
options.splitScreen.grid.cellWidthPublished options.splitScreen.grid.cellWidth option.numberOptionalDefault——node22 · node24 · node26
options.splitScreen.grid.colsPublished options.splitScreen.grid.cols option.numberOptionalDefault——node22 · node24 · node26
options.splitScreen.grid.gapPublished options.splitScreen.grid.gap option.numberOptionalDefault——node22 · node24 · node26
options.splitScreen.grid.rowsPublished options.splitScreen.grid.rows option.numberOptionalDefault——node22 · node24 · node26
options.splitScreen.layoutPublished options.splitScreen.layout option."grid" | "side-by-side" | "top-bottom"OptionalDefault—"grid" "side-by-side" "top-bottom"node22 · node24 · node26
options.splitScreen.outputPathPublished options.splitScreen.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.splitScreen.videosPublished options.splitScreen.videos option.VideoSource[]RequiredDefaultRequired—node22 · node24 · node26
options.stabilizePublished options.stabilize option.{ outputPath: string; smoothing?: number; }OptionalDefault——node22 · node24 · node26
options.stabilize.outputPathPublished options.stabilize.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.stabilize.smoothingPublished options.stabilize.smoothing option.numberOptionalDefault——node22 · node24 · node26
options.timeoutMsPer-operation process timeout. Defaults to runtime FFmpeg policy.numberOptionalDefault——node22 · node24 · node26
options.trimAccurate mode re-encodes for timestamp precision; copy mode is keyframe-bound.{ startTime: number; endTime: number; outputPath: string; mode?: "copy" | "accurate"; }OptionalDefault——node22 · node24 · node26
options.trim.endTimePublished options.trim.endTime option.numberRequiredDefaultRequired—node22 · node24 · node26
options.trim.modePublished options.trim.mode option."copy" | "accurate"OptionalDefault—"copy" "accurate"node22 · node24 · node26
options.trim.outputPathPublished options.trim.outputPath option.stringRequiredDefaultRequired—node22 · node24 · node26
options.trim.startTimePublished options.trim.startTime option.numberRequiredDefaultRequired—node22 · node24 · node26
painterOpts
painterOpts.resolveAssetRefsWhen **true**, string leaves in the payload are resolved via {@link AssetManager.resolve } (same rules as {@link ApexPainter.prepareForRender } / {@link ApexPainter.renderScene }).booleanOptionalDefault—false truenode22 · node24 · node26

options.addAnimatedText

Optional

Published options.addAnimatedText option.

Type
{ text: string; animation?: "zoom" | "rotate" | "fadeIn" | "fadeOut" | "slideIn" | "slideOut" | "bounce" | "typewriter"; startTime: number; endTime: number; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center" | { x: number; y: number; }; fontSize?: number; fontColor?: string; fontPath?: string; fontName?: string; fontFamily?: string; backgroundColor?: string; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addAnimatedText.animation

Optional

Published options.addAnimatedText.animation option.

Type
"zoom" | "rotate" | "fadeIn" | "fadeOut" | "slideIn" | "slideOut" | "bounce" | "typewriter"
Default
—
Allowed
8 values
"zoom" "rotate" "fadeIn" "fadeOut" "slideIn" "slideOut" "bounce" "typewriter"
Runtime
node22, node24, node26

options.addAnimatedText.position

Optional

Published options.addAnimatedText.position option.

Type
"center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center" | { x: number; y: number; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addAnimatedText.text

Required

Published options.addAnimatedText.text option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.addFade

Optional

Published options.addFade option.

Type
{ fadeIn?: number; fadeOut?: number; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addFade.fadeIn

Optional

Published options.addFade.fadeIn option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addFade.fadeOut

Optional

Published options.addFade.fadeOut option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addFade.outputPath

Required

Published options.addFade.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.addText

Optional

Published options.addText option.

Type
{ text: string; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center"; fontSize?: number; fontColor?: string; backgroundColor?: string; startTime?: number; endTime?: number; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addText.endTime

Optional

Published options.addText.endTime option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addText.fontColor

Optional

Published options.addText.fontColor option.

Type
string
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addText.fontSize

Optional

Published options.addText.fontSize option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addText.outputPath

Required

Published options.addText.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.addText.position

Optional

Published options.addText.position option.

Type
"center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center"
Default
—
Allowed
7 values
"center" "top-left" "top-right" "bottom-left" "bottom-right" "top-center" "bottom-center"
Runtime
node22, node24, node26

options.addText.startTime

Optional

Published options.addText.startTime option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addText.text

Required

Published options.addText.text option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.addTextOverlay

Optional

Published options.addTextOverlay option.

Type
VideoTextOverlayOperation
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addTextOverlay.overlays

Required

Published options.addTextOverlay.overlays option.

Type
VideoTextOverlayClip[]
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.addTextOverlay.overlays.decorations

Optional

Grouped line decorations (`underline` / `overline` / `strikethrough`) and optional `bold` / `italic` flags for the canvas font string. Nested keys override the legacy flat fields (see {@link resolveTextDecorations}).

Type
TextDecorations
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addTextOverlay.overlays.effects

Optional

Grouped highlight, glow, and shadow. When set, entries override the legacy flat fields (see {@link resolveTextEffects}).

Type
TextEffects
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addTextOverlay.overlays.fill

Optional

Grouped fill color / gradient and draw opacity (see {@link resolveTextFill}).

Type
TextFill
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addTextOverlay.overlays.font

Optional

Published options.addTextOverlay.overlays.font option.

Type
{ size?: number; family?: string; name?: string; path?: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addTextOverlay.overlays.overlayOpacity

Optional

Master overlay opacity 0–1 (default `1`), multiplied with transition fades. Distinct from {@link TextProperties.fill} / `opacity` on glyphs.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addTextOverlay.overlays.stroke.style

Optional

Published options.addTextOverlay.overlays.stroke.style option.

Type
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"
Default
—
Allowed
6 values
"solid" "dashed" "dotted" "groove" "ridge" "double"
Runtime
node22, node24, node26

options.addTextOverlay.overlays.textAlign

Optional

Published options.addTextOverlay.overlays.textAlign option.

Type
TextAlignMode
Default
—
Allowed
5 values
"center" "left" "right" "start" "end"
Runtime
node22, node24, node26

options.addTextOverlay.overlays.textBaseline

Optional

Published options.addTextOverlay.overlays.textBaseline option.

Type
TextBaselineMode
Default
—
Allowed
6 values
"top" "bottom" "alphabetic" "hanging" "ideographic" "middle"
Runtime
node22, node24, node26

options.addTextOverlay.overlays.transitionIn.custom

Optional

Advanced: override auto-built expressions (`t` variable, main video `w`/`h`). When set, merged with preset (preset fills missing keys).

Type
{ x?: string; y?: string; alpha?: string; scale?: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addTextOverlay.overlays.transitionIn.type

Required

Published options.addTextOverlay.overlays.transitionIn.type option.

Type
VideoTextTransitionPreset
Default
Required
Allowed
14 values
"none" "fade" "fadeIn" "fadeOut" "slideIn" "slideOut" "slideLeft" "slideRight" "slideUp" "slideDown" "zoomIn" "zoomOut" "bounce" "typewriter"
Runtime
node22, node24, node26

options.addTextOverlay.overlays.transitionOut.custom

Optional

Advanced: override auto-built expressions (`t` variable, main video `w`/`h`). When set, merged with preset (preset fills missing keys).

Type
{ x?: string; y?: string; alpha?: string; scale?: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addTextOverlay.overlays.transitionOut.type

Required

Published options.addTextOverlay.overlays.transitionOut.type option.

Type
VideoTextTransitionPreset
Default
Required
Allowed
14 values
"none" "fade" "fadeIn" "fadeOut" "slideIn" "slideOut" "slideLeft" "slideRight" "slideUp" "slideDown" "zoomIn" "zoomOut" "bounce" "typewriter"
Runtime
node22, node24, node26

options.addTransition

Optional

Published options.addTransition option.

Type
{ type: "circle" | "blur" | "zoom" | "fade" | "wipe" | "slide" | "rotate" | "dissolve" | "pixelize"; duration: number; direction?: "left" | "right" | "up" | "down" | "in" | "out"; secondVideo?: VideoSource; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addTransition.direction

Optional

Published options.addTransition.direction option.

Type
"left" | "right" | "up" | "down" | "in" | "out"
Default
—
Allowed
6 values
"left" "right" "up" "down" "in" "out"
Runtime
node22, node24, node26

options.addTransition.duration

Required

Published options.addTransition.duration option.

Type
number
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.addTransition.type

Required

Published options.addTransition.type option.

Type
"circle" | "blur" | "zoom" | "fade" | "wipe" | "slide" | "rotate" | "dissolve" | "pixelize"
Default
Required
Allowed
9 values
"circle" "blur" "zoom" "fade" "wipe" "slide" "rotate" "dissolve" "pixelize"
Runtime
node22, node24, node26

options.addWatermark

Optional

Published options.addWatermark option.

Type
{ watermarkPath: VideoSource; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; opacity?: number; size?: { width?: number; height?: number; fit?: VideoFit; }; marginX?: number; marginY?: number; startTime?: number; endTime?: number; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addWatermark.endTime

Optional

Published options.addWatermark.endTime option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addWatermark.marginX

Optional

Published options.addWatermark.marginX option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addWatermark.marginY

Optional

Published options.addWatermark.marginY option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addWatermark.opacity

Optional

Published options.addWatermark.opacity option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addWatermark.position

Optional

Published options.addWatermark.position option.

Type
"center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"
Default
—
Allowed
5 values
"center" "top-left" "top-right" "bottom-left" "bottom-right"
Runtime
node22, node24, node26

options.addWatermark.size

Optional

Published options.addWatermark.size option.

Type
{ width?: number; height?: number; fit?: VideoFit; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.addWatermark.size.fit

Optional

Published options.addWatermark.size.fit option.

Type
VideoFit
Default
—
Allowed
"contain" "cover" "stretch"
Runtime
node22, node24, node26

options.adjustVolume

Optional

Published options.adjustVolume option.

Type
{ outputPath: string; volume?: number; ranges?: { start: number; end: number; volume: number; speed?: number; pitchSemitones?: number; }[]; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.adjustVolume.ranges

Optional

Published options.adjustVolume.ranges option.

Type
{ start: number; end: number; volume: number; speed?: number; pitchSemitones?: number; }[]
Default
—
Allowed
—
Runtime
node22, node24, node26

options.adjustVolume.volume

Optional

Published options.adjustVolume.volume option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.applyEffects

Optional

Published options.applyEffects option.

Type
{ filters: { type: "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"; intensity?: number; value?: number; }[]; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.applyEffects.filters

Required

Published options.applyEffects.filters option.

Type
{ type: "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"; intensity?: number; value?: number; }[]
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.applyEffects.filters.type

Required

Published options.applyEffects.filters.type option.

Type
"saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"
Default
Required
Allowed
9 values
"saturation" "sharpen" "noise" "invert" "grayscale" "sepia" "brightness" "contrast" "blur"
Runtime
node22, node24, node26

options.applyLUT

Optional

Published options.applyLUT option.

Type
{ lutPath: string; intensity?: number; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.applyLUT.intensity

Optional

Published options.applyLUT.intensity option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.applyLUT.lutPath

Required

Published options.applyLUT.lutPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.applyLUT.outputPath

Required

Published options.applyLUT.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.batch

Optional

Published options.batch option.

Type
{ videos: { source: VideoSource; operations: Record<string, unknown>; }[]; outputDirectory: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.batch.outputDirectory

Required

Published options.batch.outputDirectory option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.batch.videos

Required

Published options.batch.videos option.

Type
{ source: VideoSource; operations: Record<string, unknown>; }[]
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.batch.videos.operations

Required

Published options.batch.videos.operations option.

Type
Record<string, unknown>
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.batch.videos.source

Required

Published options.batch.videos.source option.

Type
VideoSource
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.changeSpeed

Optional

Published options.changeSpeed option.

Type
{ speed: number; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.changeSpeed.outputPath

Required

Published options.changeSpeed.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.changeSpeed.speed

Required

Published options.changeSpeed.speed option.

Type
number
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.colorCorrect

Optional

Published options.colorCorrect option.

Type
{ brightness?: number; contrast?: number; saturation?: number; hue?: number; temperature?: number; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.colorCorrect.hue

Optional

Published options.colorCorrect.hue option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.compress

Optional

Published options.compress option.

Type
{ outputPath: string; quality?: VideoQuality; targetSize?: number; maxBitrate?: number; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.compress.maxBitrate

Optional

Published options.compress.maxBitrate option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.compress.outputPath

Required

Published options.compress.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.compress.quality

Optional

Published options.compress.quality option.

Type
VideoQuality
Default
—
Allowed
"low" "medium" "high" "ultra"
Runtime
node22, node24, node26

options.compress.targetSize

Optional

Published options.compress.targetSize option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.convert

Optional

Published options.convert option.

Type
{ outputPath: string; format?: VideoOutputFormat; videoCodec?: "copy" | "libx264" | "libx265" | "libvpx-vp9" | "libaom-av1"; audioCodec?: "copy" | "none" | "aac" | "libopus" | "libvorbis" | "mp3"; pixelFormat?: "yuv420p" | "yuv422p" | "yuv444p" | "rgba"; quality?: VideoQuality; bitrate?: number; fps?: number; resolution?: { width?: number; height?: number; fit?: VideoFit; }; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.convert.audioCodec

Optional

Published options.convert.audioCodec option.

Type
"copy" | "none" | "aac" | "libopus" | "libvorbis" | "mp3"
Default
—
Allowed
6 values
"copy" "none" "aac" "libopus" "libvorbis" "mp3"
Runtime
node22, node24, node26

options.convert.bitrate

Optional

Published options.convert.bitrate option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.convert.format

Optional

Published options.convert.format option.

Type
VideoOutputFormat
Default
—
Allowed
5 values
"mp4" "webm" "avi" "mov" "mkv"
Runtime
node22, node24, node26

options.convert.fps

Optional

Published options.convert.fps option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.convert.outputPath

Required

Published options.convert.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.convert.pixelFormat

Optional

Published options.convert.pixelFormat option.

Type
"yuv420p" | "yuv422p" | "yuv444p" | "rgba"
Default
—
Allowed
"yuv420p" "yuv422p" "yuv444p" "rgba"
Runtime
node22, node24, node26

options.convert.quality

Optional

Published options.convert.quality option.

Type
VideoQuality
Default
—
Allowed
"low" "medium" "high" "ultra"
Runtime
node22, node24, node26

options.convert.resolution

Optional

Published options.convert.resolution option.

Type
{ width?: number; height?: number; fit?: VideoFit; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.convert.resolution.fit

Optional

Published options.convert.resolution.fit option.

Type
VideoFit
Default
—
Allowed
"contain" "cover" "stretch"
Runtime
node22, node24, node26

options.convert.videoCodec

Optional

Published options.convert.videoCodec option.

Type
"copy" | "libx264" | "libx265" | "libvpx-vp9" | "libaom-av1"
Default
—
Allowed
5 values
"copy" "libx264" "libx265" "libvpx-vp9" "libaom-av1"
Runtime
node22, node24, node26

options.createFromFrames

Optional

Published options.createFromFrames option.

Type
{ frames: VideoSource[]; outputPath: string; fps?: number; format?: VideoOutputFormat; quality?: VideoQuality; bitrate?: number; resolution?: { width?: number; height?: number; fit?: VideoFit; }; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.createFromFrames.format

Optional

Published options.createFromFrames.format option.

Type
VideoOutputFormat
Default
—
Allowed
5 values
"mp4" "webm" "avi" "mov" "mkv"
Runtime
node22, node24, node26

options.createFromFrames.fps

Optional

Published options.createFromFrames.fps option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.createFromFrames.frames

Required

Published options.createFromFrames.frames option.

Type
VideoSource[]
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.createFromFrames.quality

Optional

Published options.createFromFrames.quality option.

Type
VideoQuality
Default
—
Allowed
"low" "medium" "high" "ultra"
Runtime
node22, node24, node26

options.createFromFrames.resolution

Optional

Published options.createFromFrames.resolution option.

Type
{ width?: number; height?: number; fit?: VideoFit; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.createLoop

Optional

Published options.createLoop option.

Type
{ outputPath: string; smooth?: boolean; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.createLoop.outputPath

Required

Published options.createLoop.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.createLoop.smooth

Optional

Published options.createLoop.smooth option.

Type
boolean
Default
—
Allowed
false true
Runtime
node22, node24, node26

options.createTimeLapse

Optional

Published options.createTimeLapse option.

Type
{ speed?: number; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.crop

Optional

Published options.crop option.

Type
{ x: number; y: number; width: number; height: number; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.crop.height

Required

Published options.crop.height option.

Type
number
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.crop.outputPath

Required

Published options.crop.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.crop.width

Required

Published options.crop.width option.

Type
number
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.crop.x

Required

Published options.crop.x option.

Type
number
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.crop.y

Required

Published options.crop.y option.

Type
number
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.detectFormat

Optional

Published options.detectFormat option.

Type
boolean
Default
—
Allowed
false true
Runtime
node22, node24, node26

options.detectScenes

Optional

Published options.detectScenes option.

Type
{ threshold?: number; outputPath?: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.exportPreset

Optional

Published options.exportPreset option.

Type
{ preset: "youtube" | "instagram" | "tiktok" | "twitter" | "facebook" | "4k" | "1080p" | "720p" | "mobile" | "web"; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.exportPreset.preset

Required

Published options.exportPreset.preset option.

Type
"youtube" | "instagram" | "tiktok" | "twitter" | "facebook" | "4k" | "1080p" | "720p" | "mobile" | "web"
Default
Required
Allowed
10 values
"youtube" "instagram" "tiktok" "twitter" "facebook" "4k" "1080p" "720p" "mobile" "web"
Runtime
node22, node24, node26

options.extractAllFrames

Optional

Published options.extractAllFrames option.

Type
{ outputFormat?: "jpg" | "png"; outputDirectory?: string; quality?: number; prefix?: string; startTime?: number; endTime?: number; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.extractAudio

Optional

Published options.extractAudio option.

Type
{ outputPath: string; format?: "aac" | "mp3" | "wav" | "ogg"; bitrate?: number; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.extractAudio.bitrate

Optional

Published options.extractAudio.bitrate option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.extractAudio.format

Optional

Published options.extractAudio.format option.

Type
"aac" | "mp3" | "wav" | "ogg"
Default
—
Allowed
"aac" "mp3" "wav" "ogg"
Runtime
node22, node24, node26

options.extractFrame

Optional

Published options.extractFrame option.

Type
{ time?: number; frame?: number; width?: number; height?: number; outputFormat?: "jpg" | "png"; quality?: number; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.extractFrame.frame

Optional

Published options.extractFrame.frame option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.extractFrame.height

Optional

Published options.extractFrame.height option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.extractFrame.outputFormat

Optional

Published options.extractFrame.outputFormat option.

Type
"jpg" | "png"
Default
—
Allowed
"jpg" "png"
Runtime
node22, node24, node26

options.extractFrame.quality

Optional

Published options.extractFrame.quality option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.extractFrame.time

Optional

Published options.extractFrame.time option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.extractFrame.width

Optional

Published options.extractFrame.width option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.extractFrames

Optional

Published options.extractFrames option.

Type
{ times?: number[]; interval?: number; frameSelection?: { start?: number; end?: number; }; outputFormat?: "jpg" | "png"; quality?: number; outputDirectory?: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.extractFrames.frameSelection

Optional

Published options.extractFrames.frameSelection option.

Type
{ start?: number; end?: number; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.extractFrames.times

Optional

Published options.extractFrames.times option.

Type
number[]
Default
—
Allowed
—
Runtime
node22, node24, node26

options.freezeFrame

Optional

Published options.freezeFrame option.

Type
{ time: number; duration: number; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.freezeFrame.duration

Required

Published options.freezeFrame.duration option.

Type
number
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.freezeFrame.outputPath

Required

Published options.freezeFrame.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.freezeFrame.time

Required

Published options.freezeFrame.time option.

Type
number
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.generatePreview

Optional

Published options.generatePreview option.

Type
{ count?: number; outputDirectory?: string; outputFormat?: "jpg" | "png"; quality?: number; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.generateThumbnail

Optional

Published options.generateThumbnail option.

Type
{ count?: number; grid?: { cols: number; rows: number; }; width?: number; height?: number; outputFormat?: "jpg" | "png"; quality?: number; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.generateThumbnail.grid

Optional

Published options.generateThumbnail.grid option.

Type
{ cols: number; rows: number; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.getInfo

Optional

Published options.getInfo option.

Type
boolean
Default
—
Allowed
false true
Runtime
node22, node24, node26

options.merge

Optional

Published options.merge option.

Type
{ videos: VideoSource[]; outputPath: string; mode?: "grid" | "sequential" | "side-by-side"; direction?: "horizontal" | "vertical"; grid?: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }; audioPolicy?: VideoAudioPolicy; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.merge.audioPolicy

Optional

Published options.merge.audioPolicy option.

Type
VideoAudioPolicy
Default
—
Allowed
"none" "preserve" "first" "mix"
Runtime
node22, node24, node26

options.merge.direction

Optional

Published options.merge.direction option.

Type
"horizontal" | "vertical"
Default
—
Allowed
"horizontal" "vertical"
Runtime
node22, node24, node26

options.merge.grid

Optional

Published options.merge.grid option.

Type
{ cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.merge.grid.cellWidth

Optional

Published options.merge.grid.cellWidth option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.merge.grid.cols

Optional

Published options.merge.grid.cols option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.merge.grid.gap

Optional

Published options.merge.grid.gap option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.merge.grid.rows

Optional

Published options.merge.grid.rows option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.merge.mode

Optional

Published options.merge.mode option.

Type
"grid" | "sequential" | "side-by-side"
Default
—
Allowed
"grid" "sequential" "side-by-side"
Runtime
node22, node24, node26

options.merge.outputPath

Required

Published options.merge.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.merge.videos

Required

Published options.merge.videos option.

Type
VideoSource[]
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.mixAudio

Optional

Published options.mixAudio option.

Type
MixAudioOperation
Default
—
Allowed
—
Runtime
node22, node24, node26

options.mixAudio.durationPolicy

Optional

Output length policy. `video` is the stable default.

Type
"video" | "shortest" | "longest"
Default
—
Allowed
"video" "shortest" "longest"
Runtime
node22, node24, node26

options.mixAudio.outputPath

Required

Published options.mixAudio.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.mixAudio.overlays

Required

Published options.mixAudio.overlays option.

Type
MixAudioOverlayClip[]
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.mute

Optional

Published options.mute option.

Type
{ outputPath: string; ranges?: { start: number; end: number; }[]; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.mute.outputPath

Required

Published options.mute.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.mute.ranges

Optional

Published options.mute.ranges option.

Type
{ start: number; end: number; }[]
Default
—
Allowed
—
Runtime
node22, node24, node26

options.mute.ranges.end

Required

Published options.mute.ranges.end option.

Type
number
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.mute.ranges.start

Required

Published options.mute.ranges.start option.

Type
number
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.normalizeAudio

Optional

Published options.normalizeAudio option.

Type
{ targetLevel?: number; method?: "peak" | "rms" | "lufs"; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.normalizeAudio.method

Optional

Published options.normalizeAudio.method option.

Type
"peak" | "rms" | "lufs"
Default
—
Allowed
"peak" "rms" "lufs"
Runtime
node22, node24, node26

options.onProgress

Optional

Published options.onProgress option.

Type
(progress: FfmpegProgress) => void
Default
—
Allowed
—
Runtime
node22, node24, node26

options.overwrite

Optional

Existing output policy. Defaults to true for backward compatibility.

Type
boolean
Default
—
Allowed
false true
Runtime
node22, node24, node26

options.pictureInPicture

Optional

Published options.pictureInPicture option.

Type
{ overlayVideo: VideoSource; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; size?: { width?: number; height?: number; fit?: VideoFit; }; opacity?: number; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.pictureInPicture.position

Optional

Published options.pictureInPicture.position option.

Type
"center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"
Default
—
Allowed
5 values
"center" "top-left" "top-right" "bottom-left" "bottom-right"
Runtime
node22, node24, node26

options.pictureInPicture.size

Optional

Published options.pictureInPicture.size option.

Type
{ width?: number; height?: number; fit?: VideoFit; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.pictureInPicture.size.fit

Optional

Published options.pictureInPicture.size.fit option.

Type
VideoFit
Default
—
Allowed
"contain" "cover" "stretch"
Runtime
node22, node24, node26

options.removeAudio

Optional

Published options.removeAudio option.

Type
{ outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.removeAudio.outputPath

Required

Published options.removeAudio.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.replaceSegment

Optional

Published options.replaceSegment option.

Type
{ replacementVideo?: VideoSource; replacementStartTime?: number; replacementDuration?: number; replacementFrames?: VideoSource[]; replacementFps?: number; targetStartTime: number; targetEndTime: number; durationPolicy?: "fit" | "preserve" | "trim"; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.replaceSegment.durationPolicy

Optional

fit scales replacement time to the target span; trim truncates/pads; preserve changes total duration.

Type
"fit" | "preserve" | "trim"
Default
—
Allowed
"fit" "preserve" "trim"
Runtime
node22, node24, node26

options.reverse

Optional

Published options.reverse option.

Type
{ outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.reverse.outputPath

Required

Published options.reverse.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.rotate

Optional

Published options.rotate option.

Type
{ angle?: 90 | 180 | 270; flip?: "horizontal" | "vertical" | "both"; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.rotate.angle

Optional

Published options.rotate.angle option.

Type
90 | 180 | 270
Default
—
Allowed
90 180 270
Runtime
node22, node24, node26

options.rotate.flip

Optional

Published options.rotate.flip option.

Type
"horizontal" | "vertical" | "both"
Default
—
Allowed
"horizontal" "vertical" "both"
Runtime
node22, node24, node26

options.rotate.outputPath

Required

Published options.rotate.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.signal

Optional

Abort remote resolution and the active FFmpeg/ffprobe process.

Type
AbortSignal
Default
—
Allowed
—
Runtime
node22, node24, node26

options.source

Required

Published options.source option.

Type
VideoSource
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.splitScreen

Optional

Published options.splitScreen option.

Type
{ videos: VideoSource[]; layout?: "grid" | "side-by-side" | "top-bottom"; grid?: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }; audioPolicy?: VideoAudioPolicy; outputPath: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.splitScreen.audioPolicy

Optional

Published options.splitScreen.audioPolicy option.

Type
VideoAudioPolicy
Default
—
Allowed
"none" "preserve" "first" "mix"
Runtime
node22, node24, node26

options.splitScreen.grid

Optional

Published options.splitScreen.grid option.

Type
{ cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.splitScreen.grid.gap

Optional

Published options.splitScreen.grid.gap option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.splitScreen.layout

Optional

Published options.splitScreen.layout option.

Type
"grid" | "side-by-side" | "top-bottom"
Default
—
Allowed
"grid" "side-by-side" "top-bottom"
Runtime
node22, node24, node26

options.splitScreen.outputPath

Required

Published options.splitScreen.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.splitScreen.videos

Required

Published options.splitScreen.videos option.

Type
VideoSource[]
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.stabilize

Optional

Published options.stabilize option.

Type
{ outputPath: string; smoothing?: number; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.stabilize.outputPath

Required

Published options.stabilize.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.stabilize.smoothing

Optional

Published options.stabilize.smoothing option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.timeoutMs

Optional

Per-operation process timeout. Defaults to runtime FFmpeg policy.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

options.trim

Optional

Accurate mode re-encodes for timestamp precision; copy mode is keyframe-bound.

Type
{ startTime: number; endTime: number; outputPath: string; mode?: "copy" | "accurate"; }
Default
—
Allowed
—
Runtime
node22, node24, node26

options.trim.endTime

Required

Published options.trim.endTime option.

Type
number
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.trim.mode

Optional

Published options.trim.mode option.

Type
"copy" | "accurate"
Default
—
Allowed
"copy" "accurate"
Runtime
node22, node24, node26

options.trim.outputPath

Required

Published options.trim.outputPath option.

Type
string
Default
Required
Allowed
—
Runtime
node22, node24, node26

options.trim.startTime

Required

Published options.trim.startTime option.

Type
number
Default
Required
Allowed
—
Runtime
node22, node24, node26

painterOpts.resolveAssetRefs

Optional

When **true**, string leaves in the payload are resolved via {@link AssetManager.resolve } (same rules as {@link ApexPainter.prepareForRender } / {@link ApexPainter.renderScene }).

Type
boolean
Default
—
Allowed
false true
Runtime
node22, node24, node26

Types

VideoCreationOptions: VideoCreationOptions
  • source
    VideoSource
    • variant 1string
    • variant 2Buffer<ArrayBufferLike>
  • getInfo?boolean
  • extractFrame?
    __type: { time?: number; frame?: number; width?: number; height?: number; outputFormat?: "jpg" | "png"; quality?: number; }
    • time?number
    • frame?number
    • width?number
    • height?number
    • outputFormat?
      "jpg" | "png"
      • variant 1"jpg"
      • variant 2"png"
    • quality?number
  • extractFrames?
    __type: { times?: number[]; interval?: number; frameSelection?: { start?: number; end?: number; }; outputFormat?: "jpg" | "png"; quality?: number; outputDirectory?: string; }
    • times?
      number[]
      • variant 1number
    • interval?number
    • frameSelection?
      __type: { start?: number; end?: number; }
      • start?number
      • end?number
    • outputFormat?
      "jpg" | "png"
      • variant 1"jpg"
      • variant 2"png"
    • quality?number
    • outputDirectory?string
  • extractAllFrames?
    __type: { outputFormat?: "jpg" | "png"; outputDirectory?: string; quality?: number; prefix?: string; startTime?: number; endTime?: number; }
    • outputFormat?
      "jpg" | "png"
      • variant 1"jpg"
      • variant 2"png"
    • outputDirectory?string
    • quality?number
    • prefix?string
    • startTime?number
    • endTime?number
  • generateThumbnail?
    __type: { count?: number; grid?: { cols: number; rows: number; }; width?: number; height?: number; outputFormat?: "jpg" | "png"; quality?: number; }
    • count?number
    • grid?
      __type: { cols: number; rows: number; }
      • colsnumber
      • rowsnumber
    • width?number
    • height?number
    • outputFormat?
      "jpg" | "png"
      • variant 1"jpg"
      • variant 2"png"
    • quality?number
  • convert?
    __type: { outputPath: string; format?: VideoOutputFormat; videoCodec?: "copy" | "libx264" | "libx265" | "libvpx-vp9" | "libaom-av1"; audioCodec?: "copy" | "none" | "aac" | "libopus" | "libvorbis" | "mp3"; pixelFormat?: "yuv420p" | "yuv422p" | "yuv444p" | "rgba"; quality?: VideoQuality; bitrate?: number; fps?: number; resolution?: { width?: number; height?: number; fit?: VideoFit; }; }
    • outputPathstring
    • format?
      VideoOutputFormat
      • variant 1"mp4"
      • variant 2"webm"
      • variant 3"avi"
      • variant 4"mov"
      • variant 5"mkv"
    • videoCodec?
      "copy" | "libx264" | "libx265" | "libvpx-vp9" | "libaom-av1"
      • variant 1"copy"
      • variant 2"libx264"
      • variant 3"libx265"
      • variant 4"libvpx-vp9"
      • variant 5"libaom-av1"
    • audioCodec?
      "copy" | "none" | "aac" | "libopus" | "libvorbis" | "mp3"
      • variant 1"copy"
      • variant 2"none"
      • variant 3"aac"
      • variant 4"libopus"
      • variant 5"libvorbis"
      • variant 6"mp3"
    • pixelFormat?
      "yuv420p" | "yuv422p" | "yuv444p" | "rgba"
      • variant 1"yuv420p"
      • variant 2"yuv422p"
      • variant 3"yuv444p"
      • variant 4"rgba"
    • quality?
      VideoQuality
      • variant 1"low"
      • variant 2"medium"
      • variant 3"high"
      • variant 4"ultra"
    • bitrate?number
    • fps?number
    • resolution?
      __type: { width?: number; height?: number; fit?: VideoFit; }
      • width?number
      • height?number
      • fit?
        VideoFit
        • variant 1"contain"
        • variant 2"cover"
        • variant 3"stretch"
  • trim?
    __type: { startTime: number; endTime: number; outputPath: string; mode?: "copy" | "accurate"; }
    • startTimenumber
    • endTimenumber
    • outputPathstring
    • mode?
      "copy" | "accurate"
      • variant 1"copy"
      • variant 2"accurate"
  • extractAudio?
    __type: { outputPath: string; format?: "aac" | "mp3" | "wav" | "ogg"; bitrate?: number; }
    • outputPathstring
    • format?
      "aac" | "mp3" | "wav" | "ogg"
      • variant 1"aac"
      • variant 2"mp3"
      • variant 3"wav"
      • variant 4"ogg"
    • bitrate?number
  • addWatermark?
    __type: { watermarkPath: VideoSource; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; opacity?: number; size?: { width?: number; height?: number; fit?: VideoFit; }; marginX?: number; marginY?: number; startTime?: number; endTime?: number; outputPath: string; }
    • watermarkPath
      VideoSource
      • variant 1string
      • variant 2Buffer<ArrayBufferLike>
    • position?
      "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"
      • variant 1"center"
      • variant 2"top-left"
      • variant 3"top-right"
      • variant 4"bottom-left"
      • variant 5"bottom-right"
    • opacity?number
    • size?
      __type: { width?: number; height?: number; fit?: VideoFit; }
      • width?number
      • height?number
      • fit?
        VideoFit
        • variant 1"contain"
        • variant 2"cover"
        • variant 3"stretch"
    • marginX?number
    • marginY?number
    • startTime?number
    • endTime?number
    • outputPathstring
  • changeSpeed?
    __type: { speed: number; outputPath: string; }
    • speednumber
    • outputPathstring
  • generatePreview?
    __type: { count?: number; outputDirectory?: string; outputFormat?: "jpg" | "png"; quality?: number; }
    • count?number
    • outputDirectory?string
    • outputFormat?
      "jpg" | "png"
      • variant 1"jpg"
      • variant 2"png"
    • quality?number
  • applyEffects?
    __type: { filters: { type: "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"; intensity?: number; value?: number; }[]; outputPath: string; }
    • filters
      { type: "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"; intensity?: number; value?: number; }[]
      • variant 1
        __type: { type: "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"; intensity?: number; value?: number; }
        • type
          "saturation" | "sharpen" | "noise" | "invert" | "grayscale" | "sepia" | "brightness" | "contrast" | "blur"
          • variant 1"saturation"
          • variant 2"sharpen"
          • variant 3"noise"
          • variant 4"invert"
          • variant 5"grayscale"
          • variant 6"sepia"
          • variant 7"brightness"
          • variant 8"contrast"
          • variant 9"blur"
        • intensity?number
        • value?number
    • outputPathstring
  • merge?
    __type: { videos: VideoSource[]; outputPath: string; mode?: "grid" | "sequential" | "side-by-side"; direction?: "horizontal" | "vertical"; grid?: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }; audioPolicy?: VideoAudioPolicy; }
    • videos
      VideoSource[]
      • variant 1
        VideoSource
        • variant 1string
        • variant 2Buffer<ArrayBufferLike>
    • outputPathstring
    • mode?
      "grid" | "sequential" | "side-by-side"
      • variant 1"grid"
      • variant 2"sequential"
      • variant 3"side-by-side"
    • direction?
      "horizontal" | "vertical"
      • variant 1"horizontal"
      • variant 2"vertical"
    • grid?
      __type: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }
      • cols?number
      • rows?number
      • cellWidth?number
      • cellHeight?number
      • gap?number
      • background?string
    • audioPolicy?
      VideoAudioPolicy
      • variant 1"none"
      • variant 2"preserve"
      • variant 3"first"
      • variant 4"mix"
  • replaceSegment?
    __type: { replacementVideo?: VideoSource; replacementStartTime?: number; replacementDuration?: number; replacementFrames?: VideoSource[]; replacementFps?: number; targetStartTime: number; targetEndTime: number; durationPolicy?: "fit" | "preserve" | "trim"; outputPath: string; }
    • replacementVideo?
      VideoSource
      • variant 1string
      • variant 2Buffer<ArrayBufferLike>
    • replacementStartTime?number
    • replacementDuration?number
    • replacementFrames?
      VideoSource[]
      • variant 1
        VideoSource
        • variant 1string
        • variant 2Buffer<ArrayBufferLike>
    • replacementFps?number
    • targetStartTimenumber
    • targetEndTimenumber
    • durationPolicy?
      "fit" | "preserve" | "trim"
      • variant 1"fit"
      • variant 2"preserve"
      • variant 3"trim"
    • outputPathstring
  • rotate?
    __type: { angle?: 90 | 180 | 270; flip?: "horizontal" | "vertical" | "both"; outputPath: string; }
    • angle?
      90 | 180 | 270
      • variant 190
      • variant 2180
      • variant 3270
    • flip?
      "horizontal" | "vertical" | "both"
      • variant 1"horizontal"
      • variant 2"vertical"
      • variant 3"both"
    • outputPathstring
  • crop?
    __type: { x: number; y: number; width: number; height: number; outputPath: string; }
    • xnumber
    • ynumber
    • widthnumber
    • heightnumber
    • outputPathstring
  • compress?
    __type: { outputPath: string; quality?: VideoQuality; targetSize?: number; maxBitrate?: number; }
    • outputPathstring
    • quality?
      VideoQuality
      • variant 1"low"
      • variant 2"medium"
      • variant 3"high"
      • variant 4"ultra"
    • targetSize?number
    • maxBitrate?number
  • addText?
    __type: { text: string; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center"; fontSize?: number; fontColor?: string; backgroundColor?: string; startTime?: number; endTime?: number; outputPath: string; }
    • textstring
    • position?
      "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center"
      • variant 1"center"
      • variant 2"top-left"
      • variant 3"top-right"
      • variant 4"bottom-left"
      • variant 5"bottom-right"
      • variant 6"top-center"
      • variant 7"bottom-center"
    • fontSize?number
    • fontColor?string
    • backgroundColor?string
    • startTime?number
    • endTime?number
    • outputPathstring
  • addFade?
    __type: { fadeIn?: number; fadeOut?: number; outputPath: string; }
    • fadeIn?number
    • fadeOut?number
    • outputPathstring
  • reverse?
    __type: { outputPath: string; }
    • outputPathstring
  • createLoop?
    __type: { outputPath: string; smooth?: boolean; }
    • outputPathstring
    • smooth?boolean
  • batch?
    __type: { videos: { source: VideoSource; operations: Record<string, unknown>; }[]; outputDirectory: string; }
    • videos
      { source: VideoSource; operations: Record<string, unknown>; }[]
      • variant 1
        __type: { source: VideoSource; operations: Record<string, unknown>; }
        • source
          VideoSource
          • variant 1string
          • variant 2Buffer<ArrayBufferLike>
        • operationsRecord<string, unknown>
    • outputDirectorystring
  • detectScenes?
    __type: { threshold?: number; outputPath?: string; }
    • threshold?number
    • outputPath?string
  • stabilize?
    __type: { outputPath: string; smoothing?: number; }
    • outputPathstring
    • smoothing?number
  • colorCorrect?
    __type: { brightness?: number; contrast?: number; saturation?: number; hue?: number; temperature?: number; outputPath: string; }
    • brightness?number
    • contrast?number
    • saturation?number
    • hue?number
    • temperature?number
    • outputPathstring
  • pictureInPicture?
    __type: { overlayVideo: VideoSource; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; size?: { width?: number; height?: number; fit?: VideoFit; }; opacity?: number; outputPath: string; }
    • overlayVideo
      VideoSource
      • variant 1string
      • variant 2Buffer<ArrayBufferLike>
    • position?
      "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right"
      • variant 1"center"
      • variant 2"top-left"
      • variant 3"top-right"
      • variant 4"bottom-left"
      • variant 5"bottom-right"
    • size?
      __type: { width?: number; height?: number; fit?: VideoFit; }
      • width?number
      • height?number
      • fit?
        VideoFit
        • variant 1"contain"
        • variant 2"cover"
        • variant 3"stretch"
    • opacity?number
    • outputPathstring
  • splitScreen?
    __type: { videos: VideoSource[]; layout?: "grid" | "side-by-side" | "top-bottom"; grid?: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }; audioPolicy?: VideoAudioPolicy; outputPath: string; }
    • videos
      VideoSource[]
      • variant 1
        VideoSource
        • variant 1string
        • variant 2Buffer<ArrayBufferLike>
    • layout?
      "grid" | "side-by-side" | "top-bottom"
      • variant 1"grid"
      • variant 2"side-by-side"
      • variant 3"top-bottom"
    • grid?
      __type: { cols?: number; rows?: number; cellWidth?: number; cellHeight?: number; gap?: number; background?: string; }
      • cols?number
      • rows?number
      • cellWidth?number
      • cellHeight?number
      • gap?number
      • background?string
    • audioPolicy?
      VideoAudioPolicy
      • variant 1"none"
      • variant 2"preserve"
      • variant 3"first"
      • variant 4"mix"
    • outputPathstring
  • createTimeLapse?
    __type: { speed?: number; outputPath: string; }
    • speed?number
    • outputPathstring
  • removeAudio?
    __type: { outputPath: string; }
    • outputPathstring
  • mixAudio?
    MixAudioOperation: MixAudioOperation
    • outputPathstring
    • overlays
      MixAudioOverlayClip[]
      • variant 1
        MixAudioOverlayClip: MixAudioOverlayClip
        • source
          VideoSource
          • variant 1string
          • variant 2Buffer<ArrayBufferLike>
        • startTimenumber
        • duration?number
        • sourceStart?number
        • volume?number
        • speed?number
        • pitchSemitones?number
        • pan?number
        • fadeIn?number
        • fadeOut?number
    • keepOriginalAudio?boolean
    • originalVolume?number
    • originalSpeed?number
    • originalPitchSemitones?number
    • durationPolicy?
      "video" | "shortest" | "longest"
      • variant 1"video"
      • variant 2"shortest"
      • variant 3"longest"
  • mute?
    __type: { outputPath: string; ranges?: { start: number; end: number; }[]; }
    • outputPathstring
    • ranges?
      { start: number; end: number; }[]
      • variant 1
        __type: { start: number; end: number; }
        • startnumber
        • endnumber
  • adjustVolume?
    __type: { outputPath: string; volume?: number; ranges?: { start: number; end: number; volume: number; speed?: number; pitchSemitones?: number; }[]; }
    • outputPathstring
    • volume?number
    • ranges?
      { start: number; end: number; volume: number; speed?: number; pitchSemitones?: number; }[]
      • variant 1
        __type: { start: number; end: number; volume: number; speed?: number; pitchSemitones?: number; }
        • startnumber
        • endnumber
        • volumenumber
        • speed?number
        • pitchSemitones?number
  • createFromFrames?
    __type: { frames: VideoSource[]; outputPath: string; fps?: number; format?: VideoOutputFormat; quality?: VideoQuality; bitrate?: number; resolution?: { width?: number; height?: number; fit?: VideoFit; }; }
    • frames
      VideoSource[]
      • variant 1
        VideoSource
        • variant 1string
        • variant 2Buffer<ArrayBufferLike>
    • outputPathstring
    • fps?number
    • format?
      VideoOutputFormat
      • variant 1"mp4"
      • variant 2"webm"
      • variant 3"avi"
      • variant 4"mov"
      • variant 5"mkv"
    • quality?
      VideoQuality
      • variant 1"low"
      • variant 2"medium"
      • variant 3"high"
      • variant 4"ultra"
    • bitrate?number
    • resolution?
      __type: { width?: number; height?: number; fit?: VideoFit; }
      • width?number
      • height?number
      • fit?
        VideoFit
        • variant 1"contain"
        • variant 2"cover"
        • variant 3"stretch"
  • detectFormat?boolean
  • freezeFrame?
    __type: { time: number; duration: number; outputPath: string; }
    • timenumber
    • durationnumber
    • outputPathstring
  • exportPreset?
    __type: { preset: "youtube" | "instagram" | "tiktok" | "twitter" | "facebook" | "4k" | "1080p" | "720p" | "mobile" | "web"; outputPath: string; }
    • preset
      "youtube" | "instagram" | "tiktok" | "twitter" | "facebook" | "4k" | "1080p" | "720p" | "mobile" | "web"
      • variant 1"youtube"
      • variant 2"instagram"
      • variant 3"tiktok"
      • variant 4"twitter"
      • variant 5"facebook"
      • variant 6"4k"
      • variant 7"1080p"
      • variant 8"720p"
      • variant 9"mobile"
      • variant 10"web"
    • outputPathstring
  • normalizeAudio?
    __type: { targetLevel?: number; method?: "peak" | "rms" | "lufs"; outputPath: string; }
    • targetLevel?number
    • method?
      "peak" | "rms" | "lufs"
      • variant 1"peak"
      • variant 2"rms"
      • variant 3"lufs"
    • outputPathstring
  • applyLUT?
    __type: { lutPath: string; intensity?: number; outputPath: string; }
    • lutPathstring
    • intensity?number
    • outputPathstring
  • addTransition?
    __type: { type: "circle" | "blur" | "zoom" | "fade" | "wipe" | "slide" | "rotate" | "dissolve" | "pixelize"; duration: number; direction?: "left" | "right" | "up" | "down" | "in" | "out"; secondVideo?: VideoSource; outputPath: string; }
    • type
      "circle" | "blur" | "zoom" | "fade" | "wipe" | "slide" | "rotate" | "dissolve" | "pixelize"
      • variant 1"circle"
      • variant 2"blur"
      • variant 3"zoom"
      • variant 4"fade"
      • variant 5"wipe"
      • variant 6"slide"
      • variant 7"rotate"
      • variant 8"dissolve"
      • variant 9"pixelize"
    • durationnumber
    • direction?
      "left" | "right" | "up" | "down" | "in" | "out"
      • variant 1"left"
      • variant 2"right"
      • variant 3"up"
      • variant 4"down"
      • variant 5"in"
      • variant 6"out"
    • secondVideo?
      VideoSource
      • variant 1string
      • variant 2Buffer<ArrayBufferLike>
    • outputPathstring
  • addTextOverlay?
    VideoTextOverlayOperation: VideoTextOverlayOperation
    • overlays
      VideoTextOverlayClip[]
      • variant 1
        VideoTextOverlayClip: VideoTextOverlayClip
        • startTimenumber
        • endTimenumber
        • transitionIn?
          VideoTextTransition: VideoTextTransition
          • typeVideoTextTransitionPreset
          • duration?number
          • custom?{ x?: string; y?: string; alpha?: string; scale?: string; }
        • transitionOut?
          VideoTextTransition: VideoTextTransition
          • typeVideoTextTransitionPreset
          • duration?number
          • custom?{ x?: string; y?: string; alpha?: string; scale?: string; }
        • overlayOpacity?number
        • textstring
        • xnumber
        • ynumber
        • font?
          __type: { size?: number; family?: string; name?: string; path?: string; }
          • size?number
          • family?string
          • name?string
          • path?string
        • fontSize?number
        • fontFamily?string
        • fontName?string
        • fontPath?string
        • bold?boolean
        • italic?boolean
        • decorations?
          TextDecorations: TextDecorations
          • underline?TextLineDecoration
          • overline?TextLineDecoration
          • strikethrough?TextLineDecoration
          • bold?boolean
          • italic?boolean
        • effects?
          TextEffects: TextEffects
          • highlight?TextHighlightStyle
          • glow?TextGlowStyle
          • shadow?TextShadowStyle
        • underline?
          TextLineDecoration
          • variant 1false
          • variant 2true
          • variant 3{ color?: string; gradient?: gradient; width?: number; }
        • overline?
          TextLineDecoration
          • variant 1false
          • variant 2true
          • variant 3{ color?: string; gradient?: gradient; width?: number; }
        • strikethrough?
          TextLineDecoration
          • variant 1false
          • variant 2true
          • variant 3{ color?: string; gradient?: gradient; width?: number; }
        • highlight?
          TextHighlightStyle: TextHighlightStyle
          • color?string
          • gradient?gradient
          • opacity?number
        • glow?
          TextGlowStyle: TextGlowStyle
          • color?string
          • gradient?gradient
          • intensity?number
          • opacity?number
        • shadow?
          TextShadowStyle: TextShadowStyle
          • color?string
          • gradient?gradient
          • offsetX?number
          • offsetY?number
          • blur?number
          • opacity?number
        • layout?
          TextLayout: TextLayout
          • lineHeight?number
          • letterSpacing?number
          • wordSpacing?number
          • maxWidth?number
          • maxHeight?number
        • placement?
          TextPlacement: TextPlacement
          • textAlign?TextAlignMode
          • textBaseline?TextBaselineMode
          • rotation?number
        • fill?
          TextFill: TextFill
          • color?string
          • gradient?gradient
          • opacity?number
        • lineHeight?number
        • letterSpacing?number
        • wordSpacing?number
        • maxWidth?number
        • maxHeight?number
        • textAlign?
          TextAlignMode
          • variant 1"center"
          • variant 2"left"
          • variant 3"right"
          • variant 4"start"
          • variant 5"end"
        • textBaseline?
          TextBaselineMode
          • variant 1"top"
          • variant 2"bottom"
          • variant 3"alphabetic"
          • variant 4"hanging"
          • variant 5"ideographic"
          • variant 6"middle"
        • rotation?number
        • color?string
        • gradient?
          gradient
          • variant 1{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }
          • variant 2{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }
          • variant 3{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
        • opacity?number
        • stroke?
          TextStrokeStyle: TextStrokeStyle
          • color?string
          • width?number
          • gradient?gradient
          • opacity?number
          • style?"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"
        • textOnCurve?
          TextCurveConfig: TextCurveConfig
          • sweepAnglenumber
          • radius?number
          • up?boolean
          • layoutMode?CurvedTextLayoutMode
          • baselineOffset?number
          • startAngleDeg?number
        • includeCharMetrics?boolean
        • measurementCanvas?
          __type: { width?: number; height?: number; }
          • width?number
          • height?number
    • outputPathstring
  • addAnimatedText?
    __type: { text: string; animation?: "zoom" | "rotate" | "fadeIn" | "fadeOut" | "slideIn" | "slideOut" | "bounce" | "typewriter"; startTime: number; endTime: number; position?: "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center" | { x: number; y: number; }; fontSize?: number; fontColor?: string; fontPath?: string; fontName?: string; fontFamily?: string; backgroundColor?: string; outputPath: string; }
    • textstring
    • animation?
      "zoom" | "rotate" | "fadeIn" | "fadeOut" | "slideIn" | "slideOut" | "bounce" | "typewriter"
      • variant 1"zoom"
      • variant 2"rotate"
      • variant 3"fadeIn"
      • variant 4"fadeOut"
      • variant 5"slideIn"
      • variant 6"slideOut"
      • variant 7"bounce"
      • variant 8"typewriter"
    • startTimenumber
    • endTimenumber
    • position?
      "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center" | { x: number; y: number; }
      • variant 1"center"
      • variant 2"top-left"
      • variant 3"top-right"
      • variant 4"bottom-left"
      • variant 5"bottom-right"
      • variant 6"top-center"
      • variant 7"bottom-center"
      • variant 8
        __type: { x: number; y: number; }
        • xnumber
        • ynumber
    • fontSize?number
    • fontColor?string
    • fontPath?string
    • fontName?string
    • fontFamily?string
    • backgroundColor?string
    • outputPathstring
  • signal?AbortSignal
  • timeoutMs?number
  • overwrite?boolean
  • onProgress?(progress: FfmpegProgress) => void
PainterAssetRefsOptions: PainterAssetRefsOptions
  • resolveAssetRefs?boolean

Return value

Promise<unknown>

The return contract is generated from the packed declaration. Async wrappers and nullable/undefined variants remain visible in the type model.

Errors

NOT APPLICABLE — no verified errors are bound to this API.

Limits

NOT APPLICABLE — no API-specific verified limits are bound to this API.

Related APIs

No explicit related API metadata.

Next steps

ApexPainter._detectAPI member · node · CURRENT

Published ApexPainter._detect property.

ApexPainter._outputAPI member · node · CURRENT

Published ApexPainter._output property.

ApexPainter._outputFormatAPI member · node · CURRENT

Published ApexPainter._outputFormat property.

ApexPainter._path2dAPI member · node · CURRENT

Published ApexPainter._path2d property.