連携タグの仕様連携タグについて、オンデマンド用、ライブ／疑似ライブ用それぞれの仕様について説明します。
【オンデマンド】
■形式
| EQKarteV2.addPlayer( player, { mid, title, milestone, stopSendEvents } ); |
■パラメータ
| パラメータ名 | 形式 | 必須/任意 | 内容 | 指定方法例 |
| player |
オブジェクト |
必須 |
動画プレイヤー本体です。 |
- |
| mid |
数値 |
必須 |
再生するEquipmediaの動画IDです。 |
mid: 123 |
| title |
文字列 |
必須 |
再生する動画のタイトルです。 |
title: "テスト動画" |
| milestone |
配列[ 数値 ] |
任意 |
トラッキングする視聴位置をパーセントで指定することができます。 ※デフォルトでは、[25 , 50 , 75]となります。 |
milestone:[0, 30, 60, 90] |
| stopSendEvents |
配列[ 文字列 ] |
任意 |
送出しないイベント（イベント名）がある場合に指定します。 ※デフォルトでは「なし」（すべてのイベントを送信する）となります。 ※指定可能なイベントは以下の通りです。
※各イベントを指定した際の動作については、『■「stopSendEvents」に指定可能なイベント』をご参照ください。 |
stopSendEvents: ["play", "complete"] |
■「stopSendEvents」に指定可能なイベント
| イベント | 内容 | 「stopSendEvents」に指定した場合の動作 |
| first_play |
初回再生 |
初回再生イベントを送出しない |
| play |
再生 |
再生イベントを送出しない |
| pause |
一時停止 |
一時停止イベントを送出しない |
| viewing |
再生中 |
再生中イベントを送出しない |
| complete |
視聴完了 |
視聴完了イベントを送出しない |
| all |
すべてのイベント |
すべてのイベントを送出しない |
【ライブ／疑似ライブ】
■形式
| EQLKarteV2.addPlayer( player, { lpid, title, points, useBeacon, beaconInterval, stopSendEvents } ); |
■パラメータ
| パラメータ名 | 形式 | 必須/任意 | 内容 | 指定方法例 |
| player |
オブジェクト |
必須 |
ライブプレイヤー本体です。 |
- |
| lpid |
数値 |
必須 |
ライブ配信するライブIDです。 |
lpid: 12 |
| title |
文字列 |
必須 |
ライブ配信の配信タイトルです。 |
title: "テスト配信" |
| points |
配列[ 数値 ] |
任意 |
トラッキングする視聴位置を秒で指定することができます。 ※デフォルトでは[ 600 , 1800 , 3600 ]となります。 |
points:[1800, 3600, 5400] |
| useBeacon |
真偽値 |
任意 |
一定間隔でトラッキングする場合に指定します。 ※デフォルトでは「false」となります。 |
useBeacon:true |
| beaconInterval |
数値 |
任意 |
一定間隔でトラッキングする場合の間隔（秒数）を指定します。 ※デフォルトでは「600」（秒）となります。 |
beaconInterval:120 |
| stopSendEvents |
配列[ 文字列 ] |
任意 |
送出しないイベント（イベント名）がある場合に指定します。 ※デフォルトでは「なし」（すべてのイベントを送信する）となります。 ※指定可能なイベントは以下の通りです。
※各イベントを指定した際の動作については、『■「stopSendEvents」に指定可能なイベント』をご参照ください。 |
stopSendEvents: ["play", "pause"] |
■「stopSendEvents」に指定可能なイベント
| イベント | 内容 | 「stopSendEvents」に指定した場合の動作 |
| play |
再生 |
再生イベントを送出しない |
| pause |
一時停止 |
一時停止イベントを送出しない |
| viewing |
再生中 |
再生中イベントを送出しない |
| all |
すべてのイベント |
すべてのイベントを送出しない |