ApexPainter member
ApexPainter.videoPipeline
Declarative video edit pipeline (trim, splice, text, audio + synth). Layer `id` upserts — no duplicate ops.
lib-next/apex-painter/main.ts (opens in a new tab)Signature
(source?: string | Buffer, initialLayers?: import("../types/video-pipeline.js").VideoPipelineLayer[]) => import("../video/video-pipeline-builder.js").VideoPipelineParameters
source?
string | Buffer<ArrayBufferLike>
initialLayers?
VideoPipelineLayer[]
Options
| Option | Type | Contract | Allowed values | Runtime & capabilities |
|---|---|---|---|---|
| initialLayers | ||||
initialLayers.idStable key for upsert/replace (e.g. `"main-trim"`, `"titles"`). | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.kindPublished initialLayers.kind option. | "source" | RequiredDefaultRequired | "source" | node22 · node24 · node26 |
initialLayers.sourcePublished initialLayers.source option. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.endTimePublished initialLayers.endTime option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.startTimePublished initialLayers.startTime option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.durationPolicyPublished initialLayers.durationPolicy option. | "fit" | "preserve" | "trim" | OptionalDefault— | "fit" "preserve" "trim" | node22 · node24 · node26 |
initialLayers.replacementDurationPublished initialLayers.replacementDuration option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.replacementFpsPublished initialLayers.replacementFps option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.replacementFramesPublished initialLayers.replacementFrames option. | (string | Buffer<ArrayBufferLike>)[] | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.replacementStartTimePublished initialLayers.replacementStartTime option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.replacementVideoPublished initialLayers.replacementVideo option. | string | Buffer<ArrayBufferLike> | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.targetEndTimePublished initialLayers.targetEndTime option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.targetStartTimePublished initialLayers.targetStartTime option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlaysPublished initialLayers.overlays option. | VideoTextOverlayClip[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.boldPublished initialLayers.overlays.bold option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
initialLayers.overlays.colorPublished initialLayers.overlays.color option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.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}). | TextDecorations | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.boldPublished initialLayers.overlays.decorations.bold option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
initialLayers.overlays.decorations.italicPublished initialLayers.overlays.decorations.italic option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
initialLayers.overlays.decorations.overlinePublished initialLayers.overlays.decorations.overline option. | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.colorPublished initialLayers.overlays.decorations.overline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradientPublished initialLayers.overlays.decorations.overline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.colorsPublished initialLayers.overlays.decorations.overline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.colors.colorPublished initialLayers.overlays.decorations.overline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.colors.stopPublished initialLayers.overlays.decorations.overline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.endXPublished initialLayers.overlays.decorations.overline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.endYPublished initialLayers.overlays.decorations.overline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.pivotXPublished initialLayers.overlays.decorations.overline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.pivotYPublished initialLayers.overlays.decorations.overline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.repeatPublished initialLayers.overlays.decorations.overline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.rotatePublished initialLayers.overlays.decorations.overline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.startXPublished initialLayers.overlays.decorations.overline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.startYPublished initialLayers.overlays.decorations.overline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.typePublished initialLayers.overlays.decorations.overline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.endRadiusPublished initialLayers.overlays.decorations.overline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.startRadiusPublished initialLayers.overlays.decorations.overline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.centerXPublished initialLayers.overlays.decorations.overline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.centerYPublished initialLayers.overlays.decorations.overline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.gradient.startAnglePublished initialLayers.overlays.decorations.overline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.overline.widthPublished initialLayers.overlays.decorations.overline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethroughPublished initialLayers.overlays.decorations.strikethrough option. | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.colorPublished initialLayers.overlays.decorations.strikethrough.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradientPublished initialLayers.overlays.decorations.strikethrough.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.colorsPublished initialLayers.overlays.decorations.strikethrough.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.colors.colorPublished initialLayers.overlays.decorations.strikethrough.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.colors.stopPublished initialLayers.overlays.decorations.strikethrough.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.endXPublished initialLayers.overlays.decorations.strikethrough.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.endYPublished initialLayers.overlays.decorations.strikethrough.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.pivotXPublished initialLayers.overlays.decorations.strikethrough.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.pivotYPublished initialLayers.overlays.decorations.strikethrough.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.repeatPublished initialLayers.overlays.decorations.strikethrough.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.rotatePublished initialLayers.overlays.decorations.strikethrough.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.startXPublished initialLayers.overlays.decorations.strikethrough.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.startYPublished initialLayers.overlays.decorations.strikethrough.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.typePublished initialLayers.overlays.decorations.strikethrough.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.endRadiusPublished initialLayers.overlays.decorations.strikethrough.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.startRadiusPublished initialLayers.overlays.decorations.strikethrough.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.centerXPublished initialLayers.overlays.decorations.strikethrough.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.centerYPublished initialLayers.overlays.decorations.strikethrough.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.gradient.startAnglePublished initialLayers.overlays.decorations.strikethrough.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.strikethrough.widthPublished initialLayers.overlays.decorations.strikethrough.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underlinePublished initialLayers.overlays.decorations.underline option. | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.colorPublished initialLayers.overlays.decorations.underline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradientPublished initialLayers.overlays.decorations.underline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.colorsPublished initialLayers.overlays.decorations.underline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.colors.colorPublished initialLayers.overlays.decorations.underline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.colors.stopPublished initialLayers.overlays.decorations.underline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.endXPublished initialLayers.overlays.decorations.underline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.endYPublished initialLayers.overlays.decorations.underline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.pivotXPublished initialLayers.overlays.decorations.underline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.pivotYPublished initialLayers.overlays.decorations.underline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.repeatPublished initialLayers.overlays.decorations.underline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.rotatePublished initialLayers.overlays.decorations.underline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.startXPublished initialLayers.overlays.decorations.underline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.startYPublished initialLayers.overlays.decorations.underline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.typePublished initialLayers.overlays.decorations.underline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.endRadiusPublished initialLayers.overlays.decorations.underline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.startRadiusPublished initialLayers.overlays.decorations.underline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.centerXPublished initialLayers.overlays.decorations.underline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.centerYPublished initialLayers.overlays.decorations.underline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.gradient.startAnglePublished initialLayers.overlays.decorations.underline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.decorations.underline.widthPublished initialLayers.overlays.decorations.underline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effectsGrouped highlight, glow, and shadow. When set, entries override the legacy flat fields (see {@link resolveTextEffects}). | TextEffects | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glowPublished initialLayers.overlays.effects.glow option. | TextGlowStyle | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.colorPublished initialLayers.overlays.effects.glow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradientPublished initialLayers.overlays.effects.glow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.colorsPublished initialLayers.overlays.effects.glow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.colors.colorPublished initialLayers.overlays.effects.glow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.colors.stopPublished initialLayers.overlays.effects.glow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.endXPublished initialLayers.overlays.effects.glow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.endYPublished initialLayers.overlays.effects.glow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.pivotXPublished initialLayers.overlays.effects.glow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.pivotYPublished initialLayers.overlays.effects.glow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.repeatPublished initialLayers.overlays.effects.glow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.rotatePublished initialLayers.overlays.effects.glow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.startXPublished initialLayers.overlays.effects.glow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.startYPublished initialLayers.overlays.effects.glow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.typePublished initialLayers.overlays.effects.glow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.endRadiusPublished initialLayers.overlays.effects.glow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.startRadiusPublished initialLayers.overlays.effects.glow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.centerXPublished initialLayers.overlays.effects.glow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.centerYPublished initialLayers.overlays.effects.glow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.gradient.startAnglePublished initialLayers.overlays.effects.glow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.intensityPublished initialLayers.overlays.effects.glow.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.glow.opacityPublished initialLayers.overlays.effects.glow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlightPublished initialLayers.overlays.effects.highlight option. | TextHighlightStyle | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.colorPublished initialLayers.overlays.effects.highlight.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradientPublished initialLayers.overlays.effects.highlight.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.colorsPublished initialLayers.overlays.effects.highlight.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.colors.colorPublished initialLayers.overlays.effects.highlight.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.colors.stopPublished initialLayers.overlays.effects.highlight.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.endXPublished initialLayers.overlays.effects.highlight.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.endYPublished initialLayers.overlays.effects.highlight.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.pivotXPublished initialLayers.overlays.effects.highlight.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.pivotYPublished initialLayers.overlays.effects.highlight.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.repeatPublished initialLayers.overlays.effects.highlight.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.rotatePublished initialLayers.overlays.effects.highlight.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.startXPublished initialLayers.overlays.effects.highlight.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.startYPublished initialLayers.overlays.effects.highlight.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.typePublished initialLayers.overlays.effects.highlight.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.endRadiusPublished initialLayers.overlays.effects.highlight.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.startRadiusPublished initialLayers.overlays.effects.highlight.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.centerXPublished initialLayers.overlays.effects.highlight.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.centerYPublished initialLayers.overlays.effects.highlight.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.gradient.startAnglePublished initialLayers.overlays.effects.highlight.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.highlight.opacityPublished initialLayers.overlays.effects.highlight.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadowPublished initialLayers.overlays.effects.shadow option. | TextShadowStyle | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.blurPublished initialLayers.overlays.effects.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.colorPublished initialLayers.overlays.effects.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradientPublished initialLayers.overlays.effects.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.colorsPublished initialLayers.overlays.effects.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.colors.colorPublished initialLayers.overlays.effects.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.colors.stopPublished initialLayers.overlays.effects.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.endXPublished initialLayers.overlays.effects.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.endYPublished initialLayers.overlays.effects.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.pivotXPublished initialLayers.overlays.effects.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.pivotYPublished initialLayers.overlays.effects.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.repeatPublished initialLayers.overlays.effects.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.rotatePublished initialLayers.overlays.effects.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.startXPublished initialLayers.overlays.effects.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.startYPublished initialLayers.overlays.effects.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.typePublished initialLayers.overlays.effects.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.endRadiusPublished initialLayers.overlays.effects.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.startRadiusPublished initialLayers.overlays.effects.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.centerXPublished initialLayers.overlays.effects.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.centerYPublished initialLayers.overlays.effects.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.gradient.startAnglePublished initialLayers.overlays.effects.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.offsetXPublished initialLayers.overlays.effects.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.offsetYPublished initialLayers.overlays.effects.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.effects.shadow.opacityPublished initialLayers.overlays.effects.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.endTimeSeconds when this overlay is hidden. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.fillGrouped fill color / gradient and draw opacity (see {@link resolveTextFill}). | TextFill | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fill.colorPublished initialLayers.overlays.fill.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradientPublished initialLayers.overlays.fill.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.colorsPublished initialLayers.overlays.fill.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.colors.colorPublished initialLayers.overlays.fill.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.colors.stopPublished initialLayers.overlays.fill.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.endXPublished initialLayers.overlays.fill.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.endYPublished initialLayers.overlays.fill.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.pivotXPublished initialLayers.overlays.fill.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.pivotYPublished initialLayers.overlays.fill.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.repeatPublished initialLayers.overlays.fill.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.rotatePublished initialLayers.overlays.fill.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.startXPublished initialLayers.overlays.fill.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.startYPublished initialLayers.overlays.fill.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.typePublished initialLayers.overlays.fill.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.endRadiusPublished initialLayers.overlays.fill.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.startRadiusPublished initialLayers.overlays.fill.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.centerXPublished initialLayers.overlays.fill.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.centerYPublished initialLayers.overlays.fill.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fill.gradient.startAnglePublished initialLayers.overlays.fill.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fill.opacityPublished initialLayers.overlays.fill.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fontPublished initialLayers.overlays.font option. | { size?: number; family?: string; name?: string; path?: string; } | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.font.familyPublished initialLayers.overlays.font.family option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.font.namePublished initialLayers.overlays.font.name option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.font.pathPublished initialLayers.overlays.font.path option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.font.sizePublished initialLayers.overlays.font.size option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fontFamilyPublished initialLayers.overlays.fontFamily option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fontNamePublished initialLayers.overlays.fontName option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fontPathPublished initialLayers.overlays.fontPath option.Deprecated | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.fontSizePublished initialLayers.overlays.fontSize option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glowPublished initialLayers.overlays.glow option.Deprecated | TextGlowStyle | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.colorPublished initialLayers.overlays.glow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradientPublished initialLayers.overlays.glow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.colorsPublished initialLayers.overlays.glow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.colors.colorPublished initialLayers.overlays.glow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.colors.stopPublished initialLayers.overlays.glow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.endXPublished initialLayers.overlays.glow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.endYPublished initialLayers.overlays.glow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.pivotXPublished initialLayers.overlays.glow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.pivotYPublished initialLayers.overlays.glow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.repeatPublished initialLayers.overlays.glow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.rotatePublished initialLayers.overlays.glow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.startXPublished initialLayers.overlays.glow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.startYPublished initialLayers.overlays.glow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.typePublished initialLayers.overlays.glow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.endRadiusPublished initialLayers.overlays.glow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.startRadiusPublished initialLayers.overlays.glow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.centerXPublished initialLayers.overlays.glow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.centerYPublished initialLayers.overlays.glow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.gradient.startAnglePublished initialLayers.overlays.glow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.intensityPublished initialLayers.overlays.glow.intensity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.glow.opacityPublished initialLayers.overlays.glow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.gradientPublished initialLayers.overlays.gradient option.Deprecated | gradient | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.gradient.colorsPublished initialLayers.overlays.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.gradient.colors.colorPublished initialLayers.overlays.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.gradient.colors.stopPublished initialLayers.overlays.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.gradient.endXPublished initialLayers.overlays.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.gradient.endYPublished initialLayers.overlays.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.gradient.pivotXPublished initialLayers.overlays.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.gradient.pivotYPublished initialLayers.overlays.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.gradient.repeatPublished initialLayers.overlays.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
initialLayers.overlays.gradient.rotatePublished initialLayers.overlays.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.gradient.startXPublished initialLayers.overlays.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.gradient.startYPublished initialLayers.overlays.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.gradient.typePublished initialLayers.overlays.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
initialLayers.overlays.gradient.endRadiusPublished initialLayers.overlays.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.gradient.startRadiusPublished initialLayers.overlays.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.gradient.centerXPublished initialLayers.overlays.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.gradient.centerYPublished initialLayers.overlays.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.gradient.startAnglePublished initialLayers.overlays.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlightPublished initialLayers.overlays.highlight option.Deprecated | TextHighlightStyle | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.colorPublished initialLayers.overlays.highlight.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradientPublished initialLayers.overlays.highlight.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.colorsPublished initialLayers.overlays.highlight.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.colors.colorPublished initialLayers.overlays.highlight.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.colors.stopPublished initialLayers.overlays.highlight.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.endXPublished initialLayers.overlays.highlight.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.endYPublished initialLayers.overlays.highlight.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.pivotXPublished initialLayers.overlays.highlight.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.pivotYPublished initialLayers.overlays.highlight.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.repeatPublished initialLayers.overlays.highlight.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.rotatePublished initialLayers.overlays.highlight.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.startXPublished initialLayers.overlays.highlight.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.startYPublished initialLayers.overlays.highlight.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.typePublished initialLayers.overlays.highlight.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.endRadiusPublished initialLayers.overlays.highlight.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.startRadiusPublished initialLayers.overlays.highlight.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.centerXPublished initialLayers.overlays.highlight.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.centerYPublished initialLayers.overlays.highlight.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.gradient.startAnglePublished initialLayers.overlays.highlight.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.highlight.opacityPublished initialLayers.overlays.highlight.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.includeCharMetricsPublished initialLayers.overlays.includeCharMetrics option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
initialLayers.overlays.italicPublished initialLayers.overlays.italic option.Deprecated | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
initialLayers.overlays.layoutGrouped line height, spacing, and wrap bounds (see {@link resolveTextLayout}). | TextLayout | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.layout.letterSpacingPublished initialLayers.overlays.layout.letterSpacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.layout.lineHeightPublished initialLayers.overlays.layout.lineHeight option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.layout.maxHeightPublished initialLayers.overlays.layout.maxHeight option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.layout.maxWidthPublished initialLayers.overlays.layout.maxWidth option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.layout.wordSpacingPublished initialLayers.overlays.layout.wordSpacing option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.letterSpacingPublished initialLayers.overlays.letterSpacing option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.lineHeightPublished initialLayers.overlays.lineHeight option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.maxHeightPublished initialLayers.overlays.maxHeight option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.maxWidthPublished initialLayers.overlays.maxWidth option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.measurementCanvasPublished initialLayers.overlays.measurementCanvas option. | { width?: number; height?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.measurementCanvas.heightPublished initialLayers.overlays.measurementCanvas.height option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.measurementCanvas.widthPublished initialLayers.overlays.measurementCanvas.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.opacityPublished initialLayers.overlays.opacity option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overlayOpacityMaster overlay opacity 0–1 (default `1`), multiplied with transition fades. Distinct from {@link TextProperties.fill} / `opacity` on glyphs. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overlinePublished initialLayers.overlays.overline option.Deprecated | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overline.colorPublished initialLayers.overlays.overline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradientPublished initialLayers.overlays.overline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.colorsPublished initialLayers.overlays.overline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.colors.colorPublished initialLayers.overlays.overline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.colors.stopPublished initialLayers.overlays.overline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.endXPublished initialLayers.overlays.overline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.endYPublished initialLayers.overlays.overline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.pivotXPublished initialLayers.overlays.overline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.pivotYPublished initialLayers.overlays.overline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.repeatPublished initialLayers.overlays.overline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.rotatePublished initialLayers.overlays.overline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.startXPublished initialLayers.overlays.overline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.startYPublished initialLayers.overlays.overline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.typePublished initialLayers.overlays.overline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.endRadiusPublished initialLayers.overlays.overline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.startRadiusPublished initialLayers.overlays.overline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.centerXPublished initialLayers.overlays.overline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.centerYPublished initialLayers.overlays.overline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overline.gradient.startAnglePublished initialLayers.overlays.overline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.overline.widthPublished initialLayers.overlays.overline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.placementGrouped alignment, baseline, and rotation (see {@link resolveTextPlacement}). | TextPlacement | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.placement.rotationPublished initialLayers.overlays.placement.rotation option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.placement.textAlignPublished initialLayers.overlays.placement.textAlign option. | TextAlignMode | OptionalDefault— | 5 values"center" "left" "right" "start" "end" | node22 · node24 · node26 |
initialLayers.overlays.placement.textBaselinePublished initialLayers.overlays.placement.textBaseline option. | TextBaselineMode | OptionalDefault— | 6 values"top" "bottom" "alphabetic" "hanging" "ideographic" "middle" | node22 · node24 · node26 |
initialLayers.overlays.rotationPublished initialLayers.overlays.rotation option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadowPublished initialLayers.overlays.shadow option.Deprecated | TextShadowStyle | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.blurPublished initialLayers.overlays.shadow.blur option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.colorPublished initialLayers.overlays.shadow.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradientPublished initialLayers.overlays.shadow.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.colorsPublished initialLayers.overlays.shadow.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.colors.colorPublished initialLayers.overlays.shadow.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.colors.stopPublished initialLayers.overlays.shadow.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.endXPublished initialLayers.overlays.shadow.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.endYPublished initialLayers.overlays.shadow.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.pivotXPublished initialLayers.overlays.shadow.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.pivotYPublished initialLayers.overlays.shadow.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.repeatPublished initialLayers.overlays.shadow.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.rotatePublished initialLayers.overlays.shadow.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.startXPublished initialLayers.overlays.shadow.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.startYPublished initialLayers.overlays.shadow.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.typePublished initialLayers.overlays.shadow.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.endRadiusPublished initialLayers.overlays.shadow.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.startRadiusPublished initialLayers.overlays.shadow.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.centerXPublished initialLayers.overlays.shadow.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.centerYPublished initialLayers.overlays.shadow.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.gradient.startAnglePublished initialLayers.overlays.shadow.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.offsetXPublished initialLayers.overlays.shadow.offsetX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.offsetYPublished initialLayers.overlays.shadow.offsetY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.shadow.opacityPublished initialLayers.overlays.shadow.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.startTimeSeconds when this overlay becomes visible. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.strikethroughPublished initialLayers.overlays.strikethrough option.Deprecated | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.colorPublished initialLayers.overlays.strikethrough.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradientPublished initialLayers.overlays.strikethrough.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.colorsPublished initialLayers.overlays.strikethrough.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.colors.colorPublished initialLayers.overlays.strikethrough.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.colors.stopPublished initialLayers.overlays.strikethrough.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.endXPublished initialLayers.overlays.strikethrough.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.endYPublished initialLayers.overlays.strikethrough.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.pivotXPublished initialLayers.overlays.strikethrough.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.pivotYPublished initialLayers.overlays.strikethrough.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.repeatPublished initialLayers.overlays.strikethrough.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.rotatePublished initialLayers.overlays.strikethrough.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.startXPublished initialLayers.overlays.strikethrough.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.startYPublished initialLayers.overlays.strikethrough.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.typePublished initialLayers.overlays.strikethrough.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.endRadiusPublished initialLayers.overlays.strikethrough.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.startRadiusPublished initialLayers.overlays.strikethrough.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.centerXPublished initialLayers.overlays.strikethrough.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.centerYPublished initialLayers.overlays.strikethrough.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.gradient.startAnglePublished initialLayers.overlays.strikethrough.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strikethrough.widthPublished initialLayers.overlays.strikethrough.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.strokePublished initialLayers.overlays.stroke option. | TextStrokeStyle | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.colorPublished initialLayers.overlays.stroke.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradientPublished initialLayers.overlays.stroke.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.colorsPublished initialLayers.overlays.stroke.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.colors.colorPublished initialLayers.overlays.stroke.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.colors.stopPublished initialLayers.overlays.stroke.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.endXPublished initialLayers.overlays.stroke.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.endYPublished initialLayers.overlays.stroke.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.pivotXPublished initialLayers.overlays.stroke.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.pivotYPublished initialLayers.overlays.stroke.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.repeatPublished initialLayers.overlays.stroke.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.rotatePublished initialLayers.overlays.stroke.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.startXPublished initialLayers.overlays.stroke.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.startYPublished initialLayers.overlays.stroke.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.typePublished initialLayers.overlays.stroke.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.endRadiusPublished initialLayers.overlays.stroke.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.startRadiusPublished initialLayers.overlays.stroke.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.centerXPublished initialLayers.overlays.stroke.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.centerYPublished initialLayers.overlays.stroke.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.gradient.startAnglePublished initialLayers.overlays.stroke.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.opacityPublished initialLayers.overlays.stroke.opacity option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.stroke.stylePublished initialLayers.overlays.stroke.style option. | "solid" | "dashed" | "dotted" | "groove" | "ridge" | "double" | OptionalDefault— | 6 values"solid" "dashed" "dotted" "groove" "ridge" "double" | node22 · node24 · node26 |
initialLayers.overlays.stroke.widthPublished initialLayers.overlays.stroke.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.textPublished initialLayers.overlays.text option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.textAlignPublished initialLayers.overlays.textAlign option.Deprecated | TextAlignMode | OptionalDefault— | 5 values"center" "left" "right" "start" "end" | node22 · node24 · node26 |
initialLayers.overlays.textBaselinePublished initialLayers.overlays.textBaseline option.Deprecated | TextBaselineMode | OptionalDefault— | 6 values"top" "bottom" "alphabetic" "hanging" "ideographic" "middle" | node22 · node24 · node26 |
initialLayers.overlays.textOnCurvePublished initialLayers.overlays.textOnCurve option.Deprecated | TextCurveConfig | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.textOnCurve.baselineOffsetPublished initialLayers.overlays.textOnCurve.baselineOffset option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.textOnCurve.layoutModePublished initialLayers.overlays.textOnCurve.layoutMode option. | CurvedTextLayoutMode | OptionalDefault— | "fit" "clamp" "override" | node22 · node24 · node26 |
initialLayers.overlays.textOnCurve.radiusPublished initialLayers.overlays.textOnCurve.radius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.textOnCurve.startAngleDegPublished initialLayers.overlays.textOnCurve.startAngleDeg option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.textOnCurve.sweepAnglePublished initialLayers.overlays.textOnCurve.sweepAngle option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.textOnCurve.upPublished initialLayers.overlays.textOnCurve.up option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
initialLayers.overlays.transitionInPublished initialLayers.overlays.transitionIn option. | VideoTextTransition | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.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 |
initialLayers.overlays.transitionIn.custom.alphaPublished initialLayers.overlays.transitionIn.custom.alpha option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.transitionIn.custom.scalePublished initialLayers.overlays.transitionIn.custom.scale option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.transitionIn.custom.xPublished initialLayers.overlays.transitionIn.custom.x option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.transitionIn.custom.yPublished initialLayers.overlays.transitionIn.custom.y option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.transitionIn.durationSeconds (default `0.35`). | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.transitionIn.typePublished initialLayers.overlays.transitionIn.type option. | VideoTextTransitionPreset | RequiredDefaultRequired | 14 values"none" "fade" "fadeIn" "fadeOut" "slideIn" "slideOut" "slideLeft" "slideRight" "slideUp" "slideDown" "zoomIn" "zoomOut" "bounce" "typewriter" | node22 · node24 · node26 |
initialLayers.overlays.transitionOutPublished initialLayers.overlays.transitionOut option. | VideoTextTransition | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.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 |
initialLayers.overlays.transitionOut.custom.alphaPublished initialLayers.overlays.transitionOut.custom.alpha option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.transitionOut.custom.scalePublished initialLayers.overlays.transitionOut.custom.scale option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.transitionOut.custom.xPublished initialLayers.overlays.transitionOut.custom.x option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.transitionOut.custom.yPublished initialLayers.overlays.transitionOut.custom.y option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.transitionOut.durationSeconds (default `0.35`). | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.transitionOut.typePublished initialLayers.overlays.transitionOut.type option. | VideoTextTransitionPreset | RequiredDefaultRequired | 14 values"none" "fade" "fadeIn" "fadeOut" "slideIn" "slideOut" "slideLeft" "slideRight" "slideUp" "slideDown" "zoomIn" "zoomOut" "bounce" "typewriter" | node22 · node24 · node26 |
initialLayers.overlays.underlinePublished initialLayers.overlays.underline option.Deprecated | TextLineDecoration | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.underline.colorPublished initialLayers.overlays.underline.color option. | string | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradientPublished initialLayers.overlays.underline.gradient option. | gradient | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.colorsPublished initialLayers.overlays.underline.gradient.colors option. | GradientStop[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.colors.colorPublished initialLayers.overlays.underline.gradient.colors.color option. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.colors.stopPublished initialLayers.overlays.underline.gradient.colors.stop option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.endXPublished initialLayers.overlays.underline.gradient.endX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.endYPublished initialLayers.overlays.underline.gradient.endY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.pivotXPublished initialLayers.overlays.underline.gradient.pivotX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.pivotYPublished initialLayers.overlays.underline.gradient.pivotY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.repeatPublished initialLayers.overlays.underline.gradient.repeat option. | "repeat" | "reflect" | "no-repeat" | OptionalDefault— | "repeat" "reflect" "no-repeat" | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.rotatePublished initialLayers.overlays.underline.gradient.rotate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.startXPublished initialLayers.overlays.underline.gradient.startX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.startYPublished initialLayers.overlays.underline.gradient.startY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.typePublished initialLayers.overlays.underline.gradient.type option. | "linear" | RequiredDefaultRequired | "linear" | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.endRadiusPublished initialLayers.overlays.underline.gradient.endRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.startRadiusPublished initialLayers.overlays.underline.gradient.startRadius option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.centerXPublished initialLayers.overlays.underline.gradient.centerX option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.centerYPublished initialLayers.overlays.underline.gradient.centerY option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.underline.gradient.startAnglePublished initialLayers.overlays.underline.gradient.startAngle option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.underline.widthPublished initialLayers.overlays.underline.width option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.wordSpacingPublished initialLayers.overlays.wordSpacing option.Deprecated | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.overlays.xPublished initialLayers.overlays.x option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.overlays.yPublished initialLayers.overlays.y option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.keepOriginalAudioPublished initialLayers.keepOriginalAudio option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
initialLayers.originalPitchSemitonesPublished initialLayers.originalPitchSemitones option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.originalSpeedPublished initialLayers.originalSpeed option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.originalVolumePublished initialLayers.originalVolume option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracksPublished initialLayers.tracks option. | VideoPipelineAudioTrack[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.durationPublished initialLayers.tracks.duration option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.fadeInPublished initialLayers.tracks.fadeIn option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.fadeOutPublished initialLayers.tracks.fadeOut option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.panPublished initialLayers.tracks.pan option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.pitchSemitonesPublished initialLayers.tracks.pitchSemitones option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sourcePublished initialLayers.tracks.source option. | string | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.sourceStartPublished initialLayers.tracks.sourceStart option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.speedPublished initialLayers.tracks.speed option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.startTimePublished initialLayers.tracks.startTime option. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.typePublished initialLayers.tracks.type option. | "file" | RequiredDefaultRequired | "file" | node22 · node24 · node26 |
initialLayers.tracks.volumePublished initialLayers.tracks.volume option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.gainPublished initialLayers.tracks.gain option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.presetPublished initialLayers.tracks.preset option. | SynthPresetName | RequiredDefaultRequired | 39 values"laser" "laserHeavy" "laserCharge" "explosion" "explosionSmall" "explosionDeep" "hit" "hitSoft" "hitMetal" "coin" "powerup" "powerupLong" "shield" "jump" "jumpHigh" "alarm" "alarmUrgent" "beep" "beepHigh" "click" "clickSoft" "whoosh" "whooshIn" "engine" "engineIdle" "siren" "gameOver" "gameOverSoft" "blip" "charge" "failure" "success" "menuSelect" "menuBack" "footstep" "slash" "rumble" "sparkle" "thunder" | node22 · node24 · node26 |
initialLayers.tracks.transposePublished initialLayers.tracks.transpose option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.soundPublished initialLayers.tracks.sound option. | SynthSoundOptions | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.sound.channelsPublished initialLayers.tracks.sound.channels option. | 2 | 1 | OptionalDefault— | 2 1 | node22 · node24 · node26 |
initialLayers.tracks.sound.durationTotal duration; auto-computed from layers when omitted. Must be > 0. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layersPublished initialLayers.tracks.sound.layers option. | SynthLayer[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.adsrPublished initialLayers.tracks.sound.layers.adsr option. | AdsrEnvelope | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.adsr.attackPublished initialLayers.tracks.sound.layers.adsr.attack option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.adsr.decayPublished initialLayers.tracks.sound.layers.adsr.decay option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.adsr.releasePublished initialLayers.tracks.sound.layers.adsr.release option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.adsr.sustainPublished initialLayers.tracks.sound.layers.adsr.sustain option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.delayDelay before this layer starts (seconds, relative to sound start). | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.detuneDetune in cents. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.durationLayer length in seconds. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.filterPublished initialLayers.tracks.sound.layers.filter option. | FilterOptions | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.filter.cutoffCutoff in Hz; must be below Nyquist. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.filter.qBiquad Q/resonance. Default sqrt(1/2); supported range 0.1–20. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.filter.typePublished initialLayers.tracks.sound.layers.filter.type option. | FilterType | RequiredDefaultRequired | "lowpass" "highpass" | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.frequencyStart frequency in Hz for tonal waveforms. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.frequencyEndLinear per-sample sweep to this frequency by the final frame. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.gainLayer gain, validated in the range 0–4. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.noiseMixBlend white noise into tonal waveforms, 0–1. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.panEqual-power pan: -1 left, 0 center, +1 right. Used only for stereo output. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.partialsHarmonic partials as `[frequencyRatio, gain][]`. Tonal waveforms only; aggregate partial amplitude is normalized. | [number, number][] | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.tremoloPublished initialLayers.tracks.sound.layers.tremolo option. | TremoloOptions | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.tremolo.depthDepth 0–1. Output amplitude stays non-negative. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.tremolo.rateLFO rate in Hz. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.vibratoPublished initialLayers.tracks.sound.layers.vibrato option. | VibratoOptions | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.vibrato.depthFrequency deviation in Hz. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.vibrato.rateLFO rate in Hz. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.sound.layers.waveformPublished initialLayers.tracks.sound.layers.waveform option. | Waveform | OptionalDefault— | 6 values"square" "triangle" "noise" "sine" "sawtooth" "pink" | node22 · node24 · node26 |
initialLayers.tracks.sound.limiterPeak-normalize overs to 0.98 (default true). `false` disables normalization; PCM encoding still clamps full scale. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
initialLayers.tracks.sound.masterGainMaster gain, validated in the range 0–4. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.sampleRatePublished initialLayers.tracks.sound.sampleRate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.sound.seedOptional operation-local deterministic seed for noise. Numbers must be safe integers; strings are hashed deterministically. | AudioSeed | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.eventsPublished initialLayers.tracks.events option. | SynthSequenceEvent[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.events.atStart time on the master timeline in seconds. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.events.gainPer-event gain multiplier. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.optionsPublished initialLayers.tracks.events.options option. | SynthSoundOptions | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.channelsPublished initialLayers.tracks.events.options.channels option. | 2 | 1 | OptionalDefault— | 2 1 | node22 · node24 · node26 |
initialLayers.tracks.events.options.durationTotal duration; auto-computed from layers when omitted. Must be > 0. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layersPublished initialLayers.tracks.events.options.layers option. | SynthLayer[] | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.adsrPublished initialLayers.tracks.events.options.layers.adsr option. | AdsrEnvelope | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.adsr.attackPublished initialLayers.tracks.events.options.layers.adsr.attack option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.adsr.decayPublished initialLayers.tracks.events.options.layers.adsr.decay option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.adsr.releasePublished initialLayers.tracks.events.options.layers.adsr.release option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.adsr.sustainPublished initialLayers.tracks.events.options.layers.adsr.sustain option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.delayDelay before this layer starts (seconds, relative to sound start). | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.detuneDetune in cents. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.durationLayer length in seconds. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.filterPublished initialLayers.tracks.events.options.layers.filter option. | FilterOptions | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.filter.cutoffCutoff in Hz; must be below Nyquist. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.filter.qBiquad Q/resonance. Default sqrt(1/2); supported range 0.1–20. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.filter.typePublished initialLayers.tracks.events.options.layers.filter.type option. | FilterType | RequiredDefaultRequired | "lowpass" "highpass" | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.frequencyStart frequency in Hz for tonal waveforms. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.frequencyEndLinear per-sample sweep to this frequency by the final frame. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.gainLayer gain, validated in the range 0–4. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.noiseMixBlend white noise into tonal waveforms, 0–1. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.panEqual-power pan: -1 left, 0 center, +1 right. Used only for stereo output. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.partialsHarmonic partials as `[frequencyRatio, gain][]`. Tonal waveforms only; aggregate partial amplitude is normalized. | [number, number][] | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.tremoloPublished initialLayers.tracks.events.options.layers.tremolo option. | TremoloOptions | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.tremolo.depthDepth 0–1. Output amplitude stays non-negative. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.tremolo.rateLFO rate in Hz. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.vibratoPublished initialLayers.tracks.events.options.layers.vibrato option. | VibratoOptions | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.vibrato.depthFrequency deviation in Hz. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.vibrato.rateLFO rate in Hz. | number | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.layers.waveformPublished initialLayers.tracks.events.options.layers.waveform option. | Waveform | OptionalDefault— | 6 values"square" "triangle" "noise" "sine" "sawtooth" "pink" | node22 · node24 · node26 |
initialLayers.tracks.events.options.limiterPeak-normalize overs to 0.98 (default true). `false` disables normalization; PCM encoding still clamps full scale. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
initialLayers.tracks.events.options.masterGainMaster gain, validated in the range 0–4. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.sampleRatePublished initialLayers.tracks.events.options.sampleRate option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.options.seedOptional operation-local deterministic seed for noise. Numbers must be safe integers; strings are hashed deterministically. | AudioSeed | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.events.presetPublished initialLayers.tracks.events.preset option. | SynthPresetName | OptionalDefault— | 39 values"laser" "laserHeavy" "laserCharge" "explosion" "explosionSmall" "explosionDeep" "hit" "hitSoft" "hitMetal" "coin" "powerup" "powerupLong" "shield" "jump" "jumpHigh" "alarm" "alarmUrgent" "beep" "beepHigh" "click" "clickSoft" "whoosh" "whooshIn" "engine" "engineIdle" "siren" "gameOver" "gameOverSoft" "blip" "charge" "failure" "success" "menuSelect" "menuBack" "footstep" "slash" "rumble" "sparkle" "thunder" | node22 · node24 · node26 |
initialLayers.tracks.masterGainPublished initialLayers.tracks.masterGain option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.tailPublished initialLayers.tracks.tail option. | number | OptionalDefault— | — | node22 · node24 · node26 |
initialLayers.tracks.wavPublished initialLayers.tracks.wav option. | Buffer<ArrayBufferLike> | RequiredDefaultRequired | — | node22 · node24 · node26 |
initialLayers.id
OptionalStable key for upsert/replace (e.g. `"main-trim"`, `"titles"`).
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.kind
RequiredPublished initialLayers.kind option.
- Type
"source"- Default
- Required
- Allowed
"source"- Runtime
- node22, node24, node26
initialLayers.source
RequiredPublished initialLayers.source option.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.endTime
RequiredPublished initialLayers.endTime option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.startTime
RequiredPublished initialLayers.startTime option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.durationPolicy
OptionalPublished initialLayers.durationPolicy option.
- Type
"fit" | "preserve" | "trim"- Default
- —
- Allowed
"fit""preserve""trim"- Runtime
- node22, node24, node26
Published initialLayers.replacementDuration option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.replacementFps
OptionalPublished initialLayers.replacementFps option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.replacementFrames
OptionalPublished initialLayers.replacementFrames option.
- Type
(string | Buffer<ArrayBufferLike>)[]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.replacementStartTime option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.replacementVideo
OptionalPublished initialLayers.replacementVideo option.
- Type
string | Buffer<ArrayBufferLike>- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.targetEndTime
RequiredPublished initialLayers.targetEndTime option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.targetStartTime
RequiredPublished initialLayers.targetStartTime option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays
RequiredPublished initialLayers.overlays option.
- Type
VideoTextOverlayClip[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.bold
OptionalPublished initialLayers.overlays.bold option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
initialLayers.overlays.color
OptionalPublished initialLayers.overlays.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
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
Published initialLayers.overlays.decorations.bold option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.italic option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.overline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.strikethrough.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.decorations.underline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.effects
OptionalGrouped highlight, glow, and shadow. When set, entries override the legacy flat fields (see {@link resolveTextEffects}).
- Type
TextEffects- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow option.
- Type
TextGlowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.glow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight option.
- Type
TextHighlightStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.highlight.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow option.
- Type
TextShadowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.effects.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.endTime
RequiredSeconds when this overlay is hidden.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.fill
OptionalGrouped fill color / gradient and draw opacity (see {@link resolveTextFill}).
- Type
TextFill- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fill.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.font
OptionalPublished initialLayers.overlays.font option.
- Type
{ size?: number; family?: string; name?: string; path?: string; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.font.family option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.font.name
OptionalPublished initialLayers.overlays.font.name option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.font.path
OptionalPublished initialLayers.overlays.font.path option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.font.size
OptionalPublished initialLayers.overlays.font.size option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.fontFamily option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.fontName
OptionalPublished initialLayers.overlays.fontName option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.fontPath
OptionalPublished initialLayers.overlays.fontPath option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.fontSize
OptionalPublished initialLayers.overlays.fontSize option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.glow
OptionalPublished initialLayers.overlays.glow option.
- Type
TextGlowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.intensity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.glow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.gradient
OptionalPublished initialLayers.overlays.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.highlight
OptionalPublished initialLayers.overlays.highlight option.
- Type
TextHighlightStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.highlight.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.includeCharMetrics option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
initialLayers.overlays.italic
OptionalPublished initialLayers.overlays.italic option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
initialLayers.overlays.layout
OptionalGrouped line height, spacing, and wrap bounds (see {@link resolveTextLayout}).
- Type
TextLayout- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.layout.letterSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.layout.lineHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.layout.maxHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.layout.maxWidth option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.layout.wordSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.letterSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.lineHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.maxHeight
OptionalPublished initialLayers.overlays.maxHeight option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.maxWidth
OptionalPublished initialLayers.overlays.maxWidth option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.measurementCanvas option.
- Type
{ width?: number; height?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.measurementCanvas.height option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.measurementCanvas.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.opacity
OptionalPublished initialLayers.overlays.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
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
initialLayers.overlays.overline
OptionalPublished initialLayers.overlays.overline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.overline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.placement
OptionalGrouped alignment, baseline, and rotation (see {@link resolveTextPlacement}).
- Type
TextPlacement- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.placement.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.placement.textAlign option.
- Type
TextAlignMode- Default
- —
- Allowed
5 values
"center""left""right""start""end"- Runtime
- node22, node24, node26
Published initialLayers.overlays.placement.textBaseline option.
- Type
TextBaselineMode- Default
- —
- Allowed
6 values
"top""bottom""alphabetic""hanging""ideographic""middle"- Runtime
- node22, node24, node26
initialLayers.overlays.rotation
OptionalPublished initialLayers.overlays.rotation option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.shadow
OptionalPublished initialLayers.overlays.shadow option.
- Type
TextShadowStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.blur option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.offsetX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.offsetY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.shadow.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.startTime
RequiredSeconds when this overlay becomes visible.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.strikethrough.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.stroke
OptionalPublished initialLayers.overlays.stroke option.
- Type
TextStrokeStyle- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.stroke.opacity option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.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
Published initialLayers.overlays.stroke.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.text
RequiredPublished initialLayers.overlays.text option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.textAlign
OptionalPublished initialLayers.overlays.textAlign option.
- Type
TextAlignMode- Default
- —
- Allowed
5 values
"center""left""right""start""end"- Runtime
- node22, node24, node26
Published initialLayers.overlays.textBaseline option.
- Type
TextBaselineMode- Default
- —
- Allowed
6 values
"top""bottom""alphabetic""hanging""ideographic""middle"- Runtime
- node22, node24, node26
Published initialLayers.overlays.textOnCurve option.
- Type
TextCurveConfig- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.textOnCurve.baselineOffset option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.textOnCurve.layoutMode option.
- Type
CurvedTextLayoutMode- Default
- —
- Allowed
"fit""clamp""override"- Runtime
- node22, node24, node26
Published initialLayers.overlays.textOnCurve.radius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.textOnCurve.startAngleDeg option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.textOnCurve.sweepAngle option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.textOnCurve.up option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published initialLayers.overlays.transitionIn option.
- Type
VideoTextTransition- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
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
Published initialLayers.overlays.transitionIn.custom.alpha option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.transitionIn.custom.scale option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.transitionIn.custom.x option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.transitionIn.custom.y option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Seconds (default `0.35`).
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.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
Published initialLayers.overlays.transitionOut option.
- Type
VideoTextTransition- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
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
Published initialLayers.overlays.transitionOut.custom.alpha option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.transitionOut.custom.scale option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.transitionOut.custom.x option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.transitionOut.custom.y option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Seconds (default `0.35`).
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.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
initialLayers.overlays.underline
OptionalPublished initialLayers.overlays.underline option.
- Type
TextLineDecoration- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.color option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient option.
- Type
gradient- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.colors option.
- Type
GradientStop[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.colors.color option.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.colors.stop option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.endX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.endY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.pivotX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.pivotY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.repeat option.
- Type
"repeat" | "reflect" | "no-repeat"- Default
- —
- Allowed
"repeat""reflect""no-repeat"- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.rotate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.startX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.startY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.type option.
- Type
"linear"- Default
- Required
- Allowed
"linear"- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.endRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.startRadius option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.centerX option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.centerY option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.gradient.startAngle option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.underline.width option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.overlays.wordSpacing option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.x
RequiredPublished initialLayers.overlays.x option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.overlays.y
RequiredPublished initialLayers.overlays.y option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.keepOriginalAudio
OptionalPublished initialLayers.keepOriginalAudio option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Published initialLayers.originalPitchSemitones option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.originalSpeed
OptionalPublished initialLayers.originalSpeed option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.originalVolume
OptionalPublished initialLayers.originalVolume option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks
RequiredPublished initialLayers.tracks option.
- Type
VideoPipelineAudioTrack[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.duration
OptionalPublished initialLayers.tracks.duration option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.fadeIn
OptionalPublished initialLayers.tracks.fadeIn option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.fadeOut
OptionalPublished initialLayers.tracks.fadeOut option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.pan
OptionalPublished initialLayers.tracks.pan option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.pitchSemitones option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.source
RequiredPublished initialLayers.tracks.source option.
- Type
string | Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.sourceStart
OptionalPublished initialLayers.tracks.sourceStart option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.speed
OptionalPublished initialLayers.tracks.speed option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.startTime
RequiredPublished initialLayers.tracks.startTime option.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.type
RequiredPublished initialLayers.tracks.type option.
- Type
"file"- Default
- Required
- Allowed
"file"- Runtime
- node22, node24, node26
initialLayers.tracks.volume
OptionalPublished initialLayers.tracks.volume option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.gain
OptionalPublished initialLayers.tracks.gain option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.preset
RequiredPublished initialLayers.tracks.preset option.
- Type
SynthPresetName- Default
- Required
- Allowed
39 values
"laser""laserHeavy""laserCharge""explosion""explosionSmall""explosionDeep""hit""hitSoft""hitMetal""coin""powerup""powerupLong""shield""jump""jumpHigh""alarm""alarmUrgent""beep""beepHigh""click""clickSoft""whoosh""whooshIn""engine""engineIdle""siren""gameOver""gameOverSoft""blip""charge""failure""success""menuSelect""menuBack""footstep""slash""rumble""sparkle""thunder"- Runtime
- node22, node24, node26
initialLayers.tracks.transpose
OptionalPublished initialLayers.tracks.transpose option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.sound
RequiredPublished initialLayers.tracks.sound option.
- Type
SynthSoundOptions- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.sound.channels option.
- Type
2 | 1- Default
- —
- Allowed
21- Runtime
- node22, node24, node26
Total duration; auto-computed from layers when omitted. Must be > 0.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.sound.layers option.
- Type
SynthLayer[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.sound.layers.adsr option.
- Type
AdsrEnvelope- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.sound.layers.adsr.attack option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.sound.layers.adsr.decay option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.sound.layers.adsr.release option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.sound.layers.adsr.sustain option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Delay before this layer starts (seconds, relative to sound start).
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Detune in cents.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Layer length in seconds.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.sound.layers.filter option.
- Type
FilterOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Cutoff in Hz; must be below Nyquist.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Biquad Q/resonance. Default sqrt(1/2); supported range 0.1–20.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.sound.layers.filter.type option.
- Type
FilterType- Default
- Required
- Allowed
"lowpass""highpass"- Runtime
- node22, node24, node26
Start frequency in Hz for tonal waveforms.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Linear per-sample sweep to this frequency by the final frame.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Layer gain, validated in the range 0–4.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Blend white noise into tonal waveforms, 0–1.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Equal-power pan: -1 left, 0 center, +1 right. Used only for stereo output.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Harmonic partials as `[frequencyRatio, gain][]`. Tonal waveforms only; aggregate partial amplitude is normalized.
- Type
[number, number][]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.sound.layers.tremolo option.
- Type
TremoloOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Depth 0–1. Output amplitude stays non-negative.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
LFO rate in Hz.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.sound.layers.vibrato option.
- Type
VibratoOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Frequency deviation in Hz.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
LFO rate in Hz.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.sound.layers.waveform option.
- Type
Waveform- Default
- —
- Allowed
6 values
"square""triangle""noise""sine""sawtooth""pink"- Runtime
- node22, node24, node26
Peak-normalize overs to 0.98 (default true). `false` disables normalization; PCM encoding still clamps full scale.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Master gain, validated in the range 0–4.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.sound.sampleRate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.sound.seed
OptionalOptional operation-local deterministic seed for noise. Numbers must be safe integers; strings are hashed deterministically.
- Type
AudioSeed- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.events
RequiredPublished initialLayers.tracks.events option.
- Type
SynthSequenceEvent[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.events.at
RequiredStart time on the master timeline in seconds.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.events.gain
OptionalPer-event gain multiplier.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.events.options option.
- Type
SynthSoundOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.events.options.channels option.
- Type
2 | 1- Default
- —
- Allowed
21- Runtime
- node22, node24, node26
Total duration; auto-computed from layers when omitted. Must be > 0.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.events.options.layers option.
- Type
SynthLayer[]- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.events.options.layers.adsr option.
- Type
AdsrEnvelope- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.events.options.layers.adsr.attack option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.events.options.layers.adsr.decay option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.events.options.layers.adsr.release option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.events.options.layers.adsr.sustain option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Delay before this layer starts (seconds, relative to sound start).
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Detune in cents.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Layer length in seconds.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.events.options.layers.filter option.
- Type
FilterOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Cutoff in Hz; must be below Nyquist.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Biquad Q/resonance. Default sqrt(1/2); supported range 0.1–20.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.events.options.layers.filter.type option.
- Type
FilterType- Default
- Required
- Allowed
"lowpass""highpass"- Runtime
- node22, node24, node26
Start frequency in Hz for tonal waveforms.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Linear per-sample sweep to this frequency by the final frame.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Layer gain, validated in the range 0–4.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Blend white noise into tonal waveforms, 0–1.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Equal-power pan: -1 left, 0 center, +1 right. Used only for stereo output.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Harmonic partials as `[frequencyRatio, gain][]`. Tonal waveforms only; aggregate partial amplitude is normalized.
- Type
[number, number][]- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.events.options.layers.tremolo option.
- Type
TremoloOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Depth 0–1. Output amplitude stays non-negative.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
LFO rate in Hz.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.events.options.layers.vibrato option.
- Type
VibratoOptions- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Frequency deviation in Hz.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
LFO rate in Hz.
- Type
number- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.events.options.layers.waveform option.
- Type
Waveform- Default
- —
- Allowed
6 values
"square""triangle""noise""sine""sawtooth""pink"- Runtime
- node22, node24, node26
Peak-normalize overs to 0.98 (default true). `false` disables normalization; PCM encoding still clamps full scale.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
Master gain, validated in the range 0–4.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.events.options.sampleRate option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Optional operation-local deterministic seed for noise. Numbers must be safe integers; strings are hashed deterministically.
- Type
AudioSeed- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Published initialLayers.tracks.events.preset option.
- Type
SynthPresetName- Default
- —
- Allowed
39 values
"laser""laserHeavy""laserCharge""explosion""explosionSmall""explosionDeep""hit""hitSoft""hitMetal""coin""powerup""powerupLong""shield""jump""jumpHigh""alarm""alarmUrgent""beep""beepHigh""click""clickSoft""whoosh""whooshIn""engine""engineIdle""siren""gameOver""gameOverSoft""blip""charge""failure""success""menuSelect""menuBack""footstep""slash""rumble""sparkle""thunder"- Runtime
- node22, node24, node26
initialLayers.tracks.masterGain
OptionalPublished initialLayers.tracks.masterGain option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.tail
OptionalPublished initialLayers.tracks.tail option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
initialLayers.tracks.wav
RequiredPublished initialLayers.tracks.wav option.
- Type
Buffer<ArrayBufferLike>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Types
VideoPipelineLayer[]
- variant 1
VideoPipelineLayer- variant 1
VideoPipelineSourceLayer: VideoPipelineSourceLayer- kind
"source" - source
string | Buffer<ArrayBufferLike>- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- id?
string
- kind
- variant 2
VideoPipelineTrimLayer: VideoPipelineTrimLayer- kind
"trim" - startTime
number - endTime
number - id?
string
- kind
- variant 3
VideoPipelineSpliceLayer: VideoPipelineSpliceLayer- kind
"splice" - targetStartTime
number - targetEndTime
number - replacementVideo?
string | Buffer<ArrayBufferLike>- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- replacementStartTime?
number - replacementDuration?
number - replacementFrames?
(string | Buffer<ArrayBufferLike>)[]- variant 1
string | Buffer<ArrayBufferLike>- variant 1
string - variant 2
Buffer<ArrayBufferLike>
- variant 1
- variant 1
- replacementFps?
number - durationPolicy?
"fit" | "preserve" | "trim"- variant 1
"fit" - variant 2
"preserve" - variant 3
"trim"
- variant 1
- id?
string
- kind
- variant 4
VideoPipelineTextLayer: VideoPipelineTextLayer- kind
"text" - overlays
VideoTextOverlayClip[]- variant 1
VideoTextOverlayClip: VideoTextOverlayClip- startTime
number - endTime
number - transitionIn?
VideoTextTransition - transitionOut?
VideoTextTransition - overlayOpacity?
number - text
string - x
number - y
number - font?
{ size?: number; family?: string; name?: string; path?: string; } - fontSize?
number - fontFamily?
string - fontName?
string - fontPath?
string - bold?
boolean - italic?
boolean - decorations?
TextDecorations - effects?
TextEffects - underline?
TextLineDecoration - overline?
TextLineDecoration - strikethrough?
TextLineDecoration - highlight?
TextHighlightStyle - glow?
TextGlowStyle - shadow?
TextShadowStyle - layout?
TextLayout - placement?
TextPlacement - fill?
TextFill - lineHeight?
number - letterSpacing?
number - wordSpacing?
number - maxWidth?
number - maxHeight?
number - textAlign?
TextAlignMode - textBaseline?
TextBaselineMode - rotation?
number - color?
string - gradient?
gradient - opacity?
number - stroke?
TextStrokeStyle - textOnCurve?
TextCurveConfig - includeCharMetrics?
boolean - measurementCanvas?
{ width?: number; height?: number; }
- startTime
- variant 1
- id?
string
- kind
- variant 5
VideoPipelineAudioLayer: VideoPipelineAudioLayer- kind
"audio" - tracks
VideoPipelineAudioTrack[]- variant 1
VideoPipelineAudioTrack- variant 1
VideoPipelineAudioFileTrack - variant 2
VideoPipelineAudioPresetTrack - variant 3
VideoPipelineAudioSynthTrack - variant 4
VideoPipelineAudioSequenceTrack - variant 5
VideoPipelineAudioWavTrack
- variant 1
- variant 1
- keepOriginalAudio?
boolean - originalVolume?
number - originalSpeed?
number - originalPitchSemitones?
number - durationPolicy?
"video" | "shortest" | "longest"- variant 1
"video" - variant 2
"shortest" - variant 3
"longest"
- variant 1
- id?
string
- kind
- variant 1
Return value
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.