AdvancedSubtitleRequest

Property Reference

Field Name Required Type Description Format

applyFrameRateConversion

✘

Boolean

Do subtitle post-processing to convert the timings of the subtitle from a defined frame rate to the media frame rate

applyShotAlignment

✘

Boolean

Do subtitle post-processing to snap the subtitle timings to shot boundaries.

applySpeakerIds

✘

Boolean

Do subtitle post-processing to apply subtitle coloring based on speaker ids.

frameRateConversionOptions

✘

FrameRateConversionOptions

generateSubtitleFromASR

✘

Boolean

Instruct the workflow to use the transcription for the subtitle creation, the workflow will fail when no transcription is available.

generateTranscriptFromASA

✘

Boolean

Instruct the workflow to generate a transcript using alignment from where to start the subtitle creation.

generateTranscriptFromASR

✘

Boolean

Instruct the workflow to generate a transcription, the workflow will fail when a transcription is already available.

importFileResource

✘

InputFileResource

language

✘

String

The language of the subtitles.

overwriteSubtitleAllowed

✘

Boolean

When generating the subtitles, allow replacing the existing subtitles. If false, the task will fail if subtitles are present.

overwriteTranscriptAllowed

✘

Boolean

When generating the transcript, allow replacing the existing transcription. If false, the task will fail if a transcription is present.

removeBlankSubtitles

✘

Boolean

Instruct the import task to remove any imported blank subtitle lines

speechAlignmentFileResource

✘

InputFileResource

subtitlePresetId

✘

String

Use the settings in this Subtitle Preset to generate the Subtitle annotation.

subtitleTimingCorrections

✘

List of SubtitleTimingCorrection

Do subtitle post-processing to adjust the timings of the subtitle

subtitlingConfiguration

✘

subtitlingConfiguration

transcriptionDictionaryId

✘

Long

Id of the dictionary to use when generating the transcript

int64

transcriptionEngineConfiguration

✘

Object

transcriptionLanguage

✘

String

When transcription is needed, this language will be used.

transcriptionSpeechEngine

✘

String

The transcription engine to use when generating the transcript

Options to be used when doing frame rate conversion post-processing

Field Name Required Type Description Format

frameRate

✘

SampleRate

smpteTimecode

✘

String

Timecode to be used to correct/subtract from the timings of the subtitle

Settings for the subtitle. When omitted, the settings from the preset are used, which is usually sufficient.

Field Name Required Type Description Format

cellResolutionX

✘

Integer

int32

cellResolutionY

✘

Integer

int32

coloringMode

✘

String

Enum: CONSISTENT_COLOR_PER_SPEAKER, MAXIMIZE_COLOR_TRANSITIONS,

regions

✘

Map of Region

speakerColors

✘

Map of string

spottingRules

✘

SpottingRules

styles

✘

Map of Style

useSpeakerColors

✘

List of string