Docs

vidovaSettings schema

Field specification for the vidovaSettings object used by Vidova MCP tools.

View as Markdown

Export vidovaSettingsSchema from the desktop Zod sources.

FieldTypeRequiredConstraintsDefaultDescription
layoutenum("screen-and-cam", "screen-only", "cam-only", "half-half")no———
cropobjectno——Normalized crop edges for the screen recording: Left/Top/Right/Bottom in the 0..1 range.
crop.Topnumbernomin 0; max 1——
crop.Bottomnumbernomin 0; max 1——
crop.Leftnumbernomin 0; max 1——
crop.Rightnumbernomin 0; max 1——
zoomLayerIdstringno——Use a zoom layer ID from timeline_get_state. Pass an empty string to clear.
blurLayerIdstringno——Use an overlay/blur layer ID from timeline_get_state. Pass an empty string to clear.
roundednessnumbernomin 0; max 50——
paddingnumbernomin 0; max 100——
screenAudioVolumenumbernomin 0; max 1——
cameraAudioVolumenumbernomin 0; max 1——
muteScreenAudiobooleanno———
muteCameraAudiobooleanno———
zoomAnimationStyleenum("soft-spring", "snappy-spring", "soft-landing", "fast-settle", "gentle-curve")no——Zoom feel: soft-spring (default), snappy-spring, soft-landing, fast-settle, gentle-curve.
panAnimationStyleenum("heavy-camera", "quick-follow", "soft-lag")no——Pan feel: heavy-camera (default), quick-follow, soft-lag.
linkedZoomTransitionDurationnumbernomin 0; max 2——
useAutoLinkedZoomTransitionDurationbooleanno——Set true to clear the manual linked zoom handoff duration.
trackingIntensityintegernomin 0; max 5——
trackingStyleenum("steadicam", "director", "anchor", "momentum")no——Camera-path solver for cursor-following zooms: steadicam, director, anchor, or momentum.
clickFollowobjectnostrict—Keep out-of-view clicks in frame and near centre. Clicks already in view stay put. enabled (default true), tight 0.05-0.45 (default 0.35), zoom 1-6 (steadicam click-punch cap, default 3.5), window 0.2-1.6s (default 0.8), lead 0-0.8s (default 0.38), margin 0.35-1 (steadicam hold slack, default 0.85). Partial objects merge with the clip current values.
clickFollow.enabledbooleanno———
clickFollow.tightnumbernomin 0.05; max 0.45——
clickFollow.windownumbernomin 0.2; max 1.6——
clickFollow.leadnumbernomin 0; max 0.8——
clickFollow.zoomnumbernomin 1; max 6——
clickFollow.marginnumbernomin 0.35; max 1——
motionBlurStrengthnumbernomin 0; max 2——
cursorHiddenbooleanno——False shows the cursor.
cursorStyleenum("default", "cartoon", "modern", "original", "banana", "capitaine-dark", "capitaine-light", "touch", "tahoe", "whitesur", "bibata", "bibata-original")no———
cursorSizenumbernomin 16; max 256——
smoothCursorChangesbooleanno———
hideCursorWhenStillbooleanno———
enableCursorMotionBlurbooleanno———
cursorMotionBlurStrengthnumbernomin 0; max 2——
enableCursorTiltingbooleanno———
cursorClickSfxbooleanno——Play mouse click sounds (down and up). Default true.
returnToOriginalPositionbooleanno———
cursorSmoothingStyleenum("original", "steady", "soft", "fluid", "glide")no——Cursor path: original, steady (default), soft, fluid, glide.
pinCursorToClicksbooleanno——Pin the path through each click so the cursor lands on the button.
cursorClickPinWindownumbernomin 0.04; max 0.4—How long the cursor holds on each click, in seconds. Default 0.12.
cursorSmoothingTimenumbernomin 0.01; max 0.12—Steady and Soft smoothness in seconds. Default 0.045.
cursorSmoothingSpacenumbernomin 4; max 80—Steady: how strongly fast flicks are kept, in pixels. Default 18.
cursorSmoothingTensionnumbernomin 40; max 400—Fluid spring weight. Default 170.
cursorSmoothingFrictionnumbernomin 4; max 40—Fluid spring damping. Default 20.
cursorSmoothingSimplifynumbernomin 2; max 40—Glide: how much jitter to drop before the curve. Default 8.
clickEffectStyleenum("none", "default", "effect-1", "effect-2", "effect-3", "effect-4", "effect-5", "effect-6")no———
clickEffectSizenumbernomin 16; max 256——
cursorSpotlightobjectnostrict——
cursorSpotlight.enabledbooleanno———
cursorSpotlight.radiusnumberno———
cursorSpotlight.softnessnumberno———
cursorSpotlight.dimOpacitynumberno———
cursorSpotlight.onlyOnClickbooleanno———
cursorSpotlight.clickWindownumbernomin 0.05; max 4——
cameraobjectno———
camera.sizenumbernomin 5; max 70——
camera.sizeDuringZoomnumbernomin 5; max 100——
camera.roundednessnumbernomin 0; max 100——
camera.shapeenum("default", "squircle", "circle")no———
camera.hideCamerabooleanno——False shows the camera overlay.
camera.mirrorCamerabooleanno———
camera.removeBackgroundbooleanno——True composites the baked person mask. The mask must already exist on the camera asset.
camera.positionobjectno——Camera anchor grid position. Use -1, 0, or 1 for x/y.
camera.position.xnumberyesmin -1; max 1——
camera.position.ynumberyesmin -1; max 1——
camera.alignmentobjectno——Crop alignment inside squircle/circle camera shapes.
camera.alignment.xnumberyesmin -1; max 1——
camera.alignment.ynumberyesmin -1; max 1——
camera.differentSizeDuringZoombooleanno———
camera.verticalPaddingnumbernomin 0; max 100——
camera.globalPositionbooleanno——True anchors the camera to the scene instead of the clip.
mouseIndicatorobjectno———
mouseIndicator.enabledbooleanno———
mouseIndicator.positionobjectno——Mouse indicator anchor grid position. Use -1, 0, or 1 for x/y.
mouseIndicator.position.xnumberyesmin -1; max 1——
mouseIndicator.position.ynumberyesmin -1; max 1——
mouseIndicator.sizenumbernomin 40; max 180—Mouse indicator size in px.
mouseIndicator.opacitynumbernomin 0; max 1——
mouseIndicator.styleenum("minimal", "dark", "light", "colored")no———
mouseIndicator.highlightColorstringnopattern ^#[0-9a-fA-F]\{6\}$——
mouseIndicator.minActiveDurationnumbernomin 0.02; max 0.5—Minimum button/wheel highlight duration in seconds.
mouseIndicator.globalPositionbooleanno——True anchors the mouse indicator to the scene instead of the clip.
qualitynumbernomin 0—Motion-blur shader sample quality. 0 disables sampled motion blur.
sharpenFactornumbernomin 0; max 5——
shadowStrengthnumbernomin 0; max 100——
insetnumbernomin 0; max 50——
isVerticalbooleanno———
showShortcutsbooleanno———
keyboardClickSfxbooleanno——Play a click sound on recorded key presses. Default true.
keyboardClickSfxModeenum("shortcuts", "all")no——Which key presses get a click sound: "shortcuts" for modifier combos only, "all" for every key press. Default "shortcuts".
shortcutsSizenumbernomin 1; max 300——
shortcutsDurationnumbernomin 0.5; max 5——
captionSettingsobjectnostrict——
captionSettings.enabledbooleanno———
captionSettings.fontFamilystringno———
captionSettings.fontWeight400 \500 \700no—
captionSettings.fontSizenumberno———
captionSettings.distanceFromBottomnumberno———
captionSettings.styleenum("pill", "karaoke-lime", "karaoke-magenta", "karaoke-cyan", "outlined", "bold-outline", "minimal", "word-highlight", "pink-pill", "dark-pill-lime", "cloud-blob", "amber-tape", "studio")no———
captionSettings.textColorstringno———
captionSettings.highlightColorstringno———
captionSettings.backgroundColorstringno———
captionSettings.shadowColorstringno———
captionSettings.shadowBlurnumberno———
captionSettings.maxCharsPerLinenumberno———