Create project
POST /api/projects
Save a new editor draft project. Provide the project JSON under payload (project is accepted as an alias). The draft becomes editable at https://editor.zvid.io?project=<id>.
Authentication
- Option 1:
x-api-key: YOUR_API_KEY(header). API key for authentication. Create one in your dashboard. - Option 2:
Authorization: Bearer YOUR_ACCESS_TOKEN. Dashboard JWT in Authorization: Bearer <token>, only on operations that explicitly list this scheme. Prefer x-api-key for REST integrations. OAuth for hosted MCP is a separate connection at https://mcp.zvid.io/mcp.
Create API keys at app.zvid.io/api-keys. Keep credentials on your server.
Parameters
This operation has no path, query, or additional header parameters.
Request
The shell examples read credentials from ZVID_API_KEY (or ZVID_ACCESS_TOKEN for Bearer authentication). Set that variable in your environment. Replace sample project, template, job, and asset identifiers with values from your own account.
A request body is required.
application/json
Unknown properties are rejected. Required properties: name. Exactly one of the listed alternatives must match.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
body.name | string | Yes | Minimum length: 1. Maximum length: 255. |
body.payload | RenderPayload | No | |
body.project | RenderPayload | No | Compatibility alias for payload; never supply both. |
oneOf alternative 1
Required properties: payload.
Type: any JSON value.
Additional JSON Schema constraints:
{
"not": {
"required": [
"project"
]
}
}
oneOf alternative 2
Required properties: project.
Type: any JSON value.
Additional JSON Schema constraints:
{
"not": {
"required": [
"payload"
]
}
}
Request example: Example
curl --request POST 'https://api.zvid.io/api/projects' \
--header "x-api-key: $ZVID_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"name": "Greeting draft",
"payload": {
"name": "Hello Zvid",
"width": 1280,
"height": 720,
"duration": 5,
"visuals": [
{
"type": "TEXT",
"text": "Hello, Zvid!"
}
]
}
}'
Responses
HTTP 201
Project created
Content type: application/json.
Required properties: project.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
response.project | Project | Yes |
HTTP 400
Validation failed
Content type: application/json.
Required properties: error.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
response.error | string | Yes | |
response.message | string | No | |
response.details | array of object | No | |
response.planLimits | object | No | Present on render validation errors; contains the authenticated user's current render limits. |
Nested field: response.details
Array item: response.details[]
Unknown properties are rejected. Required properties: field, message.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
response.details[].field | string | Yes | |
response.details[].message | string | Yes |
HTTP 401
Unauthorized
Content type: application/json.
Unknown properties are rejected. Required properties: error.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
response.error | string | Yes | Error type |
response.message | string | No | Human-readable error message |
Schema definitions
The following definitions describe the fields referenced above. Expand a definition to inspect its complete contract.
RenderPayload
The payload accepted by render requests and stored templates, before variable substitution, conditions and scene iteration. Whole placeholders preserve the variable's type. Run authenticated validation to resolve values, enforce semantic rules and apply your account limits. Stored video templates require explicit positive scene durations.
Unknown properties are rejected. All listed constraints apply.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
RenderPayload.type | "video" / "image" | No | Render type. "image" produces a still (png/jpg/webp) and forbids all time-domain fields. Default: "video". |
RenderPayload.name | string OR string | No | At least one listed alternative must match. |
RenderPayload.resolution | "sd" / "hd" / "full-hd" / "squared" / "youtube-short" / "youtube-video" / "tiktok" / "instagram-reel" / "instagram-post" / "instagram-story" / "instagram-feed" / "twitter-landscape" / "twitter-portrait" / "twitter-square" / "facebook-video" / "facebook-story" / "facebook-post" / "snapchat" / "custom" OR string | No | At least one listed alternative must match. |
RenderPayload.width | integer OR string | No | At least one listed alternative must match. |
RenderPayload.height | integer OR string | No | At least one listed alternative must match. |
RenderPayload.duration | number OR string | No | At least one listed alternative must match. |
RenderPayload.durationMode | "auto" / "fixed" OR string | No | At least one listed alternative must match. |
RenderPayload.frameRate | integer OR string | No | At least one listed alternative must match. |
RenderPayload.outputFormat | "mp4" / "mov" / "avi" / "webm" / "png" / "jpg" / "jpeg" / "webp" OR string | No | At least one listed alternative must match. |
RenderPayload.backgroundColor | string OR string | No | At least one listed alternative must match. |
RenderPayload.snapshotTime | number OR string | No | At least one listed alternative must match. |
RenderPayload.quality | integer OR string | No | At least one listed alternative must match. |
RenderPayload.transparent | boolean OR string | No | At least one listed alternative must match. |
RenderPayload.visuals | array of Visual OR string | No | At least one listed alternative must match. |
RenderPayload.audios | array of AudioItem OR string | No | At least one listed alternative must match. |
RenderPayload.scenes | array of Scene OR string | No | At least one listed alternative must match. |
RenderPayload.thumbnail | string OR string | No | At least one listed alternative must match. |
RenderPayload.subtitle | Subtitle OR string | No | At least one listed alternative must match. |
RenderPayload.variables | object | No | Default variable values; request variables override these. Scene defaults shadow project values inside that scene. |
Nested field: RenderPayload.name
At least one listed alternative must match.
anyOf alternative 1
Output name. Letters, digits, space, _ and - ONLY (no punctuation).
Default: "unnamed". Maximum length: 1000. Pattern: ^[a-zA-Z0-9_\- ]+$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.resolution
At least one listed alternative must match.
anyOf alternative 1
Canvas preset. Any value except "custom" OVERRIDES width/height.
Type: "sd" / "hd" / "full-hd" / "squared" / "youtube-short" / "youtube-video" / "tiktok" / "instagram-reel" / "instagram-post" / "instagram-story" / "instagram-feed" / "twitter-landscape" / "twitter-portrait" / "twitter-square" / "facebook-video" / "facebook-story" / "facebook-post" / "snapchat" / "custom".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.width
At least one listed alternative must match.
anyOf alternative 1
Canvas width in px (plan-limited).
Default: 1280. Minimum: 1.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.height
At least one listed alternative must match.
anyOf alternative 1
Canvas height in px (plan-limited).
Default: 720. Minimum: 1.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.duration
At least one listed alternative must match.
anyOf alternative 1
Video length in seconds (plan-limited). With durationMode auto this is an optional minimum. Scene projects always include the full scene sequence.
Default: 10. Minimum: 0.1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.durationMode
At least one listed alternative must match.
anyOf alternative 1
Auto derives length from scenes, explicit element ends and captions. Supply videoEnd/exitEnd and audioEnd/exit for API submission. Omit to preserve legacy timing.
Type: "auto" / "fixed".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.frameRate
At least one listed alternative must match.
anyOf alternative 1
Frames per second.
Default: 30. Minimum: 1. Maximum: 60.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.outputFormat
At least one listed alternative must match.
anyOf alternative 1
Videos: mp4 (default), mov, avi, webm. Images (type: "image"): png (default), jpg, jpeg, webp.
Type: "mp4" / "mov" / "avi" / "webm" / "png" / "jpg" / "jpeg" / "webp".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.backgroundColor
At least one listed alternative must match.
anyOf alternative 1
Canvas background color.
Default: "#ffffff". Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.snapshotTime
At least one listed alternative must match.
anyOf alternative 1
Image renders only: second of the (virtual) timeline to snapshot.
Minimum: 0. Maximum: 3600.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.quality
At least one listed alternative must match.
anyOf alternative 1
Image renders only: jpg/webp quality (NOT valid for png).
Minimum: 1. Maximum: 100.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.transparent
At least one listed alternative must match.
anyOf alternative 1
Image renders only: transparent background (png/webp only, not jpg).
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.visuals
At least one listed alternative must match.
anyOf alternative 1
Elements shown for the whole project (outside scenes).
Array item: RenderPayload.visuals[]
Schema: Visual.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.audios
At least one listed alternative must match.
anyOf alternative 1
Project-level audio tracks (video only, plan-limited count).
Array item: RenderPayload.audios[]
Schema: AudioItem.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.scenes
At least one listed alternative must match.
anyOf alternative 1
Sequential timeline segments (video only, plan-limited count).
Array item: RenderPayload.scenes[]
Schema: Scene.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.thumbnail
At least one listed alternative must match.
anyOf alternative 1
Custom thumbnail image URL (video only). Must be a PUBLIC http(s) URL: no credentials, no spaces/backslashes, port 80/443 only, no localhost/.local, no private IPs.
Minimum length: 1. Maximum length: 2048. Pattern: ^https?://.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: RenderPayload.subtitle
At least one listed alternative must match.
anyOf alternative 1
Schema: Subtitle.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
allOf alternative 1
Type: any JSON value.
Additional JSON Schema constraints:
{
"if": {
"properties": {
"type": {
"const": "image"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"duration": false,
"durationMode": false,
"frameRate": false,
"audios": false,
"scenes": false,
"thumbnail": false,
"subtitle": false,
"outputFormat": {
"anyOf": [
{
"enum": [
"png",
"jpg",
"jpeg",
"webp"
],
"default": "png"
},
{
"type": "string",
"pattern": "\\{\\{\\s*[A-Za-z][A-Za-z0-9_]*(?:\\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\\s*\\}\\}"
}
]
},
"visuals": {
"anyOf": [
{
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ImageVisual"
},
{
"$ref": "#/components/schemas/TextVisual"
},
{
"$ref": "#/components/schemas/SvgVisual"
}
]
}
},
{
"type": "string",
"pattern": "\\{\\{\\s*[A-Za-z][A-Za-z0-9_]*(?:\\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\\s*\\}\\}"
}
]
}
}
},
"else": {
"properties": {
"snapshotTime": false,
"quality": false,
"transparent": false,
"outputFormat": {
"anyOf": [
{
"enum": [
"mp4",
"mov",
"avi",
"webm"
],
"default": "mp4"
},
{
"type": "string",
"pattern": "\\{\\{\\s*[A-Za-z][A-Za-z0-9_]*(?:\\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\\s*\\}\\}"
}
]
}
}
}
}
allOf alternative 2
Type: any JSON value.
Additional JSON Schema constraints:
{
"if": {
"properties": {
"type": {
"const": "image"
},
"outputFormat": {
"enum": [
"png"
]
}
},
"required": [
"type",
"outputFormat"
]
},
"then": {
"properties": {
"quality": false
}
}
}
allOf alternative 3
Type: any JSON value.
Additional JSON Schema constraints:
{
"if": {
"properties": {
"type": {
"const": "image"
}
},
"required": [
"type"
],
"not": {
"required": [
"outputFormat"
]
}
},
"then": {
"properties": {
"quality": false
}
}
}
allOf alternative 4
Type: any JSON value.
Additional JSON Schema constraints:
{
"if": {
"properties": {
"type": {
"const": "image"
},
"outputFormat": {
"enum": [
"jpg",
"jpeg"
]
}
},
"required": [
"type",
"outputFormat"
]
},
"then": {
"properties": {
"transparent": {
"anyOf": [
{
"const": false
},
{
"type": "string",
"pattern": "\\{\\{\\s*[A-Za-z][A-Za-z0-9_]*(?:\\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\\s*\\}\\}"
}
]
}
}
}
}
Visual
One canvas element, discriminated by type (IMAGE | VIDEO | GIF | SVG | TEXT, case-insensitive).
Required properties: type. Exactly one of the listed alternatives must match.
oneOf alternative 1
Schema: ImageVisual.
oneOf alternative 2
Schema: VideoVisual.
oneOf alternative 3
Schema: GifVisual.
oneOf alternative 4
Schema: SvgVisual.
oneOf alternative 5
Schema: TextVisual.
ImageVisual
A raster image placed on the canvas.
Unknown properties are rejected. Required properties: type, src.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
ImageVisual.type | string | Yes | "IMAGE" (case-insensitive). Pattern: ^[Ii][Mm][Aa][Gg][Ee]$. |
ImageVisual.x | number OR string | No | At least one listed alternative must match. |
ImageVisual.y | number OR string | No | At least one listed alternative must match. |
ImageVisual.width | number OR string | No | At least one listed alternative must match. |
ImageVisual.height | number OR string | No | At least one listed alternative must match. |
ImageVisual.position | "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom" OR string | No | At least one listed alternative must match. |
ImageVisual.anchor | "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom" OR string | No | At least one listed alternative must match. |
ImageVisual.resize | "contain" / "cover" OR string | No | At least one listed alternative must match. |
ImageVisual.enterBegin | number OR string | No | At least one listed alternative must match. |
ImageVisual.enterEnd | number OR string | No | At least one listed alternative must match. |
ImageVisual.exitBegin | number OR string | No | At least one listed alternative must match. |
ImageVisual.exitEnd | number OR string | No | At least one listed alternative must match. |
ImageVisual.opacity | number OR string | No | At least one listed alternative must match. |
ImageVisual.angle | number OR string | No | At least one listed alternative must match. |
ImageVisual.flipV | boolean OR string | No | At least one listed alternative must match. |
ImageVisual.flipH | boolean OR string | No | At least one listed alternative must match. |
ImageVisual.track | integer OR string | No | At least one listed alternative must match. |
ImageVisual.enterAnimation | "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown" OR null OR string | No | At least one listed alternative must match. |
ImageVisual.exitAnimation | "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown" OR null OR string | No | At least one listed alternative must match. |
ImageVisual.src | string OR string | Yes | At least one listed alternative must match. |
ImageVisual.cropParams | CropParams OR string | No | At least one listed alternative must match. |
ImageVisual.filter | Filter OR string | No | At least one listed alternative must match. |
ImageVisual.chromaKey | ChromaKey OR string | No | At least one listed alternative must match. |
ImageVisual.zoom | Zoom OR string | No | At least one listed alternative must match. |
ImageVisual.radius | Radius OR string | No | At least one listed alternative must match. |
ImageVisual.condition | any JSON value | No | A literal flag or placeholder. false, 0, an empty string, null or an absent resolved value prune this item. Expressions are not supported. |
Nested field: ImageVisual.x
At least one listed alternative must match.
anyOf alternative 1
Anchor-point X in canvas px (may be negative). ONLY used when position is "custom" — every other preset OVERWRITES x/y.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.y
At least one listed alternative must match.
anyOf alternative 1
Anchor-point Y in canvas px (may be negative). ONLY used when position is "custom" — every other preset OVERWRITES x/y.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.width
At least one listed alternative must match.
anyOf alternative 1
Element width in px (plan-limited).
Minimum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.height
At least one listed alternative must match.
anyOf alternative 1
Element height in px (plan-limited).
Minimum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.position
At least one listed alternative must match.
anyOf alternative 1
Placement preset. Sets BOTH the canvas point AND the default anchor (e.g. "bottom-center" puts the element's bottom edge flush with the frame bottom — no margin). x/y are IGNORED unless "custom". Two elements with the same preset render exactly stacked.
Type: "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.anchor
At least one listed alternative must match.
anyOf alternative 1
Which point of the ELEMENT sits at the position point. Defaults to the position preset itself ("custom" defaults to top-left).
Type: "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.resize
At least one listed alternative must match.
anyOf alternative 1
How media fits its frame: contain (letterbox) or cover (center-crop). With explicit width/height the media fits INTO that box (CSS object-fit); without a box it is sized against the full canvas.
Type: "contain" / "cover".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.enterBegin
At least one listed alternative must match.
anyOf alternative 1
Seconds when the element starts appearing (enter animation start).
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.enterEnd
At least one listed alternative must match.
anyOf alternative 1
Seconds when the enter animation finishes. Must be >= enterBegin.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.exitBegin
At least one listed alternative must match.
anyOf alternative 1
Seconds when the exit animation starts.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.exitEnd
At least one listed alternative must match.
anyOf alternative 1
Seconds when the element is fully gone. Must be >= exitBegin.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.opacity
At least one listed alternative must match.
anyOf alternative 1
Element opacity, 0..1.
Minimum: 0. Maximum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.angle
At least one listed alternative must match.
anyOf alternative 1
Rotation in degrees.
Minimum: -360. Maximum: 360.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.flipV
At least one listed alternative must match.
anyOf alternative 1
Flip vertically.
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.flipH
At least one listed alternative must match.
anyOf alternative 1
Flip horizontally.
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.track
At least one listed alternative must match.
anyOf alternative 1
Z-order track; higher tracks render on top.
Minimum: 0. Maximum: 1000000.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.enterAnimation
At least one listed alternative must match.
anyOf alternative 1
Enter animation effect (xfade family) or null.
At least one listed alternative must match.
anyOf alternative 1
Type: "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown".
anyOf alternative 2
Type: null.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.exitAnimation
At least one listed alternative must match.
anyOf alternative 1
Exit animation effect (xfade family) or null.
At least one listed alternative must match.
anyOf alternative 1
Type: "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown".
anyOf alternative 2
Type: null.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.src
At least one listed alternative must match.
anyOf alternative 1
Source media URL. Must be a PUBLIC http(s) URL: no credentials, no spaces/backslashes, port 80/443 only, no localhost/.local, no private IPs.
Minimum length: 1. Maximum length: 2048. Pattern: ^https?://.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.cropParams
At least one listed alternative must match.
anyOf alternative 1
Schema: CropParams.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.filter
At least one listed alternative must match.
anyOf alternative 1
Schema: Filter.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.chromaKey
At least one listed alternative must match.
anyOf alternative 1
Schema: ChromaKey.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.zoom
At least one listed alternative must match.
anyOf alternative 1
Schema: Zoom.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ImageVisual.radius
At least one listed alternative must match.
anyOf alternative 1
Schema: Radius.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
CropParams
Source crop rectangle in source-media pixels.
Unknown properties are rejected. Required properties: x, y, width, height.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
CropParams.x | number OR string | Yes | At least one listed alternative must match. |
CropParams.y | number OR string | Yes | At least one listed alternative must match. |
CropParams.width | number OR string | Yes | At least one listed alternative must match. |
CropParams.height | number OR string | Yes | At least one listed alternative must match. |
Nested field: CropParams.x
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: CropParams.y
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: CropParams.width
At least one listed alternative must match.
anyOf alternative 1
Minimum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: CropParams.height
At least one listed alternative must match.
anyOf alternative 1
Minimum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Filter
CSS-like color filters.
Unknown properties are rejected.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Filter.brightness | number OR string | No | At least one listed alternative must match. |
Filter.contrast | number OR string | No | At least one listed alternative must match. |
Filter.saturate | number OR string | No | At least one listed alternative must match. |
Filter.hue-rotate | string OR string | No | At least one listed alternative must match. |
Filter.blur | number OR string OR string | No | At least one listed alternative must match. |
Filter.invert | boolean OR number OR string | No | At least one listed alternative must match. |
Filter.colorTint | string OR string | No | At least one listed alternative must match. |
Nested field: Filter.brightness
At least one listed alternative must match.
anyOf alternative 1
Minimum: -100. Maximum: 100.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Filter.contrast
At least one listed alternative must match.
anyOf alternative 1
Minimum: -100. Maximum: 100.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Filter.saturate
At least one listed alternative must match.
anyOf alternative 1
Minimum: -100. Maximum: 100.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Filter.hue-rotate
At least one listed alternative must match.
anyOf alternative 1
Degrees, preferably with a "deg" suffix (e.g. "90deg"). Legacy numeric strings such as "90" remain accepted.
Pattern: ^-?(?:\d+(?:\.\d+)?|\.\d+)(?:deg)?$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Filter.blur
At least one listed alternative must match.
anyOf alternative 1
Unitless 0..100 amount. Numeric strings remain accepted for backward compatibility; CSS lengths such as 4px are not supported.
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0. Maximum: 100.
Type: number.
anyOf alternative 2
Pattern: ^(?:0*(?:100(?:\.0+)?|\d{1,2}(?:\.\d+)?|\.\d+))$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Filter.invert
At least one listed alternative must match.
anyOf alternative 1
Boolean or partial inversion amount from 0 to 1.
At least one listed alternative must match.
anyOf alternative 1
Type: boolean.
anyOf alternative 2
Minimum: 0. Maximum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Filter.colorTint
At least one listed alternative must match.
anyOf alternative 1
Tint color (#rgb or #rrggbb).
Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
ChromaKey
Green-screen keying.
Unknown properties are rejected. Required properties: color.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
ChromaKey.color | string OR string | Yes | At least one listed alternative must match. |
ChromaKey.similarity | number OR string | No | At least one listed alternative must match. |
ChromaKey.blend | number OR string | No | At least one listed alternative must match. |
Nested field: ChromaKey.color
At least one listed alternative must match.
anyOf alternative 1
Key color to remove (required).
Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ChromaKey.similarity
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0. Maximum: 100.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: ChromaKey.blend
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0. Maximum: 100.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Zoom
Ken Burns zoom: true (default 1.2x depth) or { "depth": 1..10 }.
At least one listed alternative must match.
anyOf alternative 1
Type: boolean.
anyOf alternative 2
Unknown properties are rejected.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Zoom.depth | number OR string | No | At least one listed alternative must match. |
Nested field: Zoom.depth
At least one listed alternative must match.
anyOf alternative 1
Minimum: 1. Maximum: 10.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Radius
Rounded-corner radii in px (tl/tr/bl/br).
Unknown properties are rejected.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Radius.tl | number OR string | No | At least one listed alternative must match. |
Radius.tr | number OR string | No | At least one listed alternative must match. |
Radius.bl | number OR string | No | At least one listed alternative must match. |
Radius.br | number OR string | No | At least one listed alternative must match. |
Nested field: Radius.tl
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Radius.tr
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Radius.bl
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Radius.br
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
VideoVisual
A video clip placed on the canvas (video projects only).
Unknown properties are rejected. Required properties: type, src.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
VideoVisual.type | string | Yes | "VIDEO" (case-insensitive). Pattern: ^[Vv][Ii][Dd][Ee][Oo]$. |
VideoVisual.x | number OR string | No | At least one listed alternative must match. |
VideoVisual.y | number OR string | No | At least one listed alternative must match. |
VideoVisual.width | number OR string | No | At least one listed alternative must match. |
VideoVisual.height | number OR string | No | At least one listed alternative must match. |
VideoVisual.position | "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom" OR string | No | At least one listed alternative must match. |
VideoVisual.anchor | "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom" OR string | No | At least one listed alternative must match. |
VideoVisual.resize | "contain" / "cover" OR string | No | At least one listed alternative must match. |
VideoVisual.enterBegin | number OR string | No | At least one listed alternative must match. |
VideoVisual.enterEnd | number OR string | No | At least one listed alternative must match. |
VideoVisual.exitBegin | number OR string | No | At least one listed alternative must match. |
VideoVisual.exitEnd | number OR string | No | At least one listed alternative must match. |
VideoVisual.opacity | number OR string | No | At least one listed alternative must match. |
VideoVisual.angle | number OR string | No | At least one listed alternative must match. |
VideoVisual.flipV | boolean OR string | No | At least one listed alternative must match. |
VideoVisual.flipH | boolean OR string | No | At least one listed alternative must match. |
VideoVisual.track | integer OR string | No | At least one listed alternative must match. |
VideoVisual.enterAnimation | "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown" OR null OR string | No | At least one listed alternative must match. |
VideoVisual.exitAnimation | "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown" OR null OR string | No | At least one listed alternative must match. |
VideoVisual.src | string OR string | Yes | At least one listed alternative must match. |
VideoVisual.cropParams | CropParams OR string | No | At least one listed alternative must match. |
VideoVisual.filter | Filter OR string | No | At least one listed alternative must match. |
VideoVisual.chromaKey | ChromaKey OR string | No | At least one listed alternative must match. |
VideoVisual.zoom | Zoom OR string | No | At least one listed alternative must match. |
VideoVisual.radius | Radius OR string | No | At least one listed alternative must match. |
VideoVisual.videoBegin | number OR string | No | At least one listed alternative must match. |
VideoVisual.videoEnd | number OR string | No | At least one listed alternative must match. |
VideoVisual.videoDuration | number OR string | No | At least one listed alternative must match. |
VideoVisual.volume | number OR string | No | At least one listed alternative must match. |
VideoVisual.speed | number OR string | No | At least one listed alternative must match. |
VideoVisual.transition | "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown" OR null OR string | No | At least one listed alternative must match. |
VideoVisual.transitionDuration | number OR string | No | At least one listed alternative must match. |
VideoVisual.transitionId | string OR string | No | At least one listed alternative must match. |
VideoVisual.frameRate | integer OR string | No | At least one listed alternative must match. |
VideoVisual.id | string OR string | No | At least one listed alternative must match. |
VideoVisual.hasAudio | boolean OR string | No | At least one listed alternative must match. |
VideoVisual.condition | any JSON value | No | A literal flag or placeholder. false, 0, an empty string, null or an absent resolved value prune this item. Expressions are not supported. |
Nested field: VideoVisual.x
At least one listed alternative must match.
anyOf alternative 1
Anchor-point X in canvas px (may be negative). ONLY used when position is "custom" — every other preset OVERWRITES x/y.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.y
At least one listed alternative must match.
anyOf alternative 1
Anchor-point Y in canvas px (may be negative). ONLY used when position is "custom" — every other preset OVERWRITES x/y.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.width
At least one listed alternative must match.
anyOf alternative 1
Element width in px (plan-limited).
Minimum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.height
At least one listed alternative must match.
anyOf alternative 1
Element height in px (plan-limited).
Minimum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.position
At least one listed alternative must match.
anyOf alternative 1
Placement preset. Sets BOTH the canvas point AND the default anchor (e.g. "bottom-center" puts the element's bottom edge flush with the frame bottom — no margin). x/y are IGNORED unless "custom". Two elements with the same preset render exactly stacked.
Type: "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.anchor
At least one listed alternative must match.
anyOf alternative 1
Which point of the ELEMENT sits at the position point. Defaults to the position preset itself ("custom" defaults to top-left).
Type: "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.resize
At least one listed alternative must match.
anyOf alternative 1
How media fits its frame: contain (letterbox) or cover (center-crop). With explicit width/height the media fits INTO that box (CSS object-fit); without a box it is sized against the full canvas.
Type: "contain" / "cover".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.enterBegin
At least one listed alternative must match.
anyOf alternative 1
Seconds when the element starts appearing (enter animation start).
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.enterEnd
At least one listed alternative must match.
anyOf alternative 1
Seconds when the enter animation finishes. Must be >= enterBegin.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.exitBegin
At least one listed alternative must match.
anyOf alternative 1
Seconds when the exit animation starts.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.exitEnd
At least one listed alternative must match.
anyOf alternative 1
Seconds when the element is fully gone. Must be >= exitBegin.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.opacity
At least one listed alternative must match.
anyOf alternative 1
Element opacity, 0..1.
Minimum: 0. Maximum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.angle
At least one listed alternative must match.
anyOf alternative 1
Rotation in degrees.
Minimum: -360. Maximum: 360.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.flipV
At least one listed alternative must match.
anyOf alternative 1
Flip vertically.
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.flipH
At least one listed alternative must match.
anyOf alternative 1
Flip horizontally.
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.track
At least one listed alternative must match.
anyOf alternative 1
Z-order track; higher tracks render on top.
Minimum: 0. Maximum: 1000000.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.enterAnimation
At least one listed alternative must match.
anyOf alternative 1
Enter animation effect (xfade family) or null.
At least one listed alternative must match.
anyOf alternative 1
Type: "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown".
anyOf alternative 2
Type: null.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.exitAnimation
At least one listed alternative must match.
anyOf alternative 1
Exit animation effect (xfade family) or null.
At least one listed alternative must match.
anyOf alternative 1
Type: "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown".
anyOf alternative 2
Type: null.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.src
At least one listed alternative must match.
anyOf alternative 1
Source media URL. Must be a PUBLIC http(s) URL: no credentials, no spaces/backslashes, port 80/443 only, no localhost/.local, no private IPs.
Minimum length: 1. Maximum length: 2048. Pattern: ^https?://.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.cropParams
At least one listed alternative must match.
anyOf alternative 1
Schema: CropParams.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.filter
At least one listed alternative must match.
anyOf alternative 1
Schema: Filter.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.chromaKey
At least one listed alternative must match.
anyOf alternative 1
Schema: ChromaKey.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.zoom
At least one listed alternative must match.
anyOf alternative 1
Schema: Zoom.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.radius
At least one listed alternative must match.
anyOf alternative 1
Schema: Radius.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.videoBegin
At least one listed alternative must match.
anyOf alternative 1
Trim: source time (s) where playback starts.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.videoEnd
At least one listed alternative must match.
anyOf alternative 1
Trim: source time (s) where playback ends.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.videoDuration
At least one listed alternative must match.
anyOf alternative 1
Play only this many seconds of the source.
Minimum: 0.1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.volume
At least one listed alternative must match.
anyOf alternative 1
Clip audio volume, 0..2 (1 = original level).
Minimum: 0. Maximum: 2.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.speed
At least one listed alternative must match.
anyOf alternative 1
Playback speed multiplier, 0.1..10.
Minimum: 0.1. Maximum: 10.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.transition
At least one listed alternative must match.
anyOf alternative 1
Transition into the linked clip (see transitionId).
At least one listed alternative must match.
anyOf alternative 1
Type: "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown".
anyOf alternative 2
Type: null.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.transitionDuration
At least one listed alternative must match.
anyOf alternative 1
Transition length in seconds.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.transitionId
At least one listed alternative must match.
anyOf alternative 1
id of the clip this transition links to.
Maximum length: 100. Pattern: ^[a-zA-Z0-9_-]+$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.frameRate
At least one listed alternative must match.
anyOf alternative 1
Override source frame rate (1..60).
Minimum: 1. Maximum: 60.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.id
At least one listed alternative must match.
anyOf alternative 1
Clip id (referenced by transitionId).
Pattern: ^[a-zA-Z0-9_-]+$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: VideoVisual.hasAudio
At least one listed alternative must match.
anyOf alternative 1
Hint that the source has an audio stream.
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
GifVisual
An animated GIF placed on the canvas (video projects only).
Unknown properties are rejected. Required properties: type, src.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
GifVisual.type | string | Yes | "GIF" (case-insensitive). Pattern: ^[Gg][Ii][Ff]$. |
GifVisual.x | number OR string | No | At least one listed alternative must match. |
GifVisual.y | number OR string | No | At least one listed alternative must match. |
GifVisual.width | number OR string | No | At least one listed alternative must match. |
GifVisual.height | number OR string | No | At least one listed alternative must match. |
GifVisual.position | "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom" OR string | No | At least one listed alternative must match. |
GifVisual.anchor | "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom" OR string | No | At least one listed alternative must match. |
GifVisual.resize | "contain" / "cover" OR string | No | At least one listed alternative must match. |
GifVisual.enterBegin | number OR string | No | At least one listed alternative must match. |
GifVisual.enterEnd | number OR string | No | At least one listed alternative must match. |
GifVisual.exitBegin | number OR string | No | At least one listed alternative must match. |
GifVisual.exitEnd | number OR string | No | At least one listed alternative must match. |
GifVisual.opacity | number OR string | No | At least one listed alternative must match. |
GifVisual.angle | number OR string | No | At least one listed alternative must match. |
GifVisual.flipV | boolean OR string | No | At least one listed alternative must match. |
GifVisual.flipH | boolean OR string | No | At least one listed alternative must match. |
GifVisual.track | integer OR string | No | At least one listed alternative must match. |
GifVisual.enterAnimation | "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown" OR null OR string | No | At least one listed alternative must match. |
GifVisual.exitAnimation | "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown" OR null OR string | No | At least one listed alternative must match. |
GifVisual.src | string OR string | Yes | At least one listed alternative must match. |
GifVisual.cropParams | CropParams OR string | No | At least one listed alternative must match. |
GifVisual.filter | Filter OR string | No | At least one listed alternative must match. |
GifVisual.chromaKey | ChromaKey OR string | No | At least one listed alternative must match. |
GifVisual.zoom | Zoom OR string | No | At least one listed alternative must match. |
GifVisual.radius | Radius OR string | No | At least one listed alternative must match. |
GifVisual.condition | any JSON value | No | A literal flag or placeholder. false, 0, an empty string, null or an absent resolved value prune this item. Expressions are not supported. |
Nested field: GifVisual.x
At least one listed alternative must match.
anyOf alternative 1
Anchor-point X in canvas px (may be negative). ONLY used when position is "custom" — every other preset OVERWRITES x/y.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.y
At least one listed alternative must match.
anyOf alternative 1
Anchor-point Y in canvas px (may be negative). ONLY used when position is "custom" — every other preset OVERWRITES x/y.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.width
At least one listed alternative must match.
anyOf alternative 1
Element width in px (plan-limited).
Minimum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.height
At least one listed alternative must match.
anyOf alternative 1
Element height in px (plan-limited).
Minimum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.position
At least one listed alternative must match.
anyOf alternative 1
Placement preset. Sets BOTH the canvas point AND the default anchor (e.g. "bottom-center" puts the element's bottom edge flush with the frame bottom — no margin). x/y are IGNORED unless "custom". Two elements with the same preset render exactly stacked.
Type: "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.anchor
At least one listed alternative must match.
anyOf alternative 1
Which point of the ELEMENT sits at the position point. Defaults to the position preset itself ("custom" defaults to top-left).
Type: "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.resize
At least one listed alternative must match.
anyOf alternative 1
How media fits its frame: contain (letterbox) or cover (center-crop). With explicit width/height the media fits INTO that box (CSS object-fit); without a box it is sized against the full canvas.
Type: "contain" / "cover".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.enterBegin
At least one listed alternative must match.
anyOf alternative 1
Seconds when the element starts appearing (enter animation start).
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.enterEnd
At least one listed alternative must match.
anyOf alternative 1
Seconds when the enter animation finishes. Must be >= enterBegin.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.exitBegin
At least one listed alternative must match.
anyOf alternative 1
Seconds when the exit animation starts.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.exitEnd
At least one listed alternative must match.
anyOf alternative 1
Seconds when the element is fully gone. Must be >= exitBegin.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.opacity
At least one listed alternative must match.
anyOf alternative 1
Element opacity, 0..1.
Minimum: 0. Maximum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.angle
At least one listed alternative must match.
anyOf alternative 1
Rotation in degrees.
Minimum: -360. Maximum: 360.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.flipV
At least one listed alternative must match.
anyOf alternative 1
Flip vertically.
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.flipH
At least one listed alternative must match.
anyOf alternative 1
Flip horizontally.
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.track
At least one listed alternative must match.
anyOf alternative 1
Z-order track; higher tracks render on top.
Minimum: 0. Maximum: 1000000.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.enterAnimation
At least one listed alternative must match.
anyOf alternative 1
Enter animation effect (xfade family) or null.
At least one listed alternative must match.
anyOf alternative 1
Type: "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown".
anyOf alternative 2
Type: null.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.exitAnimation
At least one listed alternative must match.
anyOf alternative 1
Exit animation effect (xfade family) or null.
At least one listed alternative must match.
anyOf alternative 1
Type: "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown".
anyOf alternative 2
Type: null.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.src
At least one listed alternative must match.
anyOf alternative 1
Source media URL. Must be a PUBLIC http(s) URL: no credentials, no spaces/backslashes, port 80/443 only, no localhost/.local, no private IPs.
Minimum length: 1. Maximum length: 2048. Pattern: ^https?://.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.cropParams
At least one listed alternative must match.
anyOf alternative 1
Schema: CropParams.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.filter
At least one listed alternative must match.
anyOf alternative 1
Schema: Filter.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.chromaKey
At least one listed alternative must match.
anyOf alternative 1
Schema: ChromaKey.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.zoom
At least one listed alternative must match.
anyOf alternative 1
Schema: Zoom.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: GifVisual.radius
At least one listed alternative must match.
anyOf alternative 1
Schema: Radius.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
SvgVisual
Inline SVG markup drawn on the canvas.
Unknown properties are rejected. Required properties: type, svg.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
SvgVisual.type | string | Yes | "SVG" (case-insensitive). Pattern: ^[Ss][Vv][Gg]$. |
SvgVisual.x | number OR string | No | At least one listed alternative must match. |
SvgVisual.y | number OR string | No | At least one listed alternative must match. |
SvgVisual.width | number OR string | No | At least one listed alternative must match. |
SvgVisual.height | number OR string | No | At least one listed alternative must match. |
SvgVisual.position | "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom" OR string | No | At least one listed alternative must match. |
SvgVisual.anchor | "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom" OR string | No | At least one listed alternative must match. |
SvgVisual.resize | "contain" / "cover" OR string | No | At least one listed alternative must match. |
SvgVisual.enterBegin | number OR string | No | At least one listed alternative must match. |
SvgVisual.enterEnd | number OR string | No | At least one listed alternative must match. |
SvgVisual.exitBegin | number OR string | No | At least one listed alternative must match. |
SvgVisual.exitEnd | number OR string | No | At least one listed alternative must match. |
SvgVisual.opacity | number OR string | No | At least one listed alternative must match. |
SvgVisual.angle | number OR string | No | At least one listed alternative must match. |
SvgVisual.flipV | boolean OR string | No | At least one listed alternative must match. |
SvgVisual.flipH | boolean OR string | No | At least one listed alternative must match. |
SvgVisual.track | integer OR string | No | At least one listed alternative must match. |
SvgVisual.enterAnimation | "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown" OR null OR string | No | At least one listed alternative must match. |
SvgVisual.exitAnimation | "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown" OR null OR string | No | At least one listed alternative must match. |
SvgVisual.svg | string OR string | Yes | At least one listed alternative must match. |
SvgVisual.filter | Filter OR string | No | At least one listed alternative must match. |
SvgVisual.chromaKey | ChromaKey OR string | No | At least one listed alternative must match. |
SvgVisual.customCode | CustomCode OR string | No | At least one listed alternative must match. |
SvgVisual.designer | Designer OR string | No | At least one listed alternative must match. |
SvgVisual.condition | any JSON value | No | A literal flag or placeholder. false, 0, an empty string, null or an absent resolved value prune this item. Expressions are not supported. |
Nested field: SvgVisual.x
At least one listed alternative must match.
anyOf alternative 1
Anchor-point X in canvas px (may be negative). ONLY used when position is "custom" — every other preset OVERWRITES x/y.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.y
At least one listed alternative must match.
anyOf alternative 1
Anchor-point Y in canvas px (may be negative). ONLY used when position is "custom" — every other preset OVERWRITES x/y.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.width
At least one listed alternative must match.
anyOf alternative 1
Element width in px (plan-limited).
Minimum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.height
At least one listed alternative must match.
anyOf alternative 1
Element height in px (plan-limited).
Minimum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.position
At least one listed alternative must match.
anyOf alternative 1
Placement preset. Sets BOTH the canvas point AND the default anchor (e.g. "bottom-center" puts the element's bottom edge flush with the frame bottom — no margin). x/y are IGNORED unless "custom". Two elements with the same preset render exactly stacked.
Type: "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.anchor
At least one listed alternative must match.
anyOf alternative 1
Which point of the ELEMENT sits at the position point. Defaults to the position preset itself ("custom" defaults to top-left).
Type: "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.resize
At least one listed alternative must match.
anyOf alternative 1
How media fits its frame: contain (letterbox) or cover (center-crop). With explicit width/height the media fits INTO that box (CSS object-fit); without a box it is sized against the full canvas.
Type: "contain" / "cover".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.enterBegin
At least one listed alternative must match.
anyOf alternative 1
Seconds when the element starts appearing (enter animation start).
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.enterEnd
At least one listed alternative must match.
anyOf alternative 1
Seconds when the enter animation finishes. Must be >= enterBegin.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.exitBegin
At least one listed alternative must match.
anyOf alternative 1
Seconds when the exit animation starts.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.exitEnd
At least one listed alternative must match.
anyOf alternative 1
Seconds when the element is fully gone. Must be >= exitBegin.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.opacity
At least one listed alternative must match.
anyOf alternative 1
Element opacity, 0..1.
Minimum: 0. Maximum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.angle
At least one listed alternative must match.
anyOf alternative 1
Rotation in degrees.
Minimum: -360. Maximum: 360.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.flipV
At least one listed alternative must match.
anyOf alternative 1
Flip vertically.
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.flipH
At least one listed alternative must match.
anyOf alternative 1
Flip horizontally.
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.track
At least one listed alternative must match.
anyOf alternative 1
Z-order track; higher tracks render on top.
Minimum: 0. Maximum: 1000000.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.enterAnimation
At least one listed alternative must match.
anyOf alternative 1
Enter animation effect (xfade family) or null.
At least one listed alternative must match.
anyOf alternative 1
Type: "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown".
anyOf alternative 2
Type: null.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.exitAnimation
At least one listed alternative must match.
anyOf alternative 1
Exit animation effect (xfade family) or null.
At least one listed alternative must match.
anyOf alternative 1
Type: "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown".
anyOf alternative 2
Type: null.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.svg
At least one listed alternative must match.
anyOf alternative 1
Inline SVG markup starting with "<svg". Sanitized: no <script>/<foreignObject>/<iframe>/<object>/<embed>/<audio>/<video>, no on* event attributes, no external url()/href/src (only "#id" fragment refs), dimensions <= 4096px, no integers with 8+ digits.
Minimum length: 1. Maximum length: 200000.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.filter
At least one listed alternative must match.
anyOf alternative 1
Schema: Filter.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.chromaKey
At least one listed alternative must match.
anyOf alternative 1
Schema: ChromaKey.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.customCode
At least one listed alternative must match.
anyOf alternative 1
Schema: CustomCode.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: SvgVisual.designer
At least one listed alternative must match.
anyOf alternative 1
Schema: Designer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
CustomCode
Sandboxed styling/animation code run inside the render browser (Design Studio). No network/filesystem/storage/navigation APIs — see validation notes.
Unknown properties are rejected.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
CustomCode.css | string OR string | No | At least one listed alternative must match. |
CustomCode.js | string OR string | No | At least one listed alternative must match. |
CustomCode.animationDuration | number OR string | No | At least one listed alternative must match. |
Nested field: CustomCode.css
At least one listed alternative must match.
anyOf alternative 1
Maximum length: 200000.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: CustomCode.js
At least one listed alternative must match.
anyOf alternative 1
Maximum length: 200000.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: CustomCode.animationDuration
At least one listed alternative must match.
anyOf alternative 1
Seconds the customCode animation runs (max 15).
Maximum: 15. Greater than: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Designer
Opaque Design Studio round-trip metadata (max 200k chars serialized). Never rendered; keeps 'edit design' working.
Type: object.
TextVisual
Styled text. Provide plain text (no < or > characters) and/or limited html. At least one of text/html must be non-empty.
Unknown properties are rejected. Required properties: type. At least one listed alternative must match.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
TextVisual.type | string | Yes | "TEXT" (case-insensitive). Pattern: ^[Tt][Ee][Xx][Tt]$. |
TextVisual.x | number OR string | No | At least one listed alternative must match. |
TextVisual.y | number OR string | No | At least one listed alternative must match. |
TextVisual.width | number OR string | No | At least one listed alternative must match. |
TextVisual.height | number OR string | No | At least one listed alternative must match. |
TextVisual.position | "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom" OR string | No | At least one listed alternative must match. |
TextVisual.anchor | "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom" OR string | No | At least one listed alternative must match. |
TextVisual.resize | "contain" / "cover" OR string | No | At least one listed alternative must match. |
TextVisual.enterBegin | number OR string | No | At least one listed alternative must match. |
TextVisual.enterEnd | number OR string | No | At least one listed alternative must match. |
TextVisual.exitBegin | number OR string | No | At least one listed alternative must match. |
TextVisual.exitEnd | number OR string | No | At least one listed alternative must match. |
TextVisual.opacity | number OR string | No | At least one listed alternative must match. |
TextVisual.angle | number OR string | No | At least one listed alternative must match. |
TextVisual.flipV | boolean OR string | No | At least one listed alternative must match. |
TextVisual.flipH | boolean OR string | No | At least one listed alternative must match. |
TextVisual.track | integer OR string | No | At least one listed alternative must match. |
TextVisual.enterAnimation | "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown" OR null OR string | No | At least one listed alternative must match. |
TextVisual.exitAnimation | "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown" OR null OR string | No | At least one listed alternative must match. |
TextVisual.text | string OR string | No | At least one listed alternative must match. |
TextVisual.html | string OR string | No | At least one listed alternative must match. |
TextVisual.style | object OR string | No | At least one listed alternative must match. |
TextVisual.fitToBox | boolean OR string | No | At least one listed alternative must match. |
TextVisual.customCode | CustomCode OR string | No | At least one listed alternative must match. |
TextVisual.designer | Designer OR string | No | At least one listed alternative must match. |
TextVisual.condition | any JSON value | No | A literal flag or placeholder. false, 0, an empty string, null or an absent resolved value prune this item. Expressions are not supported. |
Nested field: TextVisual.x
At least one listed alternative must match.
anyOf alternative 1
Anchor-point X in canvas px (may be negative). ONLY used when position is "custom" — every other preset OVERWRITES x/y.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.y
At least one listed alternative must match.
anyOf alternative 1
Anchor-point Y in canvas px (may be negative). ONLY used when position is "custom" — every other preset OVERWRITES x/y.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.width
At least one listed alternative must match.
anyOf alternative 1
Element width in px (plan-limited).
Minimum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.height
At least one listed alternative must match.
anyOf alternative 1
Element height in px (plan-limited).
Minimum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.position
At least one listed alternative must match.
anyOf alternative 1
Placement preset. Sets BOTH the canvas point AND the default anchor (e.g. "bottom-center" puts the element's bottom edge flush with the frame bottom — no margin). x/y are IGNORED unless "custom". Two elements with the same preset render exactly stacked.
Type: "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.anchor
At least one listed alternative must match.
anyOf alternative 1
Which point of the ELEMENT sits at the position point. Defaults to the position preset itself ("custom" defaults to top-left).
Type: "top-left" / "top-center" / "top-right" / "center-left" / "center-center" / "center-right" / "bottom-right" / "bottom-center" / "bottom-left" / "custom".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.resize
At least one listed alternative must match.
anyOf alternative 1
How media fits its frame: contain (letterbox) or cover (center-crop). With explicit width/height the media fits INTO that box (CSS object-fit); without a box it is sized against the full canvas.
Type: "contain" / "cover".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.enterBegin
At least one listed alternative must match.
anyOf alternative 1
Seconds when the element starts appearing (enter animation start).
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.enterEnd
At least one listed alternative must match.
anyOf alternative 1
Seconds when the enter animation finishes. Must be >= enterBegin.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.exitBegin
At least one listed alternative must match.
anyOf alternative 1
Seconds when the exit animation starts.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.exitEnd
At least one listed alternative must match.
anyOf alternative 1
Seconds when the element is fully gone. Must be >= exitBegin.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.opacity
At least one listed alternative must match.
anyOf alternative 1
Element opacity, 0..1.
Minimum: 0. Maximum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.angle
At least one listed alternative must match.
anyOf alternative 1
Rotation in degrees.
Minimum: -360. Maximum: 360.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.flipV
At least one listed alternative must match.
anyOf alternative 1
Flip vertically.
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.flipH
At least one listed alternative must match.
anyOf alternative 1
Flip horizontally.
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.track
At least one listed alternative must match.
anyOf alternative 1
Z-order track; higher tracks render on top.
Minimum: 0. Maximum: 1000000.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.enterAnimation
At least one listed alternative must match.
anyOf alternative 1
Enter animation effect (xfade family) or null.
At least one listed alternative must match.
anyOf alternative 1
Type: "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown".
anyOf alternative 2
Type: null.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.exitAnimation
At least one listed alternative must match.
anyOf alternative 1
Exit animation effect (xfade family) or null.
At least one listed alternative must match.
anyOf alternative 1
Type: "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown".
anyOf alternative 2
Type: null.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.text
At least one listed alternative must match.
anyOf alternative 1
Plain text content. HTML markup (< or >) is rejected — use html for markup.
Maximum length: 20000.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.html
At least one listed alternative must match.
anyOf alternative 1
Limited HTML. Allowed tags: b, strong, i, em, u, s, br, span, div, p, ul, ol, li, img, canvas, svg (+ svg geometry). Allowed attributes: style, class, src, alt, width, height. No <script>/<style>, no event handlers, no external CSS url().
Maximum length: 200000.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.style
At least one listed alternative must match.
anyOf alternative 1
CSS style object applied to the text container (camelCase or kebab-case keys, and --custom-properties). LAYOUT MODEL: the container uses box-sizing: content-box, so padding/border render OUTSIDE the declared width/height and overflow gets cut — for cards/pills set the full size via width/height and center content with display:flex + alignItems:center + justifyContent:center instead of padding. Text sits at the TOP of the box unless flex-centered. Values must not contain url(), @import, expression(), comments or other dangerous tokens. Max value length 4000 chars.
Maximum properties: 120.
Type: object.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.fitToBox
At least one listed alternative must match.
anyOf alternative 1
Scale the typography down just enough that the painted text stays inside the declared width/height instead of being clipped at the element's edge. No effect when the content already fits, so an unchanged template renders identically.
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.customCode
At least one listed alternative must match.
anyOf alternative 1
Schema: CustomCode.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: TextVisual.designer
At least one listed alternative must match.
anyOf alternative 1
Schema: Designer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
anyOf alternative 1
Required properties: text.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
TextVisual.text | string OR string | Yes | At least one listed alternative must match. |
Nested field: TextVisual.text
At least one listed alternative must match.
anyOf alternative 1
Pattern: \S.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
anyOf alternative 2
Required properties: html.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
TextVisual.html | string OR string | Yes | At least one listed alternative must match. |
Nested field: TextVisual.html
At least one listed alternative must match.
anyOf alternative 1
Pattern: \S.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
anyOf alternative 3
Required properties: condition.
Type: any JSON value.
AudioItem
A soundtrack / voice-over entry for audios (video projects only).
Unknown properties are rejected.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
AudioItem.src | string OR string | No | At least one listed alternative must match. |
AudioItem.matchDuration | boolean OR string | No | At least one listed alternative must match. |
AudioItem.enter | number OR string | No | At least one listed alternative must match. |
AudioItem.exit | number OR string | No | At least one listed alternative must match. |
AudioItem.volume | number OR string | No | At least one listed alternative must match. |
AudioItem.speed | number OR string | No | At least one listed alternative must match. |
AudioItem.audioBegin | number OR string | No | At least one listed alternative must match. |
AudioItem.audioEnd | number OR string | No | At least one listed alternative must match. |
AudioItem.audioDuration | number OR string | No | At least one listed alternative must match. |
AudioItem.track | integer OR string | No | At least one listed alternative must match. |
AudioItem.condition | any JSON value | No | A literal flag or placeholder. false, 0, an empty string, null or an absent resolved value prune this item. Expressions are not supported. |
Nested field: AudioItem.src
At least one listed alternative must match.
anyOf alternative 1
Audio file URL (mp3/wav/...). Must be a PUBLIC http(s) URL: no credentials, no spaces/backslashes, port 80/443 only, no localhost/.local, no private IPs.
Minimum length: 1. Maximum length: 2048. Pattern: ^https?://.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: AudioItem.matchDuration
At least one listed alternative must match.
anyOf alternative 1
Follow the containing scene/project length without extending automatic duration. Overrides exit.
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: AudioItem.enter
At least one listed alternative must match.
anyOf alternative 1
Timeline second the audio starts playing.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: AudioItem.exit
At least one listed alternative must match.
anyOf alternative 1
Timeline second the audio stops. Must be >= enter.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: AudioItem.volume
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0. Maximum: 2.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: AudioItem.speed
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0.1. Maximum: 10.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: AudioItem.audioBegin
At least one listed alternative must match.
anyOf alternative 1
Trim: source second where playback starts.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: AudioItem.audioEnd
At least one listed alternative must match.
anyOf alternative 1
Trim: source second where playback ends. Must be >= audioBegin.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: AudioItem.audioDuration
At least one listed alternative must match.
anyOf alternative 1
Play only this many seconds of the source.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: AudioItem.track
At least one listed alternative must match.
anyOf alternative 1
Mix track index; audio tracks mix together.
Minimum: 0. Maximum: 1000000.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Scene
A timeline segment. Scenes play sequentially; a scene's transition blends into the NEXT scene (xfade overlap is subtracted from the total duration).
Unknown properties are rejected.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Scene.id | string OR string | No | At least one listed alternative must match. |
Scene.duration | -1 OR number OR string | No | At least one listed alternative must match. |
Scene.transition | "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown" OR null OR string | No | At least one listed alternative must match. |
Scene.transitionId | string OR null OR string | No | At least one listed alternative must match. |
Scene.transitionDuration | number OR string | No | At least one listed alternative must match. |
Scene.backgroundColor | string OR string | No | At least one listed alternative must match. |
Scene.visuals | array of Visual OR string | No | At least one listed alternative must match. |
Scene.audios | array of AudioItem OR string | No | At least one listed alternative must match. |
Scene.variables | object | No | Default variable values; request variables override these. Scene defaults shadow project values inside that scene. |
Scene.iterate | string | No | Name or dotted path of an array variable; one scene is generated per item. |
Scene.iterateAs | string | No | Default: "item". Pattern: ^[A-Za-z][A-Za-z0-9_]*$. |
Scene.condition | any JSON value | No | A literal flag or placeholder. false, 0, an empty string, null or an absent resolved value prune this item. Expressions are not supported. |
Nested field: Scene.id
At least one listed alternative must match.
anyOf alternative 1
Optional scene ID. Explicit IDs must be unique within the project.
Maximum length: 100. Pattern: ^[a-zA-Z0-9_-]+$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Scene.duration
At least one listed alternative must match.
anyOf alternative 1
Seconds; -1 (or omitted) auto-computes from the scene's content.
At least one listed alternative must match.
anyOf alternative 1
Type: -1.
anyOf alternative 2
Minimum: 0.1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Scene.transition
At least one listed alternative must match.
anyOf alternative 1
Transition into the next scene.
At least one listed alternative must match.
anyOf alternative 1
Type: "fade" / "fadeblack" / "fadewhite" / "distance" / "wipeleft" / "wiperight" / "wipeup" / "wipedown" / "slideleft" / "slideright" / "slideup" / "slidedown" / "smoothleft" / "smoothright" / "smoothup" / "smoothdown" / "circlecrop" / "rectcrop" / "circleclose" / "circleopen" / "horzclose" / "horzopen" / "vertclose" / "vertopen" / "diagbl" / "diagbr" / "diagtl" / "diagtr" / "hlslice" / "hrslice" / "vuslice" / "vdslice" / "dissolve" / "pixelize" / "radial" / "hblur" / "wipetl" / "wipetr" / "wipebl" / "wipebr" / "fadegrays" / "zoomin" / "hlwind" / "hrwind" / "squeezeh" / "squeezev" / "fadefast" / "fadeslow" / "vuwind" / "vdwind" / "coverleft" / "coverright" / "coverup" / "coverdown" / "revealleft" / "revealright" / "revealup" / "revealdown".
anyOf alternative 2
Type: null.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Scene.transitionId
At least one listed alternative must match.
anyOf alternative 1
At least one listed alternative must match.
anyOf alternative 1
Maximum length: 100. Pattern: ^[a-zA-Z0-9_-]+$.
Type: string.
anyOf alternative 2
Type: null.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Scene.transitionDuration
At least one listed alternative must match.
anyOf alternative 1
Transition overlap in seconds (default 0.5).
Minimum: 0. Maximum: 60.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Scene.backgroundColor
At least one listed alternative must match.
anyOf alternative 1
Scene background (#rgb or #rrggbb).
Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Scene.visuals
At least one listed alternative must match.
anyOf alternative 1
Array item: Scene.visuals[]
Schema: Visual.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Scene.audios
At least one listed alternative must match.
anyOf alternative 1
Array item: Scene.audios[]
Schema: AudioItem.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Subtitle
Burned-in subtitles. Content: EXACTLY ONE of src (SRT/VTT URL) or captions. Style: v2 flat keys (animation/font/stroke/background/...) OR the legacy styles block — not both.
Unknown properties are rejected. Exactly one of the listed alternatives must match.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Subtitle.src | string OR string | No | At least one listed alternative must match. |
Subtitle.captions | array of any JSON value OR any JSON value OR string | No | At least one listed alternative must match. |
Subtitle.maxWordsPerLine | integer OR string | No | At least one listed alternative must match. |
Subtitle.animation | "normal" / "none" / "one-word" / "karaoke" / "progressive" / "highlight" / "fill" / "pop" / "bounce" / "fade" / "slide" / "typewriter" OR string | No | At least one listed alternative must match. |
Subtitle.direction | "up" / "down" / "left" / "right" OR string | No | At least one listed alternative must match. |
Subtitle.font | object OR string | No | At least one listed alternative must match. |
Subtitle.stroke | object OR string | No | At least one listed alternative must match. |
Subtitle.background | object OR string | No | At least one listed alternative must match. |
Subtitle.activeWord | object OR string | No | At least one listed alternative must match. |
Subtitle.position | "top-left" / "top-center" / "top-right" / "bottom-left" / "bottom-center" / "bottom-right" / "center-center" / "center-left" / "center-right" / "top" / "center" / "bottom" OR string | No | At least one listed alternative must match. |
Subtitle.margin | object OR string | No | At least one listed alternative must match. |
Subtitle.styles | object OR string | No | At least one listed alternative must match. |
Nested field: Subtitle.src
At least one listed alternative must match.
anyOf alternative 1
SRT or VTT file URL. Must be a PUBLIC http(s) URL: no credentials, no spaces/backslashes, port 80/443 only, no localhost/.local, no private IPs.
Minimum length: 1. Maximum length: 2048. Pattern: ^https?://.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.captions
At least one listed alternative must match.
anyOf alternative 1
Inline captions (plan-limited count).
Minimum items: 1.
Array item: Subtitle.captions[]
Unknown properties are rejected. Required properties: start, end. At least one listed alternative must match.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Subtitle.captions[].start | number OR string | Yes | At least one listed alternative must match. |
Subtitle.captions[].end | number OR string | Yes | At least one listed alternative must match. |
Subtitle.captions[].text | string OR string | No | At least one listed alternative must match. |
Subtitle.captions[].words | array of object OR string | No | At least one listed alternative must match. |
Nested field: Subtitle.captions[].start
At least one listed alternative must match.
anyOf alternative 1
Caption start time in seconds.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.captions[].end
At least one listed alternative must match.
anyOf alternative 1
Caption end time in seconds.
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.captions[].text
At least one listed alternative must match.
anyOf alternative 1
Minimum length: 1. Maximum length: 1000.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.captions[].words
At least one listed alternative must match.
anyOf alternative 1
Per-word timings; auto-distributed from text when omitted.
Minimum items: 1.
Array item: Subtitle.captions[].words[]
Unknown properties are rejected. Required properties: start, end, text.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Subtitle.captions[].words[].start | number OR string | Yes | At least one listed alternative must match. |
Subtitle.captions[].words[].end | number OR string | Yes | At least one listed alternative must match. |
Subtitle.captions[].words[].text | string OR string | Yes | At least one listed alternative must match. |
Nested field: Subtitle.captions[].words[].start
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.captions[].words[].end
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.captions[].words[].text
At least one listed alternative must match.
anyOf alternative 1
Minimum length: 1. Maximum length: 100.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
anyOf alternative 1
Required properties: text.
Type: any JSON value.
anyOf alternative 2
Required properties: words.
Type: any JSON value.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.maxWordsPerLine
At least one listed alternative must match.
anyOf alternative 1
Re-chunk captions to at most N words per line.
Minimum: 1. Maximum: 20.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.animation
At least one listed alternative must match.
anyOf alternative 1
Caption animation mode.
Type: "normal" / "none" / "one-word" / "karaoke" / "progressive" / "highlight" / "fill" / "pop" / "bounce" / "fade" / "slide" / "typewriter".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.direction
At least one listed alternative must match.
anyOf alternative 1
Slide direction when animation is "slide".
Type: "up" / "down" / "left" / "right".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.font
At least one listed alternative must match.
anyOf alternative 1
Minimum properties: 1. Unknown properties are rejected.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Subtitle.font.family | string OR string | No | At least one listed alternative must match. |
Subtitle.font.size | number OR string | No | At least one listed alternative must match. |
Subtitle.font.color | string OR string | No | At least one listed alternative must match. |
Subtitle.font.bold | boolean OR string | No | At least one listed alternative must match. |
Subtitle.font.italic | boolean OR string | No | At least one listed alternative must match. |
Subtitle.font.transform | "uppercase" / "lowercase" / "capitalize" OR string | No | At least one listed alternative must match. |
Nested field: Subtitle.font.family
At least one listed alternative must match.
anyOf alternative 1
Maximum length: 1000. Pattern: ^[a-zA-Z0-9_\- ]+$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.font.size
At least one listed alternative must match.
anyOf alternative 1
Minimum: 1. Maximum: 1000.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.font.color
At least one listed alternative must match.
anyOf alternative 1
#rrggbb or #rrggbbaa
Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.font.bold
At least one listed alternative must match.
anyOf alternative 1
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.font.italic
At least one listed alternative must match.
anyOf alternative 1
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.font.transform
At least one listed alternative must match.
anyOf alternative 1
Type: "uppercase" / "lowercase" / "capitalize".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.stroke
At least one listed alternative must match.
anyOf alternative 1
Unknown properties are rejected. Required properties: color, width.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Subtitle.stroke.color | string OR string | Yes | At least one listed alternative must match. |
Subtitle.stroke.width | number OR string | Yes | At least one listed alternative must match. |
Nested field: Subtitle.stroke.color
At least one listed alternative must match.
anyOf alternative 1
#rrggbb or #rrggbbaa
Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.stroke.width
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0. Maximum: 100.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.background
At least one listed alternative must match.
anyOf alternative 1
Minimum properties: 1. Unknown properties are rejected.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Subtitle.background.color | string OR string | No | At least one listed alternative must match. |
Subtitle.background.opacity | number OR string | No | At least one listed alternative must match. |
Subtitle.background.padding | number OR string | No | At least one listed alternative must match. |
Subtitle.background.radius | number OR string | No | At least one listed alternative must match. |
Nested field: Subtitle.background.color
At least one listed alternative must match.
anyOf alternative 1
#rrggbb or #rrggbbaa
Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.background.opacity
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0. Maximum: 1.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.background.padding
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0. Maximum: 200.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.background.radius
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0. Maximum: 200.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.activeWord
At least one listed alternative must match.
anyOf alternative 1
Highlight styling for the currently spoken word.
Minimum properties: 1. Unknown properties are rejected.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Subtitle.activeWord.color | string OR string | No | At least one listed alternative must match. |
Subtitle.activeWord.background | string OR string | No | At least one listed alternative must match. |
Subtitle.activeWord.radius | number OR string | No | At least one listed alternative must match. |
Nested field: Subtitle.activeWord.color
At least one listed alternative must match.
anyOf alternative 1
#rrggbb or #rrggbbaa
Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.activeWord.background
At least one listed alternative must match.
anyOf alternative 1
#rrggbb or #rrggbbaa
Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.activeWord.radius
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0. Maximum: 200.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.position
At least one listed alternative must match.
anyOf alternative 1
Type: "top-left" / "top-center" / "top-right" / "bottom-left" / "bottom-center" / "bottom-right" / "center-center" / "center-left" / "center-right" / "top" / "center" / "bottom".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.margin
At least one listed alternative must match.
anyOf alternative 1
Minimum properties: 1. Unknown properties are rejected.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Subtitle.margin.x | integer OR string | No | At least one listed alternative must match. |
Subtitle.margin.y | integer OR string | No | At least one listed alternative must match. |
Nested field: Subtitle.margin.x
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.margin.y
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles
At least one listed alternative must match.
anyOf alternative 1
LEGACY style block — prefer the flat v2 keys. Cannot be combined with them.
Unknown properties are rejected.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Subtitle.styles.color | string OR string | No | At least one listed alternative must match. |
Subtitle.styles.background | string OR string | No | At least one listed alternative must match. |
Subtitle.styles.backgroundPadding | number OR string | No | At least one listed alternative must match. |
Subtitle.styles.backgroundRadius | number OR string | No | At least one listed alternative must match. |
Subtitle.styles.isBold | boolean OR string | No | At least one listed alternative must match. |
Subtitle.styles.isItalic | boolean OR string | No | At least one listed alternative must match. |
Subtitle.styles.fontSize | number OR string | No | At least one listed alternative must match. |
Subtitle.styles.fontFamily | string OR string | No | At least one listed alternative must match. |
Subtitle.styles.textTransform | "uppercase" / "lowercase" / "capitalize" OR string | No | At least one listed alternative must match. |
Subtitle.styles.outline | object OR string | No | At least one listed alternative must match. |
Subtitle.styles.position | "top-left" / "top-center" / "top-right" / "bottom-left" / "bottom-center" / "bottom-right" / "center-center" / "center-left" / "center-right" OR string | No | At least one listed alternative must match. |
Subtitle.styles.marginV | integer OR string | No | At least one listed alternative must match. |
Subtitle.styles.marginH | integer OR string | No | At least one listed alternative must match. |
Subtitle.styles.mode | "normal" / "none" / "one-word" / "karaoke" / "progressive" / "highlight" / "fill" / "pop" / "bounce" / "fade" / "slide" / "typewriter" OR string | No | At least one listed alternative must match. |
Subtitle.styles.slideDirection | "up" / "down" / "left" / "right" OR string | No | At least one listed alternative must match. |
Subtitle.styles.activeWord | object OR string | No | At least one listed alternative must match. |
Nested field: Subtitle.styles.color
At least one listed alternative must match.
anyOf alternative 1
#rrggbb or #rrggbbaa
Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.background
At least one listed alternative must match.
anyOf alternative 1
#rrggbb or #rrggbbaa
Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.backgroundPadding
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0. Maximum: 200.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.backgroundRadius
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0. Maximum: 200.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.isBold
At least one listed alternative must match.
anyOf alternative 1
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.isItalic
At least one listed alternative must match.
anyOf alternative 1
Type: boolean.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.fontSize
At least one listed alternative must match.
anyOf alternative 1
Minimum: 1. Maximum: 1000.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.fontFamily
At least one listed alternative must match.
anyOf alternative 1
Maximum length: 1000. Pattern: ^[a-zA-Z0-9_\- ]+$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.textTransform
At least one listed alternative must match.
anyOf alternative 1
Type: "uppercase" / "lowercase" / "capitalize".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.outline
At least one listed alternative must match.
anyOf alternative 1
Unknown properties are rejected. Required properties: width, color.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Subtitle.styles.outline.width | number OR string | Yes | At least one listed alternative must match. |
Subtitle.styles.outline.color | string OR string | Yes | At least one listed alternative must match. |
Nested field: Subtitle.styles.outline.width
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0. Maximum: 100.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.outline.color
At least one listed alternative must match.
anyOf alternative 1
#rrggbb or #rrggbbaa
Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.position
At least one listed alternative must match.
anyOf alternative 1
Type: "top-left" / "top-center" / "top-right" / "bottom-left" / "bottom-center" / "bottom-right" / "center-center" / "center-left" / "center-right".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.marginV
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.marginH
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0.
Type: integer.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.mode
At least one listed alternative must match.
anyOf alternative 1
Type: "normal" / "none" / "one-word" / "karaoke" / "progressive" / "highlight" / "fill" / "pop" / "bounce" / "fade" / "slide" / "typewriter".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.slideDirection
At least one listed alternative must match.
anyOf alternative 1
Type: "up" / "down" / "left" / "right".
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.activeWord
At least one listed alternative must match.
anyOf alternative 1
Minimum properties: 1. Unknown properties are rejected.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Subtitle.styles.activeWord.color | string OR string | No | At least one listed alternative must match. |
Subtitle.styles.activeWord.background | string OR string | No | At least one listed alternative must match. |
Subtitle.styles.activeWord.radius | number OR string | No | At least one listed alternative must match. |
Nested field: Subtitle.styles.activeWord.color
At least one listed alternative must match.
anyOf alternative 1
#rrggbb or #rrggbbaa
Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.activeWord.background
At least one listed alternative must match.
anyOf alternative 1
#rrggbb or #rrggbbaa
Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
Nested field: Subtitle.styles.activeWord.radius
At least one listed alternative must match.
anyOf alternative 1
Minimum: 0. Maximum: 200.
Type: number.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
anyOf alternative 2
Pattern: \{\{\s*[A-Za-z][A-Za-z0-9_]*(?:\.(?:[A-Za-z][A-Za-z0-9_]*|[0-9]+))*\s*\}\}.
Type: string.
oneOf alternative 1
Required properties: src.
Type: any JSON value.
Additional JSON Schema constraints:
{
"not": {
"required": [
"captions"
]
}
}
oneOf alternative 2
Required properties: captions.
Type: any JSON value.
Additional JSON Schema constraints:
{
"not": {
"required": [
"src"
]
}
}
Additional JSON Schema constraints:
{
"dependentSchemas": {
"styles": {
"properties": {
"animation": false,
"direction": false,
"font": false,
"stroke": false,
"background": false,
"activeWord": false,
"position": false,
"margin": false
}
}
}
}
Project
An editor draft project, including its full project JSON. Open it in the visual editor at https://editor.zvid.io?project=<id>.
Required properties: id, name, type, version.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
Project.id | string | Yes | |
Project.userId | integer | No | |
Project.name | string | Yes | |
Project.payload | RenderPayload | No | |
Project.type | "video" / "image" | Yes | Derived from the stored payload's type |
Project.version | integer | Yes | Incremented on every update |
Project.createdAt | string | No | Format: date-time. |
Project.updatedAt | string | No | Format: date-time. |
ValidationError
Required properties: error.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
ValidationError.error | string | Yes | |
ValidationError.message | string | No | |
ValidationError.details | array of object | No | |
ValidationError.planLimits | object | No | Present on render validation errors; contains the authenticated user's current render limits. |
Nested field: ValidationError.details
Array item: ValidationError.details[]
Unknown properties are rejected. Required properties: field, message.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
ValidationError.details[].field | string | Yes | |
ValidationError.details[].message | string | Yes |
AuthenticationError
Unknown properties are rejected. Required properties: error.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
AuthenticationError.error | string | Yes | Error type |
AuthenticationError.message | string | No | Human-readable error message |