RenderOptions

RenderOptions = object

Defined in: types.ts:78

Rendering options passed as-is to data.json. Mirrors the renderOptions shape consumed by the rendering pipeline.

Properties

mouse?

optional mouse?: object

Defined in: types.ts:104

size?

optional size?: number

0-1: 0=missing, 1=height of video

---

narration?

optional narration?: object

Defined in: types.ts:88

corner?

optional corner?: "top-left" | "top-right" | "bottom-left" | "bottom-right"

dropShadow?

optional dropShadow?: number

Narration shadow strength (0-1).

• 0 disables shadow
• 1 maps to maximum shadow

padding?

optional padding?: number

0-1: 0=nothing, 1=length of shorter side of the frame

roundness?

optional roundness?: number

0-1: 0=square, 1=circle

shape?

optional shape?: "rounded"

size?

optional size?: number

0-1: 1=mask size equals shorter side of output

---

output?

optional output?: object

Defined in: types.ts:108

aspectRatio?

optional aspectRatio?: AspectRatio

Aspect ratio of the rendered output video.

Combined with quality, this determines the final pixel dimensions. See AspectRatio for the full dimension table.

Defaults to '16:9' when not specified.

Example

'16:9'

background?

optional background?: { assetPath: string; } | { backgroundCss: string; }

quality?

optional quality?: Quality

Resolution quality of the rendered output video.

Combined with aspectRatio, this determines the final pixel dimensions. See Quality for available presets.

Defaults to '1080p' when not specified.

Example

'1080p'

---

recording?

optional recording?: object

Defined in: types.ts:79

dropShadow?

optional dropShadow?: string

CSS drop-shadow filter

roundness?

optional roundness?: number

0-1: 0=sharp corners, 1=shorter side is half circle

shape?

optional shape?: "rounded"

size?

optional size?: number

0-1: 0 causes warning, 1=one side touches background edge