Ingesting Closed Caption Files

You can ingest closed caption files via Backlot or the Ooyala Ingestion Service (OIS).

Note: This topic applies to both OIS v2.5 and OIS v1. Certain sections, where indicated, apply to just one version. OIS v1 has been deprecated and is scheduled to be disabled. Customers using OIS v1 should switch to OIS v2.5.

Supported Formats for Closed Caption Files (OIS Ingestion)

You can upload closed caption files that use any of the following file formats.
Extension Description
.TTML (formerly DXFP) TTML (Timed Text Markup Language file. Generally, a closed caption file will have a .dfxp (Distribution Format Exchange Profile) extension. For details, see DFXP (now TTML) Format for Closed Captions.
.SCC SCC (Scenarist Closed Caption) file. (OIS v2.5 only)
.SRT WebSRT (Web Subtitle Resource Tracks) file. (OIS v2.5 only)
.VTT WebVTT (Web Video Text Tracks) file. (OIS v2.5 only).

XML Manifest Formats for Closed Caption Files

Use the following elements and attributes in the XML Manifest File.
XML Tag Description
<media:subTitle> Specifies a closed caption file (supported for DFXP files only). See Ingesting Closed Caption Files. Attributes:
  • href (required) - One of the following:
    • Filename of the closed caption file you uploaded. Example: caption-1.dfxp
    • URL where the closed caption file is located. The URL can include http:// or https://. Example: http://ooyala.com/captions/caption-1.dfxp
    lang (optional) - language of the closed caption file. Two-letter code. See Closed Captions - Supported Languages.
  • frameRate (optional) - Frame rate of the closed caption file. Units are in Frames Per Second (FPS). Default is 30. Older closed caption files might be 24.
Note: If specified, it is the customer’s responsibility to provide valid values for lang and frameRate. Valid values are added to the DFXP file. Non-compliant values are ignored. Either way, the closed caption file is added into Backlot and linked to the asset.
<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 lang="jp" frameRate="24"</media:subTitle> 
  </item> 
 </channel> 
</rss>

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

Note: OIS v1 has been deprecated and is scheduled to be disabled. Customers using OIS v1 should switch to OIS v2.5.
<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 (Deprecated)

Note: OIS v1 has been deprecated and is scheduled to be disabled. Customers using OIS v1 should switch to OIS v2.5.
<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 Caption Files

Use the following column headings for ingesting closed caption files via a CSV Manifest File:
Column Heading Description
subTitle Specifies a closed caption file (supported for DFXP files only). 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"/>
See Ingesting Closed Caption Files.
subTitle:lang (optional) - Language of the closed caption file. Two-letter language code. For valid values, see Closed Captions - Supported Languages.
subTitle:frameRate (optional) - Frame rate of the closed caption file. Units are in Frames Per Second (FPS). Default is 30. Older closed caption files might be 24.
In the CSV file:
  • The first line of the CSV file must contain a subTitle column heading. Optionally, specify subTitle:lang and / or subTitle:frameRate.
  • Subsequent lines must contain the corresponding data: filename or URL where the closed caption file is located (as applicable), language code (optional), and frameRate (optional).
Note: If specified, it is the customer’s responsibility to provide valid values for subTitle:lang and subTitle:frameRate. Valid values are added to the DFXP file. Non-compliant values are ignored. Either way, the closed caption file is added into Backlot and linked to the asset.
The following example CSV column headings line includes all three column headings:
video,title,description,hosted_at,labels,thumbnail,subTitle,subTitle:lang,subTitle:frameRate,id
my_video.mp4,My Video Title,This is my video,http://www.ooyala.com,"label1,label2",my_preview.jpg,my_caption.dfxp,en,24,,my_unique_id

해당 내용이 도움 되었습니까?