アセットActionScript API

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

Ooyalaにビデオをアップロードすると、 Ooyalaはお客様のアカウントに合わせた設定を用いて、自動的にビデオをトランスコードし、プレイヤーを通じて再生可能な形式にします。 Ooyalaへビデオをアップロードする際にはH.264形式を推奨しますが、その他一般的に使用されているコーデック (MPEG-1, MPEG-2, MPEG-4, VP6, H.264, H.263, WMV/WMAおよびMJPEG)にも対応しています。以下のAPIを使用 すると、コンピュータによるアセットの評価管理や、タイトルや再生時間等のビデオに関する情報収集等、 ビデオまたはオーディオアセットのアスペクトの制御が可能になります。

アセットのプロパティ

次の表はアセットと関連付けることが出来るすべてのActionScriptプロパティを示しています。

プロパティ 説明
canRateCurrentItem

お使いのコンピュータが現在のアイテムを評価出来るかどうかを設定します。 コンピュータが 現在のアイテムを前に評価したことがある場合にはfalseとなります。

タイプ:ブーリアン

戻り値: true | false

currentItemAverageRating

アイテムの平均評価を返します。

タイプ:整数

戻り値: 平均数

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

currentItemRatings

現在のアイテムの評価配分を返します。

タイプ:整数

戻し値:各整数が幾つかの評価がアイテムに対して与えられた回数を表わす整数配列。

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

currentItemTitle

アクティブビデオのタイトルを返します。

バインド可能

形式:読み取り専用

タイプ:文字列

戻り値:ビデオのタイトルを表わす英数字の文字列

例:"Into the Void"

item

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

バインド可能

形式:読み取り専用

タイプ:オブジェクト

lineup

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

バインド可能

形式:読み取り専用

タイプ:配列

title

チャンネルまたは、チャンネルが指定されていない場合にはビデオのタイトルを取得します。

バインド可能

形式:読み取り専用。

タイプ:文字列

戻り値: 英数文字の文字列

例:"X Games"

totalTime

アクティブビデオの長さ(ミリ秒精度の秒単位)を取得します。

バインド可能

形式:読み取り専用。

タイプ:整数

例:5400

説明

プレイヤーソースの説明を返します。通常、これはBacklotでビデオかオーディオアセットに入力された説明です。このAPIは、Backlotの管理>詳細タブかそれに相当する手動設定で設定された入力値を取得できるようになります。

バインド可能

形式:読み取り専用

タイプ:文字列

戻り値:英数字のアセットの説明

例:"Season 22 Opening Game"

アセット関数

次の表は、アセットに関連付けられたアクションスクリプトメソッドを表します。

関数 説明
incrementCurrentItemRating(rating)

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

タイプ:整数

パラメーター:評価

戻り値:0-10の整数

loadRatingsApi() レーティングAPIを読み込みます。レーティングAPIは、 incrementCurrentItemRating()getCanRateCurrentItem()のようなレーティングAPI関数をコールする前に読み込む必要があります。APIが使用可能になると、ratingsApiReadyイベントがディスパッチされます。
pauseMovie() 現在のビデオを一時停止します。
playMovie()

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

関連情報

以下はアセットに関する一般情報が記載されたBacklotドキュメントのリンク一覧です。

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