Server-side Rendering JSON Examples
This section provides complete JSON examples for common server-side rendering capabilities. Select a category below; every child page contains complete, parseable business JSON and a key-parameter reference.
The media URLs and package IDs in these examples demonstrate the data structure. Replace them with media accessible to your rendering environment and packages installed in that environment.
Every example is rooted at timeline, which maps to the timeline field of the start synthesis task request body, so it can be copied as is.
Categories
| Category | Contents |
|---|---|
| Minimal JSON Example | Contains one video clip and one compound caption for quickly validating the rendering flow. |
| Video Transitions | Built-in transitions, package transitions, and transition duration. |
| General Captions | Caption styling, outlines, shadows, layout, position, and rotation. |
| Stylized Captions | Style resources, backgrounds, outlines, shadows, animations, and letter spacing. |
| Stickers | General stickers, stickers with audio, and sticker animations. |
| Compound Captions | Caption items, per-item styling, and compound-caption transforms. |
| Timeline Effects | Package effects, filters, and intensity. |
| Particle Effects | Full-screen particle parameters and hand-drawn particle paths. |
| Watermarks | Custom-media watermarks and multiple watermark tracks. |
Shared Project Fields
The following fields form the shared project structure used by the rendering examples. Capability-specific sections focus on transition, caption, sticker, effect, and watermark parameters.
Timeline Fields
| Field path | Purpose | Type and constraints | Example values |
|---|---|---|---|
timeline.compoundCaptionTracks[] | Business parameter | See the corresponding object definition | Not set |
timeline.duration | Timeline position or duration | integer, microseconds; normally >= 0 | 49200000 |
timeline.enableRenderOrderByZValue | Business parameter | See the corresponding object definition | true |
timeline.fps | Business parameter | See the corresponding object definition | 25 |
timeline.isDefaultCaptionFade | Business parameter | See the corresponding object definition | false |
timeline.outputEnd | Business parameter | See the corresponding object definition | -1 |
timeline.outputStart | Business parameter | See the corresponding object definition | 0 |
timeline.outputType | Business parameter | See the corresponding object definition | Not set |
timeline.resHeight | Business parameter | See the corresponding object definition | 540 |
timeline.resWidth | Business parameter | See the corresponding object definition | 960 |
timeline.safeFrameSize | Business parameter | See the corresponding object definition | 1 |
timeline.sizeLevel | Business parameter | See the corresponding object definition | -1 |
timeline.templateId | Package, style, or animation ID | string; required when the referenced resource is used | Not set |
timeline.timelineFlags | Business parameter | See the corresponding object definition | 562 |
timeline.videoSize | Business parameter | See the corresponding object definition | 16:9 |
timeline.volume | Volume | number; supported range depends on the rendering service | 1 |
Shared Track, Clip, and Base-effect Fields
| Field path | Purpose | Type and constraints | Example values |
|---|---|---|---|
timeline.audioTracks[].channelType | Business parameter | See the corresponding object definition | stereo |
timeline.audioTracks[].index | Object index | integer; unique or ordered within the containing collection | 1 |
timeline.audioTracks[].show | Business parameter | See the corresponding object definition | true |
timeline.audioTracks[].volume | Volume | number; supported range depends on the rendering service | 1 |
timeline.musicLyricsTracks[].index | Object index | integer; unique or ordered within the containing collection | 0 |
timeline.musicLyricsTracks[].show | Business parameter | See the corresponding object definition | true |
timeline.videoTracks[].channelType | Business parameter | See the corresponding object definition | stereo |
timeline.videoTracks[].index | Object index | integer; unique or ordered within the containing collection | 2 to 3 |
timeline.videoTracks[].show | Business parameter | See the corresponding object definition | true |
timeline.videoTracks[].videos[].aliasTag | Business parameter | See the corresponding object definition | Not set |
timeline.videoTracks[].videos[].blendingMode | Business parameter | See the corresponding object definition | 0 |
timeline.videoTracks[].videos[].captions[] | Business parameter | See the corresponding object definition | Not set |
timeline.videoTracks[].videos[].combination | Business parameter | See the corresponding object definition | false |
timeline.videoTracks[].videos[].combinationOrder | Business parameter | See the corresponding object definition | 0 |
timeline.videoTracks[].videos[].enableClipFreezeFrame | Business parameter | See the corresponding object definition | false |
timeline.videoTracks[].videos[].enableRawSourceMode | Business parameter | See the corresponding object definition | false |
timeline.videoTracks[].videos[].extraRotation | Business parameter | See the corresponding object definition | 0 |
timeline.videoTracks[].videos[].fadeInDuration | Business parameter | See the corresponding object definition | 0 |
timeline.videoTracks[].videos[].fadeOutDuration | Business parameter | See the corresponding object definition | 0 |
timeline.videoTracks[].videos[].fillMode | Business parameter | See the corresponding object definition | 0 |
timeline.videoTracks[].videos[].freezeFrameTrimPos | Business parameter | See the corresponding object definition | 0 |
timeline.videoTracks[].videos[].horizontalFlip | Business parameter | See the corresponding object definition | false |
timeline.videoTracks[].videos[].id | Package, style, or animation ID | string; required when the referenced resource is used | 155953 to 156213 |
timeline.videoTracks[].videos[].inPoint | Timeline position or duration | integer, microseconds; normally >= 0 | 520000 to 34480000 |
timeline.videoTracks[].videos[].index | Object index | integer; unique or ordered within the containing collection | 0 to 2 |
timeline.videoTracks[].videos[].isTimelineClip | Business parameter | See the corresponding object definition | false |
timeline.videoTracks[].videos[].keepAudioPitch | Business parameter | See the corresponding object definition | true |
timeline.videoTracks[].videos[].m3u8Path | Business parameter | See the corresponding object definition | /m3u8/0c3fef7c-7b57-4cd7-9cee-1604e90d59d5.m3u8, /m3u8/4281f88f-8cf3-4a15-acb5-f5be6a37158f.m3u8, /m3u8/c1bc8ea2-b964-44a1-b2ad-5693533f6b7e.m3u8 |
timeline.videoTracks[].videos[].noAudio | Business parameter | See the corresponding object definition | true, false |
timeline.videoTracks[].videos[].outPoint | Timeline position or duration | integer, microseconds; normally >= 0 | 14440000 to 49200000 |
timeline.videoTracks[].videos[].path | Media URL | string; must be reachable by the rendering service | 3 non-empty values |
timeline.videoTracks[].videos[].rawFilterProcessesMode | Business parameter | See the corresponding object definition | 0 |
timeline.videoTracks[].videos[].refImageHeight | Business parameter | See the corresponding object definition | 0 |
timeline.videoTracks[].videos[].refImageWidth | Business parameter | See the corresponding object definition | 0 |
timeline.videoTracks[].videos[].reverse | Business parameter | See the corresponding object definition | false |
timeline.videoTracks[].videos[].reversePath | Business parameter | See the corresponding object definition | Not set |
timeline.videoTracks[].videos[].separated | Business parameter | See the corresponding object definition | false |
timeline.videoTracks[].videos[].speed | Business parameter | See the corresponding object definition | 1 |
timeline.videoTracks[].videos[].stickers[] | Business parameter | See the corresponding object definition | Not set |
timeline.videoTracks[].videos[].trimIn | Timeline position or duration | integer, microseconds; normally >= 0 | 0 |
timeline.videoTracks[].videos[].trimOut | Timeline position or duration | integer, microseconds; normally >= 0 | 13920000 to 20040000 |
timeline.videoTracks[].videos[].verticalFlip | Business parameter | See the corresponding object definition | false |
timeline.videoTracks[].videos[].videoFxs[].absoluteTimeUsed | Business parameter | See the corresponding object definition | true |
timeline.videoTracks[].videos[].videoFxs[].duration | Timeline position or duration | integer, microseconds; normally >= 0 | -1 |
timeline.videoTracks[].videos[].videoFxs[].fxParams[].key | Effect parameter name | string; defined by the SDK or package | 36 values |
timeline.videoTracks[].videos[].videoFxs[].fxParams[].type | Object or parameter type | string; allowed values depend on the containing object | float, menu, color, bool |
timeline.videoTracks[].videos[].videoFxs[].fxParams[].value | Parameter value | string; logical numbers and booleans remain strings | 7 values |
timeline.videoTracks[].videos[].videoFxs[].inPoint | Timeline position or duration | integer, microseconds; normally >= 0 | 0 |
timeline.videoTracks[].videos[].videoFxs[].index | Object index | integer; unique or ordered within the containing collection | 0 to 8 |
timeline.videoTracks[].videos[].videoFxs[].intensity | Effect intensity | number; [0, 1] | 1 |
timeline.videoTracks[].videos[].videoFxs[].isIgnoreBackground | Business parameter | See the corresponding object definition | false |
timeline.videoTracks[].videos[].videoFxs[].isInverseRegion | Business parameter | See the corresponding object definition | false |
timeline.videoTracks[].videos[].videoFxs[].isRaw | Business parameter | See the corresponding object definition | false, true |
timeline.videoTracks[].videos[].videoFxs[].isRegional | Business parameter | See the corresponding object definition | false |
timeline.videoTracks[].videos[].videoFxs[].name | Built-in effect name | string; required when type=builtin | 7 values |
timeline.videoTracks[].videos[].videoFxs[].regionalFeatherWidth | Business parameter | See the corresponding object definition | 0 |
timeline.videoTracks[].videos[].videoFxs[].shape | Business parameter | See the corresponding object definition | Not set |
timeline.videoTracks[].videos[].videoFxs[].type | Object or parameter type | string; allowed values depend on the containing object | property, builtin |
timeline.videoTracks[].videos[].volume | Volume | number; supported range depends on the rendering service | 0 to 1 |
timeline.videoTracks[].volume | Volume | number; supported range depends on the rendering service | 1 |
Parameter Reference
Object Paths
| Capability | JSON path |
|---|---|
| Video transitions | timeline.videoTracks[].transitions[] |
| General and stylized captions | timeline.captionTracks[].captions[] |
| Stickers | timeline.stickerTracks[].stickers[] |
| Compound captions | timeline.captionTracks[].compoundCaptions[] |
| Timeline effects | timeline.timelineVideoFxTracks[].timelineVideoFxs[] |
| Watermarks | timeline.watermarkTracks[].stickerTracks[].stickers[] |
Parameter Rules
| Parameter | Rule |
|---|---|
| Timeline time | inPoint, outPoint, trimIn, trimOut, and ordinary duration values use microseconds. |
| Animation time | animationPeroid, inAnimationDuration, and outAnimationDuration use milliseconds. |
| Curve-point time | curvePoint.timeSec uses seconds. |
| Color | Colors use #AARRGGBB; the first two digits are alpha. |
| Effect intensity | intensity must be within [0, 1]. |
| Built-in effect | A non-empty name is required when type=builtin. |
| Package effect | A non-empty id is required when type=package. |
| Parameter value | fxParams[].value and keyFrames[].value remain strings. |
| Array order | Video clips, transitions, effects, keyframes, and caption items are processed in array order. |
| Media URL | The rendering service must be able to access path values for ordinary media and custom watermarks. |