Skip to main content

Publish output format

The output includes both the asset data provided in the launch template and a project object produced by Edit.

{
"data": {
"assets": [...],
"project": {...}
}
}

Project

The project object is the EDL produced by Edit. It holds metadata describing general project properties like frame rate and aspect ratio. It also describes the timeline as an array of segments.

{
"project": {
"metadata": [
{
"key": "av_layer_data",
"value": "[]"
},
{
"key": "av_frame_rate_numerator",
"value": "24"
},
{
"key": "av_frame_rate_denominator",
"value": "1"
},
{
"key": "av_drop_frame",
"value": "false"
},
{
"key": "av_aspect_ratio_width",
"value": "256"
},
{
"key": "av_aspect_ratio_height",
"value": "109"
}
],
"segments": [
{
"start": {
"frame": 0,
"numerator": 24,
"denominator": 1
},
"end": {
"frame": 121,
"numerator": 24,
"denominator": 1
},
"metadata": [
{
"key": "z-index",
"value": "0"
},
{
"key": "source-in",
"value": "0"
},
{
"key": "source-out",
"value": "3557400000"
},
{
"key": "track-type",
"value": "V"
},
{
"key": "track",
"value": "V0"
},
{
"key": "source-track",
"value": "0"
},
{
"key": "source-channel",
"value": "0"
},
{
"key": "target-track",
"value": "0"
},
{
"key": "source-rate-drop-frame",
"value": "false"
},
{
"key": "source-asset-id",
"value": "123"
},
{
"key": "source-file-id",
"value": "234"
}
]
}
]
}
}

Project

Metadata KeyTypeDescription
av_layer_dataObjectData representing each layer in the sequence.
av_frame_rate_numeratorIntegerThe numerator value of the sequence frame rate.
av_frame_rate_denominatorIntegerThe denominator value of the sequence frame rate.
av_drop_frameBooleanFlag that declares whether the sequence uses drop frame.
av_aspect_ratio_widthIntegerThe width value of the sequence aspect ratio.
av_aspect_ratio_heightIntegerThe height value of the sequence aspect ratio.

Segments

Each segment targets one track and one channel.

Metadata KeyTypeDescription
track-typeStringThe timeline track type, e.g. V.
trackStringThe timeline track for the segment, e.g. V0.
z-indexIntegerZ index of the segment on the timeline track, higher number means higher priority. For overlapping segments, the segment with lower Z-index will be cut off, leaving room for the segment with higher Z-index.
source-file-idStringId of the source file provided in the launch template.
source-asset-idStringId of the source asset provided in the launch template.
source-trackStringThe referenced track of the specified source asset.
source-channelStringThe referenced channel of the specified source track.
source-inIntegerInpoint in the source material to use for the segment, in flicks.
source-outIntegerOutpoint in the source material to use for the segment, in flicks.
target-trackStringThe track which an export targets.
source-rate-drop-frameBooleanFlag that declares whether the associated video source uses drop frame.
muxedBooleanFlag that declares whether the audio source, if any, is muxed.