RenderOptions

RenderOptions = object

Defined in: types.ts:148

Properties

mouse?

optional mouse?: object

Defined in: types.ts:186

image?

optional image?: string

Path to a custom cursor image, relative to the config directory. When set, it replaces the built-in style cursor in both video and screenshot output. The image is uploaded alongside the recording like any other asset.

PNG is recommended (the video pipeline may lack an SVG decoder). The image’s top-left corner is the pointer hotspot, matching the built-in cursors, and it is scaled by size (aspect ratio preserved).

motionBlur?

optional motionBlur?: number

Cursor motion blur, 0-1. Defaults to 0.5; 0 disables it. The value is the shutter open time as a fraction of one output frame interval, so a fast-moving cursor smears along its path. Slow or static frames cost nothing.

size?

optional size?: number

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

style?

optional style?: "white" | "black"

Cursor colour. Defaults to 'white'. Ignored when image is set.

---

narration?

optional narration?: object

Defined in: types.ts:157

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 fraction of the output frame: 0=nothing, 1=length of shorter side of the frame.

roundness?

optional roundness?: number

0-1 fraction: 0=square, 1=circle.

size?

optional size?: number

0-1 fraction of the output frame: 1=mask size equals shorter side of output.

sizeZoomed?

optional sizeZoomed?: number

Narration size when the recording is smaller than the full frame. When set, the narration bubble scales down and tightens into its corner with the recording size. Omit to keep a fixed size. 0-1: same units as size.

voice?

optional voice?: AnyTopLevelVoiceConfig

Global default narration voice, used as the config-level default in the voice cascade. The per-language and per-cue voice live in the localize spec (voice and per-cue { cue, voice }); this is only the fallback when neither is set.

---

output?

optional output?: object

Defined in: types.ts:218

aspectRatio?

optional aspectRatio?: AspectRatio

Aspect ratio of the rendered video output.

Combined with quality, this determines the final pixel dimensions. See AspectRatio for the full dimension table. Screenshots use ScreenshotRenderOptions.aspectRatio instead (which also allows 'auto').

Defaults to '16:9' when not specified.

Example

'16:9'

background?

optional background?: { assetPath: string; fileHash?: 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. Screenshots ignore this: their resolution comes from the captured clip (or the full output frame) scaled by the capture device pixel density.

Defaults to '1080p' when not specified.

Example

'1080p'

---

recording?

optional recording?: object

Defined in: types.ts:149

dropShadow?

optional dropShadow?: number

Shadow strength from 0 (none) to 1 (default shadow).

roundness?

optional roundness?: number

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

size?

optional size?: number

0-1 fraction of the output frame: 0 causes warning, 1=one side touches background edge.

---

screenshot?

optional screenshot?: ScreenshotRenderOptions

Defined in: types.ts:250

Screenshot-only render options (format, margin, aspectRatio).

---

zoom?

optional zoom?: object

Defined in: types.ts:210

motionBlur?

optional motionBlur?: number

Camera (pan/zoom) motion blur, 0-1. Defaults to 0.5; 0 disables it. Same shutter semantics as mouse.motionBlur, applied to the camera viewport so fast pans and zooms smear. Independent of the cursor blur.