プレイヤーのクエリー文字列パラメータ

すべてのプレイヤークエリー文字列パラメータを一覧にして示します。

一般的なクエリー文字列パラメータ

次の表はクエリー文字列で表示されるパラメータを示しています。

パラメータ 説明
alwaysShowScrubber

主要なコントロールバーとシーク機能を常に表示するにはtrueを指定します。 デフォルトはfalseで、マウスオーバー・コントロールのみを表示します。

autoplay

1に設定すると、ビデオは表示と同時に再生されます。

browserPlacement

チャンネルについては左右どちらに外部コントロールを配置するか指定して下さい。これにはコントロールが占めるパーセンテージ または幅(ピクセル)が含まれます。left40(左で幅の40%)、またはleft200px(左で200ピクセル)と指定します。デフォルトの左または右の値は50%です。

callback コールする関数の名前を指定します。 プレイヤーがクエリー文字列コールバックを 見つけると、ページ上で指定された関数を探し、これをコールします。たとえば、
<script src="http://player.ooyala.com/player.js? ... callback=foofunction"></script>
embedCode

ビデオまたはチャンネルのembedコードを指定します。

hasModuleParams

hasModuleParamsは1に設定してください hasModuleParams=1 パラメータは、setModuleParams関数 (プレイヤーオブジェクトに有効)経由で送られるカスタムデータを待つプレイヤーにシグナルを送ります。 このパラメータを対応するsetModuleParams 関数と併用しカスタムデータをプレイヤーに渡すことが出来ます。hasModuleParamsを使うには、2つのパラメータをembedスクリプトに追加しなければいけません。(hasModuleParamsとコールバック)。 コールバックはあらゆる関数に設定出来ます 指定の時間、すなわち、playerEmbeddedイベントの発動後にsetModuleParams関数 をコールする必要が出てくるため、callback=playerAPICallback をembedスクリプトに追加する必要があります。Javascript を追加して、コールバック関数内でこれらのイベントを監視することが出来ます。playerAPICallbackはお好きな関数と置き換えることが出来ます。 例: embedスクリプトにパラメータを追加したい場合、以下の例のようにembed文字列でhasModuleParams、コールバック、コールバック関数を使用して下さい。

<script src="http://player.ooyala.com/player.js?
 ... hasModuleParams=1&callback=playerAPICallback"></script>

この例は、hasModuleParamsを1に設定します。コールバックはどんな関数でも構いません。ページのどこかに、JavaScriptのコールバック関数を追加する必要があります。詳しくは、setModuleParams関数をご覧ください。

height

ピクセルでプレイヤーの高さを指定します。

hide 特定のプレイヤーの機能性を無効にします。このパラメータでは、コントロールまたはカンマ 区切りリスト(音量のあらゆる組み合わせ、全画面、チャンネル、共有、info、embedまたは終了画面が 含まれる)を無効にするすべての操作が可能です。chromelessレイアウトの場合は、 loadingIndicatorを無効にすることも可能です。
layout chromelessに設定した場合、クロムと開始画面を削除します。指定されていないと、プレイヤーはデフォルトのレイアウトに戻ります。
loop 1に設定されている場合、ビデオが終了すると自動的にリプレイします。
thruParam_<adplatform> これらのパラメータの値は、それぞれの広告サーバーまたはネットワークからのタグです。

プレイヤーロケーションを調節するためのクエリー文字列パラメータ

ウェブページ上に埋め込まれると、プレイヤーはプレイヤー自体の外部DIVによって制御されます。これで、ロケーションの コントロールとプレイヤーの配置をより綿密に制御できるようになります。弊社では、プレイヤー コンテナ、DIV、クラス名、ID、ターゲットロケーションに更なる調整を加えるためのembedコードに任意で追加 出来るクエリー文字列パラメータも提供しています。DOMツリーでは、 内蔵プレイヤーは前もってロードされるのではなく、遅延読み込みで読み込まれます (オブジェクトは最初に アクセスされるまで読み込まれません)。

下の表はプレイヤーの配置を調整するための埋め込み挙動の変更に使用するパラメータについて説明します。
パラメータ 説明
playerContainerId playerContainerIdは、はembedコードスニペットのplayer.jsクエリー文字列パラメータに追加することが出来る任意パラメータです。 このパラメータはプレイヤーをIDベースのDIVに配置します。指定されている場合、document.writeを使用する代わりに、 innerHTMLスワップが指定されたDIVに実行されます。このパラメータはウェブ上に複数のプレイヤーを設置したい場合、あるいは ウェブページでプレイヤーの場所を微調整したい場合に使用します。ウェブサイト上に配置する embedコードスニペットのデフォルトの挙動は、ページの外観とレイアウトに予期せぬ影響を及ぼす可能性があり、 ページのロードにも多少の影響を与えることがあります。playerContainerIdを 使用して、ウェブページでプレイヤーの配置を管理することが出来ます。 このパラメータを 使用するには、あなたのembedに?playerContainerId=...を追加する必要があります。

このパラメータ使用例として、このドキュメントのクエリー文字列パラメータ例の セクション「playerContainerIdクエリー文字列パラメータのサンプル集」をご覧下さい。

playerClassName Flashオブジェクトクラスの外部DIVに割り当てられたクラス名。このパラメータを 使用してプレイヤー外部DIVのデフォルトのクラス名を編集することが出来ます。たとえば、 "alpha" の名前を持つデフォルト外部DIVを別の名前で指定したい場合、class = "alpha delta"と設定する ことが出来ます。 一度名前が変更されると、デフォルトのalphaまたはalpha delta のクラス名のいずれかを使用してクラス別に要素を取得することが出来ます。指定されたどちらの名前を使用しても、プレイヤーに 参照が返されます。

このパラメータの使用例は本書のトピッククエリー文字列パラメータ例の「playerClassName クエリー文字列パラメータのサンプル集」をご覧下さい。

playerId

プレイヤーFlashオブジェクトのDOM ID。

タイプ:文字列、 HTML DOM 仕様に適合していなければいけません。

例: b4f1a93b779145b4a9c8ef15f8502345

このパラメータを使用して、プレイヤーIDの編集を実行することが出来ます。 Backlotで生成された場合、この プレイヤーIDはデフォルトのランダム文字列です。 デフォルトのランダム文字列を使用するか、あるいは playerIdプレイヤーIDを手動で指定することが出来ます。IDを指定する場合、IDと クラスの組み合わせを指定し、ユニークIDにしなければいけません。

playerIdを指定する際、HTML DOM 仕様に適合したIDを使用します。playerIdにスペースやその他の 無作為な特殊文字が含まれていないか確認して下さい。これらの文字がエラーを招く可能性があります。

注:プレイヤーIDを指定する場合、ページ上のユニークIDでなければいけません。プレイヤーIDが ユニークでない場合、挙動は未定義となります。重複するDOM IDに対してより寛大なブラウザもあるため、個々のブラウザ実装によって不明のエラー、Unknown Error: exception例外処理が実行される場合と実行されない場合があります。

このパラメータの使用例は本文書のトピッククエリー文字列パラメータ例 のセクション 「playerIdクエリー文字列パラメータのサンプル集」をご覧下さい。

targetReplaceId IDで指定されたオブジェクトでウェブページのDOMオブジェクトを置き換えます。ウェブページでDOMオブジェクトを指定していて、 DOM IDが有効な場合には、DOMオブジェクトを弊社のプレイヤーと置き換えます。 定義されたDIVを完全に削除し、DIVと同じ場所に挿入された指定Ooyala プレイヤーと置き換えたい場合には、このAPIを使用します。

このパラメーター使用例として、このドキュメントのクエリー文字列パラメータ例のセクション「targetReplaceIdクエリー文字列パラメータのサンプル集」をご覧下さい。

関連情報

以下はプレイヤーに関する一般情報が記載されたBacklotドキュメントのリンク一覧です。

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