API Method: /api/photo/subtitle/list
Return a list of available subtitles for a video in a given format
Parameters
Parameter | Description |
---|---|
photo_id (required) | The ID of the video to fetch subtitles for. |
token (required) |
The corresponding token for the photo_id. The token may be explicitly time-limited in which case expire becomes a required parameter. |
stripped_p |
Returned a version stripped for additional markup.
Default: 0 Valid values: 0 or 1 |
subtitle_format |
Which format should the returned be in?
Default: websrt Valid values: websrt or json |
Permission level
The minimum required permission level is:
none
For non-public sites, the minimum level is:
anonymous
Example XML Response
<response status="ok" permission_level="anonymous" total_count="0"
cached="1" cache_time="1291206586">
<subtitles locale="en_US"
href="/7340/101353/f2181e8af8f55f306b3ad94087cdeac0/subtitles.en_US.websrt"
default_p="1"/>
<subtitles locale="fi_FI"
href="/7340/101353/f2181e8af8f55f306b3ad94087cdeac0/subtitles.fi_FI.websrt"
default_p="0"/>
<subtitles locale="fr_BE"
href="/7340/101353/f2181e8af8f55f306b3ad94087cdeac0/subtitles.fr_BE.websrt"
default_p="0"/>
</response>
Example JSON Response
{
"status": "ok",
"permission_level":"anonymous",
"cached":"1",
"cache_time":"1291206702",
"subtitles":[
{"locale": "en_US",
"href": "/7340/101353/f2181e8af8f55f306b3ad94087cdeac0/subtitles.en_US.websrt",
"default_p": 1},
{"locale": "fi_FI",
"href": "/7340/101353/f2181e8af8f55f306b3ad94087cdeac0/subtitles.fi_FI.websrt",
"default_p": 0},
{"locale": "fr_BE",
"href": "/7340/101353/f2181e8af8f55f306b3ad94087cdeac0/subtitles.fr_BE.websrt",
"default_p": 0}],
"p": "1",
"size": "1",
"total_count": "0",
"site": { ... },
"endpoint": "/api/photo/subtitle/list"
}