JavaScript 2.x を使用したチャプターおよびセグメントの追跡

重要

以下の手順は、SDK 2.x を使用した実装についてのガイダンスです。1.x バージョンの SDK を実装する場合は、開発ガイドをこちら(SDK のダウンロード)からダウンロードできます。

  1. いつチャプター開始イベントが発生するかを識別し、チャプター情報を使用して ChapterObject インスタンスを作成します。

    ChapterObject チャプター追跡リファレンス:

    メモ

    これらの変数は、チャプターを追跡する場合にのみ必要です。

    変数名 説明 必須
    name チャプター名
    position チャプター位置
    length チャプターの長さ
    startTime チャプター開始時間

    チャプターオブジェクト:

    var chapterInfo =  
      MediaHeartbeat.createChapterObject(<CHAPTER_NAME>,  
                                         <POSITION>,  
                                         <LENGTH>,  
                                         <START_TIME>);
    
  2. チャプターのカスタムメタデータを含める場合、そのメタデータのコンテキストデータ変数を作成します。

    var chapterCustomMetadata = {
        segmentType: "Sample segment type",  
        segmentName: "Sample segment name",  
        segmentInfo: "Sample segment info"
    };
    
  3. チャプター再生の追跡を開始するには、ChapterStart インスタンスで MediaHeartbeat イベントを呼び出します。

    _onChapterStart = function() {
        this._mediaHeartbeat.trackEvent(MediaHeartbeat.Event.ChapterStart,  
                                        chapterObject,  
                                        chapterCustomMetadata);
    };
    
  4. カスタムコードで定義したチャプター終了の境界まで再生したら、ChapterComplete インスタンスで MediaHeartbeat イベントを呼び出します。

    _onChapterComplete = function() {
       this._mediaHeartbeat.trackEvent(MediaHeartbeat.Event.ChapterComplete);
    };
    
  5. ユーザーがチャプターをスキップした(例えば、ユーザーがチャプター境界の外にシークした)のでチャプター再生が完了しなかった場合は、MediaHeartbeat インスタンスで ChapterSkip イベントを呼び出します。

    _onChapterSkip = function() {
        this._mediaHeartbeat.trackEvent(MediaHeartbeat.Event.ChapterSkip);
    };
    
  6. その他のチャプターがある場合、手順 1 ~ 5 を繰り返します。

このページ