Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.13 KB

srt_writer.md

File metadata and controls

31 lines (21 loc) · 1.13 KB
Raw

SRT Writer

Overview

The SRT writer (ttconv/srt/writer.py) converts a data model document into the SRT format.

Usage

The SRT writer takes a model.ContentDocument object as input, and returns an SRT document as string.

import ttconv.srt.writer as srt_writer

# With 'doc' an instance of 'model.ContentDocument'
print(srt_writer.from_model(doc))

Architecture

The input document is processed to extract a list of ISDs (Intermediate Synchronic Document), which are passed through filters (in ttconv/filters) to:

  • remove unsupported features
  • merge document elements
  • set default property values

Once filtered, ISD elements are passed to the SrtContext to be converted into SrtParagraph instances defined in ttconv/srt/paragraph.py, including SRT supported styling (see ttconv/srt/style.py). The output document generation is completed after the call of the SrtContext::finish() method, which sets the last element assets. The resulting SRT document is gettable calling the overridden built-in SrtContext::__str__() function.