アセットJavaScript API

アセットJavaScript APIは評価、ビデオ(再生/一時中止、説明)、チャンネルの処理に使用することが出来ます。

アセットのプロパティ

次の表はアセットに関連付けられたすべてのJavaScriptプロパティを説明しています。

プロパティ 説明
getLineup

現在のチャンネルを説明するオブジェクトの配列を取得します。

タイプ:配列

戻し値:チャンネル説明

getTitle

現在のチャンネル(チャンネルがなければビデオ)のタイトルを取得します。

タイプ:文字列

戻り値:channel title | video title

例:My Snowboarding Channel

getCanRateCurrentItem

ユーザーが現在のアイテムに対して評価を割り当てることが可能な場合にtrueを返します。ユーザーが以前に使用中のデバイスをアイテムの評価に使用した場合にはfalseを返します。

タイプ:ブーリアン

値:true | false

getCurrentItem

現在のビデオを説明するオブジェクトを取得します。 返されるオブジェクトにはembedCode、title、description、time (秒単位の再生時間)、lineup、promo、hostedAtURLが含まれます。

タイプ:オブジェクト

戻り値:アイテム説明

getCurrentItemAverageRating

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

タイプ:整数

値:平均数値

例:与えられた評価 (1, 7, 14, 0, 2, 22, 6, 0)、6.5を返す

getCurrentItemDescription

現在のビデオの説明を取得します。

タイプ:文字列

戻し値:現在のアセットを説明するテキスト

例:"snowboarding competition"

getCurrentItemRatings

現在のアイテムの評価分布を取得します。各整数が幾つかの評価がアイテムに対して与えられた回数を表わす整数配列を返します。

タイプ:整数配列

例:[0, 16, 0, 0, 0, 0, 0, 0, 25, 0, 0] はアイテムに対して"1"が16票、"8"が25票、投票されたことを示しています。

getCurrentItemTitle

現在のビデオのタイトルを取得します。

タイプ:文字列

戻り値:英数字

例:"X Games"

getTotalTime

アクティブビデオの長さを秒単位で取得します。

タイプ:整数

戻り値: (ミリ秒精度の秒)

例:5400

アセット関数

次の表はアセットに関連付けられたすべてのJavaScriptを示します。

関数 説明
incrementCurrentItemRating(rating)

現在のアイテムの評価を増加させます。評価は0-10の整数で表されます。 このコンピュータで以前にこのアイテムを評価したことがある場合、この関数をコールしても効果はありません。

タイプ:整数

戻り値:0-10までの整数

loadRatingsApi() レーティングAPIを読み込みます。レーティングAPIは、incrementCurrentItemRating()getCanRateCurrentItem()等のレーティングAPI関数をコールする前にロードされなければいけません。APIが使用可能になると、ratingsApiReadyイベントがディスパッチされます。
pauseMovie() 現在のビデオを一時停止します。
playMovie()

現在のビデオを再生します。

関連情報

以下はプレイヤーアセットに関連するOoyala Backlot参考資料のリンク一覧です。

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