プレーヤの構成パラメータ

Product
Video Cloud
対象となる役割
パブリッシャ
バージョン
Brightcove 5
モジュール
Publishing モジュール
エディション
すべて

Video Cloud プレーヤのパブリッシング コードを編集して、プレーヤのさまざまな動作の構成を行うことができます。このリファレンス トピックでは、Video Cloud でサポートされるプレーヤ構成パラメータを示し、JavaScript、ActionScript、および HTML 埋め込みコードでプレーヤ構成パラメータを指定するために使用される様々な構文を示します。

プレーヤのパラメータを構成すると、2 つの別の場所で、同じプレーヤのインスタンスに異なる動作をさせる必要がある場合にも役立ちます。

このトピックでは、次の点について学習します。

JavaScript、ActionScript、および HTML 埋め込みコードでのプレーヤ構成パラメータの構文

構成パラメータの名前は、どのタイプのパブリッシング コードを使用しても同じですが、JavaScript、ActionScript、および HTML 埋め込みコードで構文が異なります。このことについてはプレーヤ パブリッシング コードをご覧ください。

JavaScript パブリッシング コードの構成パラメータ

JavaScript を使用する場合は、プレーヤ パブリッシング コードの <object> タグの間に構成パラメータを入れます。JavaScript のプレーヤ構成パラメータは以下の形式になります。

<param name="param_name" value="param_value" />

ActionScript パブリッシング コードの構成パラメータ

ActionScript を使用する場合は、プレーヤ パブリッシング コードの init 関数に構成パラメータを入れます。ActionScript のプレーヤ構成パラメータは以下の形式になります。

config["param_name"] = "param_value";

埋め込みパブリッシング コードの構成パラメータ

HTML embed コードを使用する場合は、プレーヤ パブリッシング コードの flashVars パラメータに構成パラメータを入れます。HTML embed コード プレーヤの構成パラメータは以下の形式になります。

<param name="flashVars" value="playerID=13578640001&domain=embed
             &param_name1=param_value1&param_name2=param_value2" />

サポート対象のプレーヤ構成パラメータ

以下の表は、Video Cloud でサポートされているプレーヤ構成パラメータの一覧です。これらのパラメータ名はすべて、大文字と小文字が区別されます。また、Video Cloud ActionScript 2 プレーヤで使用していた構成パラメータ(Brightcove コンソールを使用して作成、または Brightcove 3 以前に作成した場合)は、Brightcove の ActionScript 3 プレーヤでは動作しないことがあります。

パラメータ タイプ 説明
@videoPlayer 文字列 プレーヤにプログラムする動画の ID または refid。「パラメータを指定してコンテンツをプレーヤに割り当てる」を参照してください。
@playlistTabs 文字列 プレイリストの選択にタブを使用するプレーヤをプログラムする 1 つまたは複数のプレイリストの ID または refid。「パラメータを指定してコンテンツをプレーヤに割り当てる」を参照してください。
@playlistCombo 文字列 プレイリストの選択にコンボボックス(ドロップダウン)を使用するプレーヤをプログラムする 1 つまたは複数のプレイリストの ID または refid。「パラメータを指定してコンテンツをプレーヤに割り当てる」を参照してください。
@videoList 文字列 プレーヤにプログラムするプレイリストの ID または refid。「優先コンテンツを指定する」を参照してください。
width プレーヤの合計幅(ピクセル単位)
height プレーヤの合計高さ(ピクセル単位)
autoStart ブール値 true にすると、プレーヤがロードされるとすぐに動画が開始されます。
bgcolor 文字列 プレーヤの背景色の 6 桁 16 進数表記。たとえば、bgcolor = "#FFFFFF;"(デフォルト)は、白を表します。このパラメータを省略すると、ロードが完了するまで、プレーヤには白い背景が表示されます。そのような状態は望ましくないかもしれません。プレーヤがロードするページの色に背景色を一致させるのも 1 つの方法です。
dynamicStreaming ブール値 true(デフォルト設定)にすると、Flash Media Server 3.5 および Flash Player 10 のスムーズ ストリーミング機能が使用できます。「ダイナミック ストリーミング」を参照してください。
includeAPI ブール値 スマート プレーヤ API をこのプレーヤと使用するには true にする必要があります。
isUI ブール値 ChromelessVideoPlayer または VideoDisplay および MediaControls コンポーネントなど、VideoPlayer コンポーネント以外の UI 要素を含むテンプレートの動画プレーヤでは、true にする必要があります。
isVid ブール値 すべての動画プレーヤで true にする必要があります。
labels 文字列 このプレーヤに使用するラベル設定について記述する XML ファイルの URL。ラベル設定ファイルの作成方法は、「プレーヤをローカライズする」を参照してください。
language 列挙 デフォルトのプレーヤ ラベルに使用する言語。en(英語)、fr(フランス語)、de(ドイツ語)、it(イタリア語)、jp(日本語)、または es(スペイン語)のいずれか。この値は、Video Cloud Studio の Publishing モジュールでプレーヤに設定した言語設定よりも優先されます。
linkBaseURL 文字列 視聴者がプレーヤの「共有」、「リンクを取得」、または「メール」ボタンをクリックするときに使用される、ベース URL。デフォルトの linkBaseURL より優先され、プレーヤの親ページへリンクすることが可能になります。「リンク URL をカスタマイズする」を参照してください。
localizedErrorXML 文字列 プレーヤのエラー メッセージ ファイルの URL。この XML ファイルでは、プレーヤのエラー時に表示するメッセージを指定します。「プレーヤのエラー メッセージをローカライズする」を参照してください。
majorVersion 文字列 必要とされる Flash のメジャー バージョン番号。デフォルトでは、Video Cloud プレーヤには Flash バージョン 9.0.28 以降が必要です。Flash 10 が必要な場合には、このパラメータを <param name="majorVersion" value="10" /> のように設定します。
minorRevision 文字列 必要とされる Flash 9 のマイナ リビジョン番号。デフォルトでは、Video Cloud プレーヤには Flash バージョン 9.0.28 以降が必要です。Flash 9 バージョン以降が必要な場合には、パラメータを <param name="minorRevision" value="115" /> のように設定します。
playerId プレーヤ ID。このパラメータに代わって、playerKey パラメータが使用されつつあります。どのプレーヤをページにロードするかを変更したい場合、playerId パラメータと playerKey パラメータの両方の値を変更する必要があります。
playerKey 文字列 プレーヤ ID の暗号化された表現を含む、プレーヤの一意の識別子
secureConnections ブール値 true にすると、HTTPS を使用するページに公開されたプレーヤにセキュリティ警告が表示されません。これは、セキュリティ警告を表示させないだけであることに注意してください。プレーヤは HTTPS を使用できません。また、この設定は HTTPS ページでのみ使用します。HTTP ページで使用するとエラーが発生する場合があります。この設定は、JavaScript パブリッシング コードの場合にのみ有効です。詳細は、「HTTPS ページでの Video Cloud プレーヤの公開」を参照してください。
skipContentCall ブール値 true にすると、コンテンツ取得に Flash 専用プレーヤ API を使用している場合に、コンテンツ呼び出しが行われないようにします。
showNoContentMessage ブール値 true にすると、プレーヤにコンテンツが割り当てられていない場合に、警告メッセージを表示します。
templateErrorHandler 文字列 プレーヤ エラー イベントに応じて自動的に呼び出されるユーザー定義の JavaScript 関数の名前
templateLoadHandler 文字列 プレーヤがロードされると自動的に呼び出されるユーザー定義の JavaScript 関数の名前。これは、スマート プレーヤ API のエントリ ポイントを提供します。
templateReadyHandler 文字列 player ready イベントによって自動的に呼び出されるユーザー定義の JavaScript 関数の名前。
videoSmoothing ブール値 プレーヤに設定されたデフォルトの動画スムージング動作を無効にします。true(デフォルト値)にすると動画スムージングが必ず適用され、false にすると動画スムージングが適用されません。設定が存在しない場合、プレーヤは動画スムージング動作を使用します。

広告要求プレーヤ構成パラメータ

さらに、以下のプレーヤ構成パラメータで、プレーヤの広告要求動作を操作できます。これらについての詳細は、「広告操作用のプレーヤ構成パラメータ」を参照してください。プレーヤの広告要求動作用のプレーヤ構成パラメータには、以下が含まれます。

  • additionalAdTargetingParams
  • adServerURL
  • overrideAds
  • externalAds
  • playlistTargeting

 

タグ
構成パラメータ, パブリッシング コード