Export subtitles

GET /XAPI/v2/Projects/{ProjectId}/Export/Subtitles

Export subtitles

Exports the project’s transcription in a subtitle format. The subtitle format may be highly customized, providing options like editing the speaker sign, subtitle speed and various other styling settings.

Parameters:

  • ProjectId (integer)

Query Parameters:

  • FileFormatId (string)

  • VariantId (string)

  • SubtitleLineLength (string)

  • KeepStripped (boolean) – default: false

  • CodePageNumber (string)

  • DiskFormatCode (string)

  • DisplayStandardCode (string)

  • LanguageCode (string)

  • UseBoxAroundText (string)

  • ForceSingleLine (boolean) – default: false

  • SpeakerSignPlacement (string)

  • PauseBetweenCaptionsMs (integer) – default: 80

  • AutofillPauseBetweenCaptionsMs (integer) – default: 0

  • UseSpeakerName (boolean) – default: false

  • Language (string)

  • RemoveNoises (boolean) – default: true

  • CharsPerSecond (number) – default: 16.0

  • MinLineDurationMs (integer) – default: 2000

  • Ellipsis (string) – default: …

  • EllipsisGapDurationMs (integer) – default: 300

  • SpeakerSign (string) – default: -

  • FormattingMode (string)

  • MakeAllUpperCase (boolean) – default: false

  • KeepInnerLinesStripped (boolean) – default: false

  • IsRightToLeft (boolean) – default: false

  • HighlightingMode (string) – default: None

  • UnhighlightedColor (string) – default: White

  • UnhighlightedBackgroundColor (string) – default: White

Status Codes:
Response JSON Object:

  • Data (null)