Targets
Name | Type | Description |
---|---|---|
uid | string | A UID (arbitrary string) to allow referencing this target. This UID may be used, for example, to specify a target for preview generation. User supplied, must be unique within an array of targets. |
manifest_uids | array | An array of UIDs defining the manifests that this target belongs to. A target may belong to one or more manifests. |
processing_group_ids | array | Allows target selection for subsequent tasks. |
location | object | A location that overrides any location defined within the parents of this encode target. |
file_pattern | string | This describes the target file name. Placeholders such as {source_basename} for source file name are supported.default: {source_basename} |
trim | anyOf by_sec_in_out by_sec_in_dur by_timecode by_asset_timecode by_frame_nr by_section_nr by_media_track by_nothing | Object defining the type of trim operation to perform on an asset. |
existing_files | enum 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 |
parameter_compliance | enum strict relaxed | Conflicts between parameters (for example if both CBR and max_bitrate are specified) will generate an error if "Strict" is specified, otherwise Hybrik will execute the "intent" of the parameters. |
force_local_target_file | boolean | This will enforce the creation of a local file and bypass in-stream processing. Only used in scenarios where in-stream processing is impossible due to format issues. |
encryption_id | string | Encryption id, used for referencing encryptions |
include_if_source_has | array | This array allows for conditionally outputting tracks based on whether or not a specific input track exists. The tracks in the source are referred to by number reference: audio[0] refers to the first audio track. |
include_conditions | array | Specifies conditions under which this output will be created. Can use Javascript math.js nomenclature |
size_estimate | number string | Setting a size_estimate can help in allocating the right amount of temporary local storage. Omit if this value if it cannot be guessed with a +/- 5% certainty. |
ffmpeg_args | string | The FFmpeg command line to be used. Any properties defined in the target section of this JSON will override FFmpeg arguments defined here. |
ffmpeg_args_compliance | enum strict relaxed minimal late late_relaxed late_minimal | Hybrik will interpret a ffmpeg command line. Relaxed will allow also unknown or conflicting ffmpeg options to pass. late_* will reolve this at render time and preserve the original ffmpeg_args in the JSON. |
hybrik_encoder_args | string | The Hybrik encoder arguments line to be used. May overwrite default arguments. |
nr_of_passes | integer string | This specifies how many passes the encode will use. minimum: 1 maximum: 10 default: 1 |
slow_first_pass | boolean | h264/h265: enables a slow (more precise) first pass. |
compliance | enum xdcam_imx xdcam_hd xdcam_hd_422 xdcam_proxy xdcam_dvcam25 avcintra dvb atsc xavc hmmp senvu_2012 | This setting can be used to force output compliance to a particular standard, for example XDCAM-HD. |
compliance_enforcement | enum strict relaxed | Defines whether the output compliance will be strict or relaxed. Relaxed settings allow parameters to be overridden in the JSON. |
temp_location | object | Specify a location for temporary files (typically multi-pass). |
temp_file_prefix | string | Specify a prefix for every temp file (for shared folder/location use across various targets and tasks). |
container | object | The transcoding container parameters. |
video | object | The video parameters for the target output. |
audio | array | Array defining the audio tracks in the output. Each element of the array is an object defining the track parameters, including codec, number of channels, bitrate, etc. |
timecode | array | An array defining the timecode tracks in this output. |
metadata | array | Array defining the metadata tracks in the output. |
subtitle | array | Array defining the subtitle tracks in the output. |
Example targets
{
"uid": "transcode_task",
"kind": "transcode",
"payload": {
"location": {
"storage_provider": "s3",
"path": "s3://my_bucket/my_folder"
},
"targets": [
{
"file_pattern": "my_first_output_2tracks.mp4",
"existing_files": "replace",
"container": {
"kind": "mp4"
},
"video": {
"width": 1280,
"height": 720,
"codec": "h264",
"profile": "high",
"level": "4.0",
"frame_rate": "24000/1001"
},
"audio": [
{
"codec": "aac",
"channels": 1,
"sample_rate": 48000,
"sample_size": 16,
"bitrate_kb": 96
},
{
"codec": "aac",
"channels": 1,
"sample_rate": 48000,
"sample_size": 16,
"bitrate_kb": 96
}
]
},
{
"file_pattern": "my_second_output_6channels.mp4",
"existing_files": "replace",
"container": {
"kind": "mov"
},
"video": {
"width": 1920,
"height": 1080,
"codec": "h264",
"profile": "high",
"level": "4.0",
"frame_rate": "30000/1001"
},
"audio": [
{
"codec": "aac_lc",
"channels": 6,
"sample_rate": 48000,
"sample_size": 16,
"bitrate_kb": 256
}
]
}
]
}
}