Import subtitles

If you want to import subtitles from a text file, please use the following steps.

Please note that your text file (with the captions) must be a valid SRT file. See below for the structure.

Step 1

Create an upload document with a mediaContainer of type “importedSubtitle” and with flag 31. Additionally make sure to create the related media as type document with usage “subtitle” and additionalSettings with the subtitle language and the mediaContainerId to use this subtitle for.

You can also send metadata (like the container_name) with the request. If a container_name is set, it will be used as “name” for the subtitle. If no container_name is set, the name of the subtitle will be “Imported Subtitle LANGUAGE” (e.g. “Imported Subtitle FR”).

{
   "payload":[
      {
         "type":"importedSubtitle",
         "flag":31,
         "fileName":"my-subtitle-file.srt",
         "originalFileExtension":"srt",
         "fileSize":12345,
         "usage": "subtitle",
         "additionalSettings": {
            "subtitleLanguage": "fr",
            "mediaContainerId": 123
      }
   ]
}

Step 2

Start the upload with the given information from the first step. Do not forget to make S3.success call (S3 Controller) at the end to trigger the import.

You will see activities for the import as well as receive a ES model change for the affected mediaContainer.

Structure of the import file

TBC