Colossyan API Documentation
Scenes
Scenes
A scene is a logical consolidation of related content.
A video can consist of multiple scenes. These scenes are concatenated together. Think of them as slides on a presentation. Each scene is meant to aggregate and encapsulate related content.
Scenes offer a lot of convenience in timing their content, however it is completely up to the individual to decide how to divide the content into scenes.
Scene properties
Key | Default | Required | Type | Description |
---|---|---|---|---|
name | - | No | string | An optional name of the scene |
duration | - | No | number | An explicit duration for this scene in milliseconds. Anything longer will be cut out |
intrinsicDurationTrackReference | - | No | string | The scene can be set to be as long as one of its tracks, by referencing it here |
tracks | - | Yes | Track[] | The tracks in this scene (any type). The order decides how the tracks overlap. |
Good practices
- Don't have large scenes, rather use multiple smaller ones.
- Greetings and goodbye-s should be in their own separate scenes.
- Subject changes or a larger shift in content indicate that a new scene should be started.
- Use multiple scenes with seamless concatenation to conveniently divide the video into logical parts without cuts between them.