Skip to main content

Metadata

NameTypeDescription
formatenum                          
dolbyvision_metadata
The metadata format to use.
locationobjectA location that overrides any location defined within the parents of this encode target.
file_patternstring
This describes the target file name. Placeholders such as {source_basename} for source file name are supported.
default: {source_basename}
existing_filesenum                          
delete_and_replace
replace
replace_late
rename_new
rename_org
fail
The desired behavior when a target file already exists. "replace": will delete the original file and write the new one. "rename_new": gives the new file a different auto-generated name. "rename_org": renames the original file. Note that renaming the original file may not be possible depending on the target location. "delete_and_replace": attempts to immediately delete the original file. This will allow for fast failure in the case of inadequate permissions. "replace_late": does not attempt to delete the original -- simply executes a write.
default: fail

Example metadata

{
"file_pattern": "{source_basename}_converted.mov",
"existing_files": "replace",
"container": {
"kind": "mov"
},
"video": {
"codec": "prores",
"profile": "ap4x",
"width": 3840,
"height": 2160,
"dar": "16/9",
"frame_rate": "24000/1001",
"interlace_mode": "progressive",
"chroma_format": "yuv444p12le",
"color_primaries": "bt2020",
"color_trc": "st2084",
"color_matrix": "bt2020nc"
},
"metadata": [
{
"format": "dolbyvision_metadata",
"file_pattern": "{source_basename}_converted.xml",
"location": {
"storage_provider": "s3",
"path": "s3://my_bucket/my_folder"
}
}
]
}