ウィジェット関数

このセクションはアップロードウィジェットの関数を一覧にしています。

onOoyalaUploaderReady() ウィジェットが使用可能になるとコールされるため、必ずonOoyalaUploaderReady   の名前で関数を実装してください。 APIリクエストを発行する 前に、この関数がコールされるのをお待ちください。パラメーターを設定して、この関数に イベントリスナーを追加するようにしてください。 setParameters(String)

アカウント情報(pcode)を含むパラメータを指定して、署名生成指示に従ってパラメータを署名してください。出来上がった文字列をsetParametersに渡してください。

パラメーターの設定には、次を使用してください。

ooyalaUploader.setParameters('<paramstring>')

Note: setParameters() はアップロード開始前に呼び出す必要がありますが、addDynamicLabelまたはsetTitle/setDescription後に呼び出しても構いません。
addEventListener(String,String)

多くの場合、イベント発生時に通知を受け取ることをお望みだと思います。現在のところ、APIはイベントごとに1つのリスナーしかサポートしていません。addEventListenerへその後コールすることで、以前のハンドラーの割り当てをオーバーライドします。

イベントリスナーの登録には、以下を使用します。

ooyalaUploader.addEventListener('<event name>', '<event handler name>')

Note: 関数名は文字列で渡す必要があります。関数リファレンスではありません。

例:

IOエラーイベントにリスナーを登録する場合。

ooyalaUploader.addEventListener('error', 'onUploaderIOError');

setTitle(String)とsetDescription(String)

ユーザーが入力したタイトルと説明を個々に渡します。

タイトルを割り当てるには、以下を使用します。

ooyalaUploader.setTitle('<title>');

説明を割り当てるには、以下を使用します。

ooyalaUploader.setDescription('<description>');

Note: タイトルを指定する必要がありますが、説明は空欄にしても構いません。
addDynamicLabel(String)

ダイナミック(ユーザー生成)ラベルをコンテンツへ追加します。ラベルは、少なくともsetParameters()の署名済み文字列のdynamic[<id>]パラメータで指定された1つの正規表現に一致していなければいけません。

ユーザーが生成したラベルをアップロードされたビデオに追加するには、以下を使用します。

ooyalaUploader.addDynamicLabel('<labelname>');

Note: 検証処理はサーバーで実行されるので、パートナーは まずラベルを追加し、その後、ラベルに一致する署名済み パラメータ文字列を提供することができます。
validate()

アップローダーウィジェットがファイルのアップロードができる状態であるか確認します。これは、 アップローダーが使える状態ならnullを返し、必須条件が満たされて いない場合はエラー文字列を返します(ファイルが選択されていない、 タイトルが指定されていない、ファイルが大きすぎる、など)

アップロードを検証するには、以下を使用します。

ooyalaUploader.validate();

upload()

ファイルのアップロードを開始します。アップロードが開始していたらtrueを返し、そうでなければfalseを返します。その後のイベントで、validate()を使用して、falseが返ってきた理由を取得してください。

アップロードを開始するには、以下を使用します。

ooyalaUploader.upload();

Note: 1度に1つのアップロードしか作動させることはできないので、もし複数のアップロードを開始すると、upload()falseを返し、validate()nullを返します。

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