captions:convert

captions:convert¶

Captions and Subtitles Converter

{
    "parameters": {
        "inputfile": "IN/tearsofsteel_4k_eng.srt",
        "language": "eng",
        "outputformat": "WEBVTT",

        "outputfile": "tearsofsteel-test.vtt"
  },
  "tool": "captions:convert"
},

Parameter	Properties	Default	Type	Choice	Description
inputfile	required
outputfile	required
outputformat	required			'WEBVTT', 'SAMI', 'DFXP', 'SRT', 'SST'
language	optional				set language tag for output (auto detection if supported by format)
offset	optional	PT0S	timedelta
force_input_language	optional				overwrite language tag for output if autodetection fails (if supported by format)
strip_html_tags	optional	false	bool		strip HTML tags when converting. Currently only supported when input is SRT
vtt_force_hours	optional	false	bool		when outputting to WEBVTT, force writing full timestamps (hh:mm:ss.xxx) even if the "hh" part is 00
strip_ass_tags	optional	false	bool		strip ASS tags when converting. Currently only supported when input is SRT
video_width	optional		int		width of the video the subtitles will be displayed on. If specified, height is required too.
video_height	optional		int		height of the video the subtitles will be displayed on. If specified, width is required too.
position	optional	bottom	str	'bottom', 'top'	specifies the position of subtitles. Currently limited to SCC and SRT output subtitle types
avoid_same_start_prev_end	optional	true	bool		avoid start time of a subtitle being the same as end time of previous one. Currently only supported when output format is SST
scenarist_compat	optional	false	bool		activate compatibility mode when writing SST format. Should produce more compatible files, but can break older systems.