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

重要

本文件涵蓋 SDK 2.x 版中的追蹤。若您正在實作 SDK 1.x 版,您可以在此處下載 1.x 開發人員指南: 下載 SDK

  1. 初始追蹤設定

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

    createMediaObject API

    變數名稱 說明 必填
    name 媒體名稱
    mediaid 媒體唯一識別碼
    length 媒體長度
    streamType 資料流類型 (請參閱下列 StreamType 常數)
    mediaType 媒體類型 (請參閱下列 MediaType 常數)

    StreamType常數:

    常數名稱 說明
    VOD 隨選視訊的資料流類型。
    LIVE LIVE 內容的資料流類型。
    LINEAR LINEAR 內容的資料流類型。
    AOD 隨選音訊的資料流類型。
    AUDIOBOOK 有聲書的資料流類型.
    PODCAST 播客的資料流類型.

    MediaType常數:

    常數名稱 說明
    Audio 音效資料流的媒體類型。
    Video 視訊資料流的媒體類型。
    var mediaObject =  
      MediaHeartbeat.createMediaObject(<MEDIA_NAME>,  
                                      <MEDIA_ID,  
                                      <MEDIA_LENGTH>,
                                      MediaHeartbeat.StreamType.VOD,
                                      <MEDIA_TYPE>);
    
  2. 附加中繼資料

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

    • 標準中繼資料

      在 JavaScript 上實作標準中繼資料

      注意

      將標準中繼資料物件附加到媒體物件為選用。

    • 自訂中繼資料

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

      /* Set custom context data */
      var customVideoMetadata = {
          isUserLoggedIn: "false",
          tvStation: "Sample TV station",
          programmer: "Sample programmer"
      };
      
  3. 追蹤開始播放的意圖

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

    mediaHeartbeat.trackSessionStart(mediaObject, customVideoMetadata);
    
    秘訣

    秒數值是您在步驟 2 建立的自訂媒體中繼資料物件名稱。

    重要

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

    注意

    若您未使用自訂中繼資料,只要對 trackSessionStart 中的 data 引數傳送空白物件即可,如上方 iOS 範例中的備註行所示。

  4. 追蹤實際的播放開始

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

    mediaHeartbeat.trackPlay();
    
  5. 追蹤播放完成

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

    mediaHeartbeat.trackComplete();
    
  6. 追蹤工作階段結尾

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

    mediaHeartbeat.trackSessionEnd();
    
    重要

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

  7. 追蹤所有可能的暫停情況

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

    mediaHeartbeat.trackPause();
    

    暫停情況

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

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

    mediaHeartbeat.trackPlay();
    
    秘訣

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

本頁內容

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now