ActionScript API概要一覧

は、関数/メソッド、オブジェクト、プロパティ、イベントでグループ化したすべてのプレイヤーActionScript APIを一覧にして説明します。

本書のこのセクションでは、ActionScriptインターフェースを通じてご利用頂けるさまざまな ActionScript API関数、メソッド、プロパティ、イベントのクラスリファレンスをご提供します。

package com.ooyala.api

パブリッククラスのプレイヤーはUIComponentを拡張します。

ActionScriptプロパティ

次の表は OoyalaプレイヤーActionScriptプロパティを示します。プロパティ名は更に詳しい情報が記載されたトピックスにリンクしています。
プロパティ 説明
ActivePanel

各パネルが現在表示されている場合、info、チャンネル、 embed、シンジケーションを返します。

CanRateCurrentItem お使いのコンピュータが現在のアイテムを評価可能かどうかを返します。コンピュータが現在のアイテムを前に評価したことがある場合にはfalseとなります。
CurrentItemAverageRating アイテムの平均評価を返します。
CurrentItemClosedCaptionsLanguages 現在再生中のアイテムでサポートする字幕言語の一覧を取得します。
CurrentItemRatings 現在のアイテムの評価配分を返します。
closedCaptionsLanguage プレイヤーに表示される字幕言語を設定します。
currentItemEmbedCode チャンネルでアクティブなビデオのembedCodeを返します。
currentItemTitle アクティブビデオのタイトルを返します。
description プレイヤーソースの説明を返します。
embedCode プレイヤーのembedCodeを返します。
errorCode 現在の状態にエラーがある場合にエラーコードを返します。
errorText 現在の状態にエラーがある場合には、エラーテキストを返します。
fullscreen プレイヤーが全画面モードになっている場合にはtrue、そうでない場合にはfalseを返します。
item 埋め込みアイテムを説明するオブジェクトを取得します。オブジェクトは、embedCode、title、 description、time(秒単位の再生時間)、lineup、promo、 hostedAtURLを含みます。
lineup 現在のチャンネルを説明するオブジェクトの配列を返します。
playheadTime プレイヘッド位置をミリ秒精度の秒単位で返します。
queryStringParameters オブジェクトのパラメーターを返します。
state 現在のプレイヤーの状態を取得します。再生、一時停止、バッファリング、チャンネル、エラーの内1つ。
title チャンネルがあるならチャンネルのタイトルを、もしくはビデオのタイトルがあるならビデオのタイトルを返します。
totalTime ミリ秒精度の秒単位で現在のビデオの再生時間を返します。
volume 0から1の数で現在のボリュームを返します。

ActionScript関数

次の表はOoyalaプレイヤーActionScriptの関数/メソッドを一覧にして説明します。
関数/メソッド 説明
changeCurrentItem(embedCode) ビデオがある場合、チャンネル内の現在のビデオを設定します。受諾された場合にはtrue、そうでない場合にはfalseを返します。
fetchMetadata(embedCode) 指定されたembedCodeのカスタムメタデータのフェッチを開始します。
fetchRelatedMedia(embedCode)

指定されたembedCodeについて関連メディアのフェッチを開始します。

getTimedText(startTime, endTime) startTimeとendTimeの間に現れるタイムドテキスト(字幕)を返します。
getPromoFor(embedCode, width, height) 少なくとも指定されたディメンションに存在するチャンネル内の指定されたembedコードに対するプロモ画像URLを返します。あるいはチャンネル内にないembedコードについてはnullを返します。
incrementCurrentItemRating(rating) 現在のアイテムの評価を増加させます。評価は0-10の整数で表されます。このコンピュータで以前にこのアイテムを評価したことがある場合、この関数をコールしても効果はありません。
load(), Ooyalaプレイヤーを読み込みます。
loadRatingsApi() レーティングAPIを読み込みます。レーティングAPI関数をコールする前にレーティングAPIがロード されていなければいけません。
pauseMovie() 現在のビデオを一時停止します。
playMovie() 現在のビデオを再生します。

ActionScript イベント

以下はコールバック関数によって送られるイベント通知の一覧とその簡単な説明です。 ブラウザ間の互換性の問題により、標準DHTMLイベントが使用出来なくなることに注意して下さい。
イベント名 説明
activePanelChanged Info、Embed、共有、またはチャンネルパネルが表示または非表示のためのアクティブパネル。
adStarted 広告の再生を開始しました。
adCompleted 広告の再生が終了しました。
adClicked 広告がクリックされました。イベントはVAST広告、Google AFV、DoubleClickや YuMeにのみ発動されます。
apiReady プレイヤーはplayMovie()、getItem()等のAPIコールを受け取る準備が出来ました。APIコールを 発行する前にこのイベントがディスパッチされるのを待ちます。
currentItemEmbedCodeChanged アクティブなビデオのembedCodeが変更されました。
embedCodeChanged プレイヤーのembedコードの変更。
fullscreenChanged 全画面状態がトグルされました。
loadComplete

プレイヤーのロードが完了しました。 これは廃止される予定です。代わりにapiReadyイベントを使用してください。

metadataReady fetchMetadata()コールによってリクエストされたメタデータの準備が出来ました。
playComplete ビデオまたはチャンネルの再生が終了しました。
playheadTimeChanged アクティブビデオの再生時間を更新します。
ratingsApiReady

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

relatedMediaReady fetchRelatedMedia()コールによってリクエストされたrelatedMediaの準備が出来ました。
seeked プレイヤー内でシークイベントが発生しました。
stateChanged プレイヤー状態は再生中、一時停止、バッファリング、エラーの間で遷移します。
totalTimeChanged 現在のビデオの再生時間の変更。
volumeChanged( ) プレイヤーの音量が変更されました。

ActionScriptビットレート選択API

ビットレート選択APIによって、デベロッパーはプログラムを使って現在のバッファサイズを入手し、ビットレートを取得、設定することが出来ます。弊社では、以下の二通りのビットレート選択ワークフローをご提供しています。

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

ActionScript ビットレート選択関数

次の表は、ビットレート選択関数/メソッドを一覧にして説明します。
ビットレートセレクション関数名 説明
bufferLength() バッファの長さをサポートしている場合には、現在のバッファのサイズを秒単位で返します。 そうでない場合には、0を返します。
bitrateQualitiesAvailable() 文字列の配列を返します。
bitratesAvailable ビットレート合計数(kbps)を含む配列、またはエンコーディング数が有効でない場合には空の配列を 返します。
targetBitrateQuality(quality) ターゲットビットレート品質を設定します。
targetBitrateQuality() ターゲットビットレート品質を取得します。auto、low、medium、highのいずれか1つ。
targetBitrate(bitrate) kbpsでターゲットビットレートを設定します。
targetBitrate() ターゲットビットレートが予め設定されている場合にターゲットビットレート品質(kbps)を 取得します。そうでない場合には-1を取得します。

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

次の表は、Ooyalaプレイヤービットレート選択イベントを一覧にして説明します。
ビットレート選択イベント 説明
targetBitrateQualityChanged ターゲットビットレート品質が変更されました。
targetBitrateChanged ターゲットビットレートが変更されました。

ActionScript例

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

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