字幕JavaScript API

字幕JavaScript APIを使用すると対応字幕、字幕言語の設定、字幕のタイミングの設定が可能です。

字幕プロパティ

次の表は字幕に関連付けられたすべてのJavaScriptプロパティを示します。

プロパティ 説明
getCurrentItemClosedCaptionsLanguages

現在再生中のアイテムの対応字幕言語の一覧を取得します。 この 一覧はBacklot経由でアップロードされたこのコンテンツの字幕XMLファイルから導き出されます。このようなファイルがない場合、このメソッドは空のリストを返します。

タイプ:一覧

戻り値:"language code"形式のリスト"displayName"

例:{ "en":"English",...}.

: このメソッドは、現在のembedコードに対する字幕ファイルがアップロードされなかった場合、例外処理を実行します。

setClosedCaptionsLanguage

プレイヤーで表示される字幕言語を設定します。

パラメータ: language

有効値:言語コードISO 639-1に指定 | なし。中国語については、簡体中国語には"zh-hans" 、繁体中国語には"zh-hant"を使ってください。 字幕を表示しない場合、languageを"none"と設定してください。

例: en, de, ja.

例外:このメソッドは、現在のembedコードに対する字幕ファイルがアップロードされなかった場合、例外処理を実行します。

字幕関数

次の表は、字幕に関連付けられたすべてのJavaScript関数を示します。

関数 説明
getTimedText(startTime, endTime)

startTimeendTimeの間にに現れるタイムドテキスト(字幕及び字幕書書式設定情報)を返します。

タイプ:文字列

戻り値:英数文字の字幕と字幕情報。

有効値:秒単位で startTimeendTimeを指定。

関連情報

以下は字幕に関する一般情報が記載されたBacklotドキュメンテーションのリンク一覧です。

この記事はお役にたちましたか?