Ingesting Closed Caption Files

You can ingest closed caption files via Backlot or FTP.

Note: This topic applies to both OIS v2.5 and OIS v1. Certain sections, where indicated, apply to just one version.

Supported Formats for Closed Captions Files

XML Manifest Formats for Closed Captions Files

Use the following elements and attributes in the XML Manifest File.
XML Tag Description
<media:subTitle> Specifies a closed-caption file. href attribute is required. One of the following:
  • Filename of the closed-caption file you uploaded. Example: <media:subTitle href="caption-1.dfxp"/>
  • URL where the closed-caption file is located. The URL can include http:// or https://. Example: <media:subTitle href="http://ooyala.com/captions/caption-1.dfxp"/>
There can be at most one <media:subTitle> element per video (<item>).
<media:hash> (OIS v1 only) (Optional) Within the <media:subTitle> element, you can optionally include the hash element to specify a cryptographic hash value and the hash function algorithm that was used to generate the hash value. Use the syntax shown in the following example.
<media:hash algo=”md5”>5d42be7f301dad5acf42d565fd651857</media:hash>

where

  • algo is md5 (hash function)
  • hash value is 5d42be7f301dad5acf42d565fd651857

XML Manifest Example for Closed Captions (OIS v2.5)

<rss>
 <channel> 
  <item> 
   <media:subTitle href="filename or URL">closedCaption.dfxp</media:subTitle> 
  </item> 
 </channel> 
</rss>

XML Manifest Example for Closed Captions (OIS v1) - Simple Example

<rss>
  <channel>
    <item>
      <media:subTitle href="filename or URL">
        <media:hash algo="chosen hash algorithm">hash value</media:hash>
      </media:subTitle>
    </item>
  </channel>
</rss>

XML Manifest Example for Closed Captions (OIS v1) - Longer Example

<rss version="2.0" xmlns:media="http://search.yahoo.com/mrss/"
  xmlns:dcterms="http://purl.org/dc/terms/"
  xmlns:fh="http://purl.org/syndication/history/1.0"
  xmlns:ooyala="http://www.ooyala.com/mrss/">
  <channel>
   <item>
    <media:content url="movie1.mp4">
     <media:hash algo="md5">23ac5a7c88378522f95483e5e9ac44b1</media:hash>
    </media:content>
    <media:title>Movie #1</media:title>
    <media:description>Movie #1 Description</media:description>
    <media:subTitle href="closedCaption.dfxp">
     <media:hash algo="md5">5d42be7f301dad5acf42d565fd651857</media:hash>
    </media:subTitle>
    <link>http://www.ooyala.com/</link>
    <guid isPermaLink="false">c92643a33463910098fa0b9eae7b973c-3</guid>
   </item>
  </channel>
</rss>    

CSV Manifest Formats for Closed Captions Files

To ingest a closed caption file using a CSV Manifest File:
  • The first line of the CSV file must contain a subTitle column heading.
  • Subsequent lines must contain the filename or URL where the closed caption file is located (as applicable).
The following example CSV column headings line includes the subTitle:
video,title,description,hosted_at,labels,thumbnail,subTitle,id
my_video.mp4,My Video Title,This is my video,http://www.ooyala.com,"label1,label2",my_preview.jpg,my_caption.dfxp,my_unique_id

Was this article helpful?