JavaScript API概要一覧

関数/メソッド、オブジェクト、プロパティ、イベント別にグループ化されたプレイヤーJavaScript API一覧とその説明。

下の表はプロパティ、関数、イベント、クエリー文字列パススルー・パラメータ別に分類されたJavaScript APIの概要一覧です。各プロパティは 詳細が記載されたトピックスにリンクしています。また、このトピックはJavaScriptインターフェースを通じて利用が可能な様々なJavaScript API関数、メソッド、プロパティ、イベント、クエリー文字列パススルー・パラメータのクラスリファレンスを構成しています。 別のトピックは、JavaScript API関数の能力を表示するライブサンプルへのリンクと共にコード例を 一覧にしています。JavaScript APIを有効にするには、JavaScriptembedスニペットでいくつかのパラメータを提供する必要があります。
  • callback— イベント通知コールバックを受け取るJavaScript関数名。 この関数は以下の3つのパラメータで宣言しなければいけません。
  • playerId (String)- コールバックを呼び出すプレイヤーID
  • eventName (String)— 通知の名前
  • parameters (Object) – 追加通知パラメーター
例:
<script
 src="player.ooyala.com/player.js?callback=receiveOoyalaEvent&playerId=player&width=480&
height=360&embedCode=llMDQ6rMWxVWbvdxs2yduVEtSrNCJUk1"></script>

<script>
 

function receiveOoyalaEvent(playerId, eventName, eventParams) {
...
}
</script>           

JavaScript プロパティ

プロパティ 説明
getActivePanel 各パネルが表示中の場合、info、チャンネル、embed、シンジケーションを返します。パネルが表示されていない場合は空の文字列を返します。
getCanRateCurrentItem ユーザーが現在のアイテムに評価を割り当てることが出来るかどうかを返します。
getCurrentItem 現在のビデオを説明するオブジェクトを取得します。
getCurrentItemAverageRating

アイテムに与えられた平均評価を取得します。

getCurrentItemClosedCaptionsLanguages 現在再生中のアイテムの対応字幕言語の一覧を取得します。
getCurrentItemDescription 現在のビデオの説明を取得します。
getCurrentItemEmbedCode/ setCurrentItemEmbedCode チャンネルで現在のビデオのembedCodeを取得/設定します。
getCurrentItemRatings 現在のアイテムの評価分布を取得します。
getCurrentItemTitle 現在のビデオのタイトルを取得します。
getDescription プレイヤーソースの説明を取得します。
getEmbedCode/setEmbedCode 現在のプレイヤーのembedコードを取得/設定します。
getErrorCode 存在する場合には現在のエラーコードを取得します。
getErrorText 存在する場合には現在のエラーテキストを取得します。
getFullscreen 全画面モードの場合にはtrue 、そうでない場合にはfalseを返します。
getItem 埋め込みアイテムを説明するオブジェクトを取得します。
getLineup 現在のチャンネルを説明するオブジェクトの配列を取得します。
getPlayheadTime/setPlayheadTime プレイヘッドの場所を特定するか、プレイヘッドをミリ秒精度の秒単位で新しい場所に移動します。
getState 現在のプレイヤーの状態を取得します。再生中、一時停止、バッファリング、チャンネル、エラーの内1つ。
getTitle 現在のチャンネル(チャンネルがなければビデオ)のタイトルを取得します。
getTotalTime アクティブなビデオの長さを取得します(ミリ秒精度の秒単位)。
getVolume/setVolume

現在の音量を取得/設定します(0から1の数字)。

setModuleParams プレイヤーがモジュールをロードする時、コールバック関数を使用して embedコードのクエリー文字列パラメータを設定します。 この関数はhasModuleParamsクエリー文字列パラメータと一緒に使用します。
setQueryStringParameters 現在のプレイヤーのクエリー文字列パラメータを設定します。
setClosedCaptionsLanguage

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

JavaScript関数

関数 説明
changeCurrentItem(embedCode) ビデオがある場合、チャンネル内の現在のビデオを設定します。受諾された場合にはtrue、そうでない場合にはfalseを返します。
fetchMetadata(embedCode) 指定されたembedCodeのカスタムメタデータのフェッチを開始します。このAPIはプロフェッショナルアカウント及びエンタープライズアカウントでご利用可能です。
fetchRelatedMedia(embedCode, options) 指定されたembedCodeについて関連メディアのフェッチを開始します。
getTimedText(startTime, endTime) startTimeとendTimeの間に現れるタイムドテキスト(字幕と字幕初期設定)を返します (秒単位で指定)。
getPromoFor(embedCode, width, height)

少なくとも指定されたディメンションに存在するチャンネル内の指定されたembedコードに対するプロモ画像URLを返します。あるいはチャンネル内にないembedコードについてはnullを返します。

incrementCurrentItemRating(rating) 現在のアイテムの評価を増加させます。
loadRatingsApi() レーティングAPIを読み込みます。
pauseMovie() 現在のビデオを一時停止します。
playMovie() 現在のビデオを再生します。
skipAd() 現在の広告をスキップします。

JavaScriptスキップ

コールバック関数に送られるイベント通知。ブラウザ間の互換性の問題により、標準DHTMLイベントが使用出来なくなることに注意して下さい。
イベント コールバックに対する第3引数のパラメータ 説明
activePanelChanged activePanel. Info、Embed、共有、またはチャンネルパネルが表示または非表示。
adCompleted( ) 形式、ソース、タイプ。 広告の再生が終了しました。
adClicked( ) 形式、ソース、タイプ。 広告がクリックされました。
apiReady( )   プレイヤーが、layMovie()、getItem()などのAPIリクエストを受け取れる状態です。
companionAdsReady( ) タイプ、コンパニオン広告。 1つ以上のコンパニオン広告が表示できます。VAST準拠広告にのみ適用可能です。
currentItemEmbedCodeChanged( ) description, embedCode, hostedAtURL, lineup, promo, time (秒単位), title 現在のアイテムを変更しました。
embedCodeChanged( ) description, embedCode, hostedAtURL, lineup, promo. トップレベルのプレイヤーアイテムが変更されました。
fullscreenChanged( ) 形式、ソース、タイプ。 全画面状態がトグルされました。
loadComplete( )   プレイヤーが初期化されました。
metadataReady ( ) メタデータ

広告の再生を開始しました。

playComplete( )   ビデオまたはチャンネルが終了しました。
playheadTimeChanged( ) playheadTime. プレイヘッドを移動しました。
playerEmbedded   プレイヤーがウェブページに埋め込まれました。このイベントを使用してコールバックをトリガすることが出来ます。
ratingsApiReady( )  

レーティングAPIが読み込まれ、使える状態になりました。

relatedMediaReady( ) relatedMedia. fetchRelatedMedia()コールによってリクエストされた関連メディアの準備が出来ました。
seeked( ) newPlayheadTime, oldPlayheadTime. プレイヤー内でシークイベントが発生しました。
stateChanged( ) relatedMedia. 状態が変わりました。
totalTimeChanged( ) totalTime. アイテムの合計時間が変更されました。
volumeChanged( ) 音量。 音量が変更されました。

JavaScript ビットレート選択API

ビットレートを選択するには、次のオプションのどちらかを使ってください。
  • 品質ベースのビットレートを選択(auto、low、medium、high)。たとえば、ビットレート品質をhighに設定すると、プレイヤーは利用可能な最高のエンコーディングを決定します。
  • kbps数ベースのビットレートを選択(オーディオ及びビデオ両方のエンコーディング合計)。たとえば、次のビットレートをビデオに使用できるとします。[600 kbps, 1000 kbps, 3000 kbps, 4000 kbps]。この値のいずれかをビットレート品質として設定できます。

JavaScriptビットレート選択関数

下の表はビットレートとバッファに関連付けられるすべての JavaScriptメソッド(オブジェクトによって呼び出す関数)について説明します。

関数 説明
getBitrateQualitiesAvailable()

文字列の配列を返します。

getTargetBitrateQuality() ターゲットビットレート品質を取得します。auto、low、medium、highのいずれか1つ。
setTargetBitrate(bitrate) kbpsでターゲットビットレートを設定します。
getBitratesAvailable() ビットレート合計数(kbps)を含む配列、またはエンコーディング数が有効でない場合には空の配列を返します。
getTargetBitrate() ターゲットビットレートがあらかじめ設定されている場合にターゲットビットレート品質(kbps)を取得します。そうでない場合には-1を取得します。
getBufferLength() バッファの長さをサポートしている場合には、現在のバッファのサイズを秒単位で返すか、あるいは0を返します。
setTargetBitrateQuality(quality) ターゲットビットレート品質を設定します。

JavaScript ビットレート選択イベント

下の表はビットレートと関連付けられたすべてのActionScriptイベントを説明しています。
関数 説明
changeCurrentItem(embedCode)

ターゲットビットレート品質が変更されました。

targetBitrateQualityChanged ターゲットビットレート品質が変更されました。

JavaScript例

利用できるクエリー文字列パススルー・パラメータ例を一覧にしています。リンクをクリックしてサンプルをご覧ください。

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