Spaces:
Paused
Paused
File size: 2,077 Bytes
95f4e64 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
## defineSubtitlesHandler
This method handles subtitle requests.
### Arguments:
`args` - request object; parameters defined below
### Returns:
A promise resolving to an object containing `{ subtitles: [] }` with an array of [Subtitle Objects](../responses/subtitles.md).
The resolving object can also include the following cache related properties:
- `{ cacheMaxAge: int }` (in seconds) which sets the `Cache-Control` header to `max-age=$cacheMaxAge` and overwrites the global cache time set in `serveHTTP` [options](../../README.md#servehttpaddoninterface-options)
- `{ staleRevalidate: int }` (in seconds) which sets the `Cache-Control` header to `stale-while-revalidate=$staleRevalidate`
- `{ staleError: int }` (in seconds) which sets the `Cache-Control` header to `stale-if-error=$staleError`
## Request Parameters
``type`` - type of the item that we're requesting subtitles for; e.g. `movie`, `series`, `channel`, `tv` (see [Content Types](../responses/content.types.md))
``id`` - string id of the video that we're requesting subtitles for (videoId); see [Meta Object](../responses/meta.md)
``extra`` - object that holds additional properties; parameters defined below
``config`` - object with user settings, see [Manifest - User Data](../responses/manifest.md#user-data)
## Extra Parameters
``videoHash`` - string [OpenSubtitles file hash](http://trac.opensubtitles.org/projects/opensubtitles/wiki/HashSourceCodes) for the video
``videoSize`` - size of the video file in bytes
``filename`` - filename of the video file
## Basic Example
```javascript
builder.defineSubtitlesHandler(function(args) {
if (args.id === 'tt1254207') {
// serve one subtitle for big buck bunny
const subtitle = {
url: 'https://mkvtoolnix.download/samples/vsshort-en.srt',
lang: 'eng'
}
return Promise.resolve({ subtitles: [subtitle] })
} else {
// otherwise return no subtitles
return Promise.resolve({ subtitles: [] })
}
})
```
[Subtitle Object Definition](../responses/subtitles.md)
|