プレイヤーAPIパラメータ

プレイヤーパラメータはプレイヤー広告、挙動のカスタマイズ、プレイヤースタイルの変更に使用できます。

次の一般的なタイプのパラメータはプレイヤーAPIに渡すことができます。
  1. クエリー文字列パラメータ
  2. 埋め込みパラメータ
  3. カスタムモジュール埋め込みパラメータ

クエリー文字列パラメータ

次の例のname1=value1 &name2=value2...のようにプレイヤーV3ライブラリとビデオを呼び出すURLへ、このタイプのクエリー文字列パラメータを追加できます。
     <script>http://player.ooyala.com/v3/player_branding_id?name1=value1
     &name2=value2...
    
次の表はこれらのクエリー文字列パラメータを示します。
パラメータ 説明
namespace

namespaceパラメーターは、デフォルトのnamespaceOOを他の有効なjavascript idの名前に変更して、複数の独立したプレイヤーコードのコピーを同じページに配置することを許可します。たとえば、このembedを使用した場合は次のようになります。

namespace=(unique javascript id)

後で使用することができます。

MYPLAYER_1.Player.create(......)
MYPLAYER_2.Player.create(......)   
platform

platformパラメータで、flashとhtml5再生を選択する仕組みを制御できます。 パラメータ形式:

platform=(flash-only|flash|html5-fallback|
         html5-priority)

プレイヤーV3の場合、デフォルトマルチメディアのデフォルトは flashです。パラメータには次のオプションがあります。

  • flash - デフォルトのAdobe Flash再生はデスクトップ、モバイル、タブレットでのみ有効です。このオプションは初期設定をFlashに設定しますが、html5のフォールバックも許可します。
  • flash-only - Flash再生のみを許可します。 Flashが検出されない場合、視聴者はFlashプラグインをインストールしなければいけない、というエラーメッセージとリクエストを表示します。
  • html5-fallback - Flashを使用しますが、html5へのフォールバックを有効にします。
  • html5-priority - テスト目的でのみサポートされる、このパラメータは推奨する再生メカニズムに html5 を設定しますが、Flashのフォールバックも許可します。
    注: HTML5 再生は特定のブラウザ、およびOS/デバイス設定でのみ機能します。詳しくは、 サポートセンター → ドキュメント → プレイヤーデベロッパーガイド → システム要件 のトピックをご覧ください。

埋め込みパラメータ

各パラメータの例で示されているように、DIVコンテナ内にプレイヤーembedコードにこれらのパラメーターを 追加してください。パラメーターは、横幅と高さと、広告サーバーや広告ネットワークアカウントからの タグであるembedコードパラメータなどのCSSスタイル設定を含んでおり、これらパラメータをOoyalaプレイヤーに渡して高度な 広告トラッキングやターゲティングを可能にします。次の表は、embed コードパラメーターを示します。

:デスクトップとモバイルでは、広告挙動が少し変わります。デスクトッププラット フォームはすべての配置をサポートします。しかし、iOSをベースにしたデバイスは、プリロールおよびポストロールのみをサポートします。

次の表は、onCreate関数で使えるハッシュ、またはキー/値ペアも示し、埋め込み挙動を変更します。
表 1. 埋め込みパラメータ
パラメータキー 説明
analytics

プレイヤーV3でカスタム分析タグの使用を有効にします。

:

...
var ca_tags = [];
ca_tags[0] = "toolbar";
OO.ready(
    function () {
        OO.Player.create('ooyalaplayer',
            'w3ZHc0Njr33Tdp-RRcwfZMjaOrmzOP82', {
                analytics: {
                    "tags": ca_tags
                }
            });
    });
...
注: カスタム分析タグおよびBacklot REST APIとこのタグの使い方についての詳しい情報は、 カスタムアナリティクス:タグカスタムアナリティクス:タグをご覧ください。
autoplay

は、ロード時のアセット(ビデオまたはオーディオ)の自動再生を有効にします。これは、 再生/一時停止コントロールやコンテンツを直ちに再生する条件を持たないUIに対して役に立ちます。

:

var videoPlayer = OO.Player.create('playerwrapper',
         'embed_code', {
         height:100%,
         width:100%,
         autoplay:true,
         .... 
  });
enableChannels チャンネルモードでFlash ビデオの読み込みを有効にします。このパラメーターは、チャンネルに対して 後方互換を提供します。デフォルトでは、フラグはfalseの値に設定されています。 embedChannelパラメーターはHTML5の互換性を処理し、Flash チャンネルのユーザービリティを保証にします。

HTMLには:

  • enableChannels = trueなら、チャンネルの最初のビデオかチャンネルセットの最初でチャンネルの 1番目のビデオを再生します。
  • enableChannels = falseなら、エラー画面を表示します。

Flashには:

  • enableChannels = trueなら、チャンネルembedをプレイヤーに渡して、通常通り実行します (これは、パフォーマンスに影響することもあります)。
  • enableChannels = falseなら、エラー画面を表示します。
:
var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    enableChannels: true,
    ....
});
google

このパラメータを使用して、 Google IMA v3 広告サーバーかネットワークタグをOoyalaプレイヤーへ渡します。 パラメーターは、Google アドセンスのURLを表すキー/値ペアを取ります。

:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    'google': {
        tagUrl: 'some url',
        ....
    },
});
in-stream このパラメータを使って、インストリーム広告サーバーか、ネットワークタグをOoyalaプレイヤーへ渡します。 パラメータは、インストリームURLを表すキー/値ペアを取ります。

:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    'in-stream': {
        tagUrl: 'some url',
        ....
    },
});
initialTime このパラメータを使用して、初期時間を秒で設定して、特定のポイントでコンテンツ再生を始めます。このパラメータは、iOSベースのデバイスに対してシークを有効にするために使用することができます。 このパラメータをクロスデバイスレジュームに使用すれば、特定のユーザー位置までシークさせることができます。

タイプ: 整数

有効な値:秒単位の時間

: initialTime:10

OO.ready(function () {
    window.pp = OO.Player.create('playerV3Container',
        'embed_code', {
        width: 480,
        height: 360,
        initialTime: 10
    }); 
locale

このパラメーターを使って、言語と字幕オプションを設定、またはオーバーライドしてください。次の例では、 localeパラメータを使用してヘブライ語にローカライズしたプレイヤーを作成します。 iOSの字幕サポート方式が理由で、リモートアセットにIOSウェブ向け字幕データを追加できません。

:
var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    locale: 'he_IL',
    ....
});
loop このパラメータを使って、連続再生を有効にします。loopをtrueに設定すると、一度 再生が始まると、ユーザーが再生を止める、またはブラウザを閉じるまで再生を続けます。embed コードがsetEmbedCodeを使って設定されると、挙動も同じになります。embedコードが設定 されるとすぐに、autoplayがtrueなら、前回のプレイヤーの状態 (ビデオの再生中/一時停止中/ 停止中)に関わらず、再生がすぐに始まります。autoplayとloopパラメーターが、 setEmbedCode経由で渡されない場合、既存の値が使われます(前回のコールを通じてsetEmbedCodeへ     設定されていることもあります)。

:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    loop: 'true',
    ....
});
onCreate このパラメータを使って、イベントメッセージを監視して、アクションを実行します。この パラメータで、プレイヤーが完全に作成される前に、メッセージバスからイベントメッセージにサブスクライブすることができます。完全に作成する前にプレイヤーを修正できます。

コールされると、 onCreate: function(player):

  • 追加モジュールをチェックします (カスタム、サードパーティー、その他のタイプ)

  • これらの追加モジュールを有効にして、メッセージバスに接続してください。

  • 各モジュールを起動させるメッセージバスにメッセージを送ります。

一番最初にonCreateをコールしてください。既存および、追加、 サードパーティーモジュールがメッセージバスに接続されず、初期化されません。

    OO.Player.create('playerwrapper',embedCode, {
    onCreate: function(player) {
    player.subscribe('*','myPage', function(eventName) {});
    }
    });

onCreateとプレイヤーV2コールバック

プレイヤーV2でイベントを処理するには、コールバック関数を定義し、関数の名前をコール バックパラメータを使って、embedタグに渡してください。しかし、プレイヤーV3でイベントを処理するには、 onCreate 関数をOO.Player.create()コールに提供して、すべてのメッセージのために登録します。プレイヤー        V3の詳細は、プレイヤーイベントモデルをご覧ください。プレイヤーV2コールバックとパラメータについての詳細は、プレイヤーのクエリー文字列パラメータトピックをご覧ください。プレイヤーV2は廃止予定で あることにご注意ください。

prebuffering HTML5プレイヤーはデフォルトでプリバッファリングを行うため、このパラメータを使用して、 ビデオのプリバッファリングを無効にします。他の理由でもプレバッファリングを無効にしたい場合があります。
  • 同じページに複数のビデオをロードするときにロード時間を減らすため。
  • ビデオがまれにしか再生されない場合、ロードコストを抑えるため。
次の例では、プレバッファリングのパラメータの使い方を示します。

:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    prebuffering: false
    ....
});
vast このパラメータを使って、VAST準拠広告サーバーやネットワークタグをOoyalaプレイヤー に渡します。パラメータは、VAST広告サーバーやネットワークURLを表すキー/値ペアを取ります。 次の例では、VASTパラメータの使い方を示します。

:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    'vast': {
        tagUrl: 'some url',
        ....
    },
});

カスタムモジュール埋め込みパラメータ

カスタムモジュール埋め込みパラメータ(キー/値ペア)をonCreate関数に追加できます。次の表はカスタムモジュールパラメータを示します。

パラメータ 説明
devModuleCategory サードパーティーカスタムモジュールの開発に使用されます。Player.createのオプションハッシュの "flashParams"サブハッシュにこのパラメーターを指定します。このパラメーターを使って、 カスタムモジュールの分類を'universal'または'ads-manager”に指定してください。

タイプ: 文字列

有効値: category name such as 'universal' or 'ads-manager'

:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    'flashParams': {
        devModuleCategory: 'universal',
        ....
    },
});
devModuleURL サードパーティーカスタムモジュールの開発に使用されます。Player.createのオプションハッシュの "flashParams"サブハッシュにこのパラメーターを指定します。このパラメーターを使用して、 サードパーティーモジュール swf がダウンロードされるロケーションのURLを指定してください。

タイプ: 文字列

有効値: download URL where the third party module swf is located

:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    'flashParams': {
        devModuleURL: 'someURL',
        ....
    },
});
hide

このパラメータを使って、特定のプレイヤー機能を無効にします。V3 HTML5 プレイヤーはデフォルトで コントロールを表示しないので、hideパラメータは、V3プレイヤーでは機能しません。しかし、デバイスにFlashフォールバックがあれば、hideパラメータ (前に一覧にしたplatformパラメーター)が使えます。 Flashフォールバックがある場合、ハッシュ内でhideに flashParamsを指定します。

タイプ: 文字列

有効値: all | comma-separated list of options

値があるところ:
  • all - すべてのコントロールを無効にする
  • volume, fullscreen, channels, sharing, info, embed または endscreen
:

次の例では、ハッシュで'flashParams' を指定し、キー/値ペアを隠すを追加します。

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    'flashParams': {
        hide: 'all',
        ....
    },
});
layout

このplatformパラメータを使用して、UIレイアウトを制御します。パラメータ形式:

layout=(chromeless)

プレイヤーV3には、パラメータには次のオプションがあります:

  • chromeless - デフォルトプレイヤーコントロールを切り替えて、オンまたはオフにします。chromelessに 設定すると、パラメータは、chromeと開始画面を削除します。指定されていない場合、       プレイヤーはデフォルトレイアウトへ戻ります。

chromelessパラメーターは、プレイヤーUIでコントロールを無効にして、自動再生でビデオを再生します。chromelessレイアウトをOoyalaV3プレイヤーに実装するには、 layout=chromelessパラメータを <script ..../v3>タグに追加できます。これは、プレイヤー コントロールを無効するので、視聴者はコントロールを表示することなくビデオを再生することができます。 プレイヤーのコントロールバーを削除することによって、再生ボタンがなくなるので、視聴者は ビデオを再生出来なくなります。ビデオ再生を有効にすれば、ビデオが自動的に始まります。autoplayパラメーターを1に設定し、プレイヤーがストリームの 読み込みを終えるとすぐにビデオを開始するようにします。

:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    layout: 'chromeless'
    });
thruParam_dev-other サードパーティーカスタムモジュールの開発に使用されます。Player.createのオプションハッシュの "flashParams"サブハッシュにこのパラメーターを指定します。このパラメーターで、基本的な カスタマイゼーションをOoyalaプレイヤーに渡すことができます。

タイプ: 文字列

有効値: customization code

:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    'flashParams': {
        thruParam_dev-other: 'customization',
        ....
    },
});

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