These are the current schemas, from OpenTimelineIO’s autogenerated list. Each object also
has its OTIO_SCHEMA
field. Media references and effects are on
their own page.
Common fields
Most schemas share name, a string, and metadata, a
dictionary. Objects derived from Item also have these fields.
| Field | Type | Meaning |
|---|---|---|
source_range | TimeRange or null | The part of the item used. |
effects | list of Effect | Effects on the item. |
markers | list of Marker | Markers on the item. |
enabled | boolean | If true, the item contributes to compositions. A disabled clip is muted or hidden. |
color | Color or null | A colour for the item. |
Timeline.1
| Field | Type | Meaning |
|---|---|---|
name | string | Name. |
metadata | dictionary | Extra data. |
global_start_time | RationalTime or null | The time the timeline starts at. |
tracks | Stack | The contents of the timeline. |
Stack.1
Common item fields, and children, a list of composable objects. Children
are layered on top of each other.
Track.1
Common item fields, children, and kind, a string that is
either Video or Audio. Children play one after another.
Clip.2
Common item fields, and these.
| Field | Type | Meaning |
|---|---|---|
media_references | dictionary of MediaReference | The available references, by key. |
active_media_reference_key | string | The key in use. The library’s default is DEFAULT_MEDIA. |
Gap.1
Common item fields. A gap is empty time; its length comes from
source_range. Old files may use the alias Filler.
Transition.1
| Field | Type | Meaning |
|---|---|---|
name, metadata | As usual. | |
enabled | boolean | If false, the adjacent clips are cut together with no transition. |
transition_type | string | The kind of transition. The library defines SMPTE_Dissolve and Custom_Transition. |
in_offset | RationalTime | How much of the previous clip the transition overlaps, exclusive. |
out_offset | RationalTime | How much of the next clip the transition overlaps, exclusive. |
Marker.3
| Field | Type | Meaning |
|---|---|---|
name, metadata | As usual. | |
marked_range | TimeRange | The range the marker applies to, relative to the item it is attached to. |
color | Color or null | The marker’s colour; the constructor’s default is green. |
comment | string | An optional comment. |
SerializableCollection.1
name, metadata and children, a list of any
objects. It is the recommended way to store more than one timeline in a file.
Base types
These appear in a file only when written directly. They define fields that the types above inherit.
| Schema | Fields |
|---|---|
SerializableObjectWithMetadata.1 | name, metadata. |
Composable.1 | name, metadata. |
Item.1 | The common item fields. |
Composition.1 | The common item fields. |
Plugin types
These describe library plugins rather than timelines. They live in a plugin manifest
file, found through the environment variable OTIO_PLUGIN_MANIFEST_PATH.
| Schema | Fields |
|---|---|
Adapter.1 | name, filepath (absolute, or relative to the JSON), suffixes (file suffixes for this adapter). |
HookScript.1 | name, filepath. |
MediaLinker.1 | name, filepath. |
SchemaDef.1 | name, filepath. |
PluginManifest.1 | adapters, media_linkers, schemadefs, hook_scripts, hooks, version_manifests. |