Elements Array
The contents of the Elements Array are the components of your workflow. The available elements include: Source, Transcode, Analyze, QC, Notify, Copy, Package, Folder Enum, Watchfolder, DPP Package, BIF Creator, and Script. You can have multiple versions of the same type of element. For example, you could have 2 copies of the Analyze and QC tasks -- one for checking your incoming data and one for checking your outgoing results. These could be checking completely different parameters. Each Element has a UID that uniquely identifies it in the workflow.
Name | Type | Description |
---|---|---|
uid | string | A unique ID for the task element. An example would be "source_file" or "transcode_task_1". This UID allows the task to be uniquely referenced by other parts of the job. |
kind | enum source transcode copy analyze qc notify package folder_enum watchfolder dpp_packager bif_creator script | The type of task element. |
task | object | An object describing the generic task behavior, such as priority and number of retries. |
payload | object | The payload describes the parameters of the specific element. Only one type of payload is allowed. The options are: source transcode copy analyze qc notify package folder_enum watchfolder dpp_packager bif_creator script |
Elements Array Example
{
"elements": [
{
"uid": "source_file",
"kind": "source",
"payload": {
"kind": "asset_url",
"payload": {
"storage_provider": "s3",
"url": "s3://hybrik-examples/public/sources/sample1.mp4"
}
}
},
{
"uid": "transcode_task",
"kind": "transcode",
"payload": {
"location": {
"storage_provider": "s3",
"path": "s3://hybrik-examples/public/output/transcode/example1"
},
"targets": [
{
"file_pattern": "{source_basename}.mp4",
"existing_files": "replace",
"container": {
"kind": "mp4"
},
"video": {
"codec": "h264",
"width": 640,
"height": 360,
"frame_rate": 23.976,
"bitrate_kb": 600
},
"audio": [
{
"codec": "heaac_v2",
"channels": 2,
"sample_rate": 44100,
"bitrate_kb": 128
}
]
}
]
}
}
]
}