字幕一覧取得APIを利用することで、
指定された動画IDに登録されている字幕の情報を取得することが出来ます。
■API呼び出しURL
http(s)://api01-platform.stream.co.jp/apiservice/getSubtitleList/?token=xxxx&各パラメータ
■パラメータ
| 項目名 | 必須 | 説明 | フォーマット | デフォルト値 |
| token | ○ | アカウント（CID）毎に 発行されたトークン |
文字列 | 無し |
| mid | ○ |
動画ID |
半角数字 | 無し |
| type | --- | 返却形式のタイプを指定 「jsonp」「json」が指定可能 |
文字列 | jsonp |
| callback | --- | JSONPコールバック関数名 ※jsonp時のみ有効 |
文字列 | searchResultEq |
■レスポンス
| 項目名 | JSON要素 | 説明 | 備考 | |
| コールバック |
searchResultEq |
JSONPコールバック関数名 |
||
| レスポンスステータス | response_status | APIレスポンスステータス | ||
| 字幕数 |
subtitle_sum |
字幕の登録数 | ||
| 字幕情報 |
subtitle |
字幕の情報 | ||
| 動画ID |
subtitle |
mid |
動画に付与される識別ID | |
| 字幕ID |
stid |
字幕に付与される識別ID |
||
|
言語 |
lang_text |
字幕の言語 |
||
| ラベル |
lang_label |
字幕のラベル |
||
| 言語コード |
lang_code |
字幕の言語コード |
||
| 言語ファイルのURL |
filepath |
字幕ファイルのURL |
||
| 表示順序 |
order |
字幕の表示順序 |
||
| デフォルト |
default |
デフォルト表示の設定有無 |
true：デフォルト | |
■レスポンス例：正常時
|
searchResultEq ( { "response_status": "2000", "subtitle_sum": 1, "subtitle": [ { "mid": 1, "stid": 0, "lang_text": null, "lang_label": "off", "lang_code": null, "filepath": null, "order": 1, default": true }, { "mid": 1, "stid": 2, lang_text": "英語", "lang_label": "English", lang_code": "en", "filepath": "https://～/～.vtt", "order": 2, default": false } ] }); |
■レスポンス例：エラー時
|
searchResultEq({ response_status": "1004", "subtitle_sum": 0, "subtitle": null }); |