概要 overview
以下の手順は、SDK 2.x を使用した実装についてのガイダンスです。
チャプターおよびセグメントの追跡は、カスタム定義されたメディアのチャプターまたはセグメントに対して使用できます。チャプターの追跡は一般的に、メディアコンテンツ（野球のイニングなど）に基づくカスタムセグメントの定義や、広告ブレークの間のコンテンツセグメントの定義に使用されます。コアメディア追跡の実装では、チャプター追跡は 不要です。
チャプターの追跡には、チャプター開始、チャプター完了、チャプタースキップが含まれます。このメディアプレーヤー API をカスタマイズしたセグメント化ロジックと共に使用して、チャプターイベントを識別したり、必須およびオプションのチャプター変数を設定したりできます。
プレーヤーイベント
チャプター開始時
- チャプターのチャプターオブジェクトのインスタンス
chapterObjectを作成します - チャプターのメタデータ
chapterCustomMetadataを設定します - を呼び出します
trackEvent(MediaHeartbeat.Event.ChapterStart, chapterObject, chapterCustomMetadata);
チャプター完了時
- を呼び出します
trackEvent(MediaHeartbeat.Event.ChapterComplete);
チャプタースキップ時
- を呼び出します
trackEvent(MediaHeartbeat.Event.ChapterSkip);
チャプター追跡の実装 implement-chapter-tracking
-
いつチャプター開始イベントが発生するかを識別し、チャプター情報を使用して
ChapterObjectインスタンスを作成します。以下に、
ChapterObjectチャプター追跡リファレンスを示します。note note NOTE これらの変数は、チャプターを追跡する場合にのみ必要です。 table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 3-align-center 7-align-center 11-align-center 15-align-center 19-align-center 変数名 説明 必須 nameチャプター名 ○ positionチャプター位置 ○ lengthチャプターの長さ ○ startTimeチャプター開始時間 ○ -
チャプターのカスタムメタデータを含める場合、そのメタデータのコンテキストデータ変数を作成します。
-
チャプター再生の追跡を開始するには、
ChapterStartインスタンスでMediaHeartbeatイベントを呼び出します。 -
カスタムコードで定義したチャプター終了の境界まで再生したら、
ChapterCompleteインスタンスでMediaHeartbeatイベントを呼び出します。 -
ユーザーがチャプターをスキップした（例えば、ユーザーがチャプター境界の外にシークした）のでチャプター再生が完了しなかった場合は、MediaHeartbeat インスタンスで
ChapterSkipイベントを呼び出します。 -
その他のチャプターがある場合、手順 1 ～ 5 を繰り返します。
以下のサンプルコードでは、HTML5 メディアプレーヤー用の JavaScript 2.x SDK を使用しています。このコードをコアメディア再生コードと共に使用する必要があります。
/* Call on chapter start */
if (e.type == "chapter start") {
var chapterObject = MediaHeartbeat.createChapterObject("Inning 5",5,500,2500);
/* Set custom context data*/
var chapterCustomMetadata = {
segmentType:"Baseball Innings",
segmentName:"Inning 5",
segmentInfo:"Game Six"
}
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.ChapterStart,
chapterObject,
chapterCustomMetadata);
};
/* Call on chapter complete */
if (e.type == "chapter complete") {
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.ChapterComplete);
};
/* Call on chapter skip */
if (e.type == "chapter skip") {
this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.ChapterSkip);
};