Skip to main content

Bif_creator

NameTypeDescription
source_stream_selectionenum                          
all
highest
middle
first
Selects the video stream that will be used for BIF creation.
timestamp_multiplierintegerAn option passed to biftool when image sequence is used as a source.
base_namestring
This describes the target file name. Placeholders such as {source_basename} for source file name are supported.
default: {source_basename}
locationobjectThe target output location for the BIF stream.
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
include_in_resultbooleanIncludes the BIF data in the results document.

Example bif_creator

{
"name": "Hybrik BIF Creator Example",
"payload": {
"elements": [
{
"uid": "source_file",
"kind": "source",
"payload": {
"kind": "asset_url",
"payload": {
"storage_provider": "s3",
"url": "s3://my_bucket/my_input_folder/my_file.mp4"
}
}
},
{
"uid": "transcode_task",
"kind": "transcode",
"payload": {
"location": {
"storage_provider": "s3",
"path": "s3://my_bucket/my_output_folder"
},
"targets": [
{
"file_pattern": "{source_basename}_converted.mp4",
"existing_files": "replace",
"container": {
"kind": "mp4"
},
"video": {
"width": 1280,
"height": 720,
"codec": "h264",
"profile": "high",
"level": "4.0",
"frame_rate": 23.976
},
"audio": [
{
"codec": "aac",
"channels": 2,
"sample_rate": 48000,
"sample_size": 16,
"bitrate_kb": 128
}
]
}
]
}
},
{
"uid": "bif_creator_task",
"kind": "bif_creator",
"payload": {
"source_stream_selection": "highest",
"location": {
"storage_provider": "s3",
"path": "s3://my_bucket/my_output_folder"
},
"base_name": "{source_basename}_BIF",
"include_in_result": true,
"existing_files": "replace"
}
}
],
"connections": [
{
"from": [
{
"element": "source_file"
}
],
"to": {
"success": [
{
"element": "transcode_task"
}
]
}
},
{
"from": [
{
"element": "transcode_task"
}
],
"to": {
"success": [
{
"element": "bif_creator_task"
}
]
}
}
]
}
}