Skip to main content

Print_subtitle

NameTypeDescription
x_offsetinteger
string
The x offset. Can use expressions such as N%. If it is a number without further units, it will be considered as pixels.
y_offsetinteger
string
The y offset. Can use expressions such as N%. If it is a number without further units, it will be considered as pixels.
time_offset_secnumber
Specify a time offset (in seconds) in either direction.
categoryenum                          
default
forced
sdh
Optional: specify which source subtitle shall be rendered if multiple exist in the source asset.
languagestring
Optional: specify which source subtitle shall be rendered if multiple exist in the source asset.
font_sizestring
Optional: specify the font size to use when rendering subtitles. Usage of this setting means any font size settings that may already exist in the source subtitle are ignored.
background_colorstring
Optional: specify the background color to use when rendering subtitles. Usage of this setting means any background color settings that may already exist in the source subtitle are ignored.
imprint_styleenum                          
auto
closed_caption
subtitle
ttml
The type of subtitle imprint to use.
font_filesarrayAllows referencing hosted font files, with an optional language specifier.
ttml_previewobjectUpload pre-rendered html files into url - debug only.
lut_fileobjectAllows referencing hosted LUT files, for example for SDR imprint into HDR video.
lut_presetenum                          
r709_to_r2020_pq_300nit
The LUT preset selection.
is_optionalbooleanif set to true, the transcode will not fail if this media type did not exist in the source or no source subtitle could be located.

Example print_subtitle

{
"uid": "transcode_media",
"kind": "transcode",
"payload": {
"location": {
},
"targets": [
{
"file_pattern": "{source_basename}_converted.mp4",
"container": {
"kind": "mp4"
},
"video": {
"codec": "h264",
"filters": [
{
"kind": "print_subtitle",
"payload": {
"x_offset": "10%",
"y_offset": "20%",
"imprint_style": "ttml",
"language": "french"
}
}
]
},
"audio": [
{
}
]
}
]
}
}