使用 JavaScript 3.x 追蹤核心播放

初始追蹤設定

識別使用者何時觸發播放的意圖 (使用者點擊「播放」及/或開啟自動播放) 並建立 MediaObject 例項。

createMediaObject API

StreamType常數：

MediaType常數：

var mediaObject = ADB.Media.createMediaObject(<MEDIA_NAME>,
                                  <MEDIA_ID,
                                  <MEDIA_LENGTH>,
                                  <STREAM_TYPE>,
                                  <MEDIA_TYPE>);

附加中繼資料

可選擇透過內容資料變數，將標準和/或自訂中繼資料附加到追蹤工作階段。

• 標準中繼資料

  NOTE

  附加標準中繼資料為選用。

  • 媒體中繼資料索引鍵 API 參考 - 標準中繼資料索引鍵 - JavaScript

    請在此處參閱完整的可用中繼資料組：音訊和視訊參數

• 自訂中繼資料

  為自訂變數建立變數物件，並為此媒體填入資料。例如：

  /* Set context data */
   var contextData = {};
  
   //Standard metadata
   contextData[ADB.Media.VideoMetadataKeys] = "Sample Episode";
   contextData[ADB.Media.VideoMetadataKeys] = "Sample Show";
  
   //Custom metadata
   contextData["isUserLoggedIn"] = "false";
   contextData["tvStation"] = "Sample TV Station";
  

追蹤開始播放的意圖

若要開始追蹤媒體工作階段，請呼叫媒體心率例項上的 trackSessionStart：

var mediaObject = ADB.Media.createMediaObject("video-name",
                                              "video-id",
                                              60.0,
                                              ADB.Media.StreamType.VOD,
                                              ADB.Media.MediaType.Video);

var contextData = {};

//Standard metadata
contextData[ADB.Media.VideoMetadataKeys] = "Sample Episode";
contextData[ADB.Media.VideoMetadataKeys] = "Sample Show";

//Custom metadata
contextData["isUserLoggedIn"] = "false";
contextData["tvStation"] = "Sample TV Station";

tracker.trackSessionStart(mediaObject, contextData);

IMPORTANT

trackSessionStart 會追蹤使用者的播放意圖，而非播放的開始。此 API 用來載入資料/中繼資料，以及估計開始 QoS 量度所需的時間 (trackSessionStart 與 trackPlay 之間的時間)。

NOTE

如果您未使用 contextData，只要為 trackSessionStart 中的 data 引數傳送空白物件即可。

追蹤實際的播放開始

識別來自媒體播放器的播放開始 (在畫面上轉譯了媒體的第一個時間格) 事件，並呼叫 trackPlay：

tracker.trackPlay();

更新播放點值

當媒體播放點變更時，呼叫mediaUpdatePlayhead API以通知SDK。
對於隨選影片 (VOD)，此值是從媒體項目的開頭開始以秒為單位指定的。
對於直播串流，如果播放器未提供內容持續時間的相關資訊，則此值可以指定為自當天UTC午夜開始的秒數。

tracker.updatePlayhead(position)

NOTE

呼叫tracker.updatePlayhead API時，請考量下列事項：

• 使用進度標籤時，需要內容持續時間，並且播放點需要更新為從媒體專案開始的秒數，從0開始。
• 使用Media SDK時，您必須至少每秒呼叫tracker.updatePlayhead API一次。

追蹤播放完成

識別來自媒體播放器的播放完成 (使用者已觀看內容至結尾) 事件，並呼叫 trackComplete：

tracker.trackComplete();

追蹤工作階段結尾

識別來自媒體播放器的播放卸載/關閉 (使用者關閉媒體和/或媒體完成及卸載) 事件，並呼叫 trackSessionEnd：

tracker.trackSessionEnd();

IMPORTANT

trackSessionEnd 會標記追蹤工作階段的結尾。如果成功觀看工作階段至完成 (使用者觀看了內容至結尾)，請確定在 trackComplete 之前呼叫 trackSessionEnd。在 trackSessionEnd 之後會忽略任何其他 track* API 呼叫 (除了新追蹤工作階段的 trackSessionStart)。

追蹤所有可能的暫停情況

識別來自媒體播放器暫停的事件，並呼叫 trackPause：

tracker.trackPause();

暫停情況

識別媒體播放器將暫停的任何案例，並確定正確呼叫 trackPause。以下情形都要求應用程式呼叫 trackPause()：

• 使用者明確在應用程式中點擊暫停。
• 播放器自行進入「暫停」狀態。
• (行動應用程式) - 使用者讓應用程式進入背景，但您希望應用程式保持工作階段開啟。
• (行動應用程式) - 發生任何類型的系統中斷，導致應用程式進入背景。例如，使用者接聽電話、或發生來自另一個應用程式的彈出視窗，但您希望應用程式維持工作階段進行中，讓使用者能夠從中斷點復原媒體。

識別來自播放器的播放和/或來自暫停的恢復事件，並呼叫 trackPlay：

tracker.trackPlay();

TIP

這可能與在步驟 4 使用的事件來源相同。確保播放恢復時，每個 trackPause() API 呼叫都與下列 trackPlay() API 呼叫成對。