Subtitle Hero
Read and manipulate subtitles
Install
$ npm install --save subtitle-hero
API
convertSRT(srtFilePaths, stepCallback, finishedCallback)
Name | Type | Description |
---|---|---|
srtFilePaths | Array |
A collection of srt files paths to evaluate |
Returns: Array
, of subtitle Objects.
var SubtitleHero = ; SubtitleHero
convertXml(source, videoTitle, videoId, xml, callback)
Name | Type | Description |
---|---|---|
source | String |
A string representing the source (or formatting type) of the XML |
Returns: Object
, subtitle Object.
var SubtitleHero = ; SubtitleHero
getWordContexts(options, callback)
Name | Type | Description |
---|---|---|
options | Object |
Object that can include the options below |
The available options are:
subtitles
- (subtitle) subtitle objectsexcludeCommonWords
- (boolean) true if you don't want to include common english wordsrequestedWords
- (array) an array of words you want the context forbuffer
- (Number) number that represents the seconds before and after context
var SubtitleHero = ; SubtitleHero
getQuoteContexts(options, callback)
Name | Type | Description |
---|---|---|
options | Object |
Object that can include the options below |
The available options are:
subtitles
- (subtitle) subtitle objectsquotes
- (Array) An array of the quotes you want to search forbuffer
- (Number) number that represents the seconds before and after context
var SubtitleHero = ; SubtitleHero
Data Structures
Subtitle
title: String // "Donald Trump Interview" source: String // "youtube" id: String // "tOAY8waCglg" parts: Part
Part
text: String // "considered competitive in the the election" start: Number // 19.89 duration: Number // 5.69
Context
word: String // "ambiguous" source: Number // "youtube" mediaId: Number // "DH5Dgc" start: Number // 345 duration: Number // 8