Structure
JSON payload to use with the Combo API and all combo editors.
Composition
This section outlines the primary properties of a video project composition.
id: A unique identifier for the project.fps: Frames per second setting for the video composition.size: Defines the output video dimensions, includingwidthandheight.
Tracks
Tracks serve as distinct layers within the composition, each containing specific media items. They dictate how different media types are organized and manipulated.
| Property | Description |
|---|---|
id | Unique identifier for the track. |
accepts | Specifies the types of items the track can contain, such as text, audio, video, images, etc. |
type | Defines the primary type of media the track is designed to hold, like video or image. |
items | An array of item IDs that are part of this track. |
magnetic | Boolean indicating whether track items snap to a grid or timeline. |
static | Boolean indicating if the track items are unmovable. |
Track Item Details Map
This section contains detailed properties for each track item, offering fine controls over its appearance and behavior.
type: Specifies the type of item (e.g., video, image).details: Contains attributes like:src: The source URL of the media.width,height: Original media dimensions.opacity: Transparency level of the item.transform,flipX,flipY: Controls for scaling and flipping the item.brightness,blur: Visual effects applied to the item.
Track Items Map
Provides metadata and playback details for individual items within the track.
trim: Start and end time (milliseconds) of the item for cropping purposes.playbackRate: Speed at which the item plays back relative to normal speed.display: Specifies the time range (in milliseconds) the item is visible on the timeline.isMain: Marks if the track item is the primary focus.
Transitions Map
Describes transitions between track items that create smooth or dynamic changes.
id: Unique identifier for the transition.duration: Duration (milliseconds) of the transition.fromId,toId: Item IDs between which the transition occurs.kind: Type of transition effect (e.g., slide, wipe).direction: Direction in which the transition effect should occur.
Lists of Identifiers
trackItemIds: Array containing the IDs of all track items in the project.transitionIds: Array of transition IDs, presenting the order and arrangement of effects between track items.