下列指示提供使用 2.x SDK 實作的指引。
若您正在實作 SDK 1.x 版,您可以在此處下載開發人員指南:下載 SDK。
章節和區段追蹤適用於自訂的媒體章節或區段。章節追蹤的一些常見用途是根據媒體內容 (例如棒球局次) 定義自訂區段,或定義廣告插播之間的內容區段。核心媒體追蹤實作不需要章節追蹤。
章節追蹤包括章節開始、章節完成,以及章節略過。您可以使用具有自訂區段邏輯的媒體播放器 API 來識別章節事件,並填入必要和選用的章節變數。
chapterObject
chapterCustomMetadata
trackEvent(MediaHeartbeat.Event.ChapterStart, chapterObject, chapterCustomMetadata);
trackEvent(MediaHeartbeat.Event.ChapterComplete);
trackEvent(MediaHeartbeat.Event.ChapterSkip);
識別章節開始事件何時發生,並使用章節資訊建立 ChapterObject
例項。
以下是 ChapterObject
章節追蹤參考:
唯有在您計劃追蹤章節時,才須使用這些變數。
變數名稱 | 說明 | 必填 |
---|---|---|
name |
章節名稱 | 是 |
position |
章節位置 | 是 |
length |
章節長度 | 是 |
startTime |
章節開始時間 | 是 |
如果您包含該章節的自訂中繼資料,請為中繼資料建立內容資料變數。
若要開始追蹤章節播放,請呼叫 ChapterStart
例項中的 MediaHeartbeat
事件.
當播放達到由您的自訂程式碼定義之章節結束界限時,請呼叫 ChapterComplete
例項中的 MediaHeartbeat
事件.
如果因為使用者選擇略過章節而未完成章節播放 (例如,如果使用者搜尋超出章節界限),請呼叫 MediaHeartbeat 例項中的 ChapterSkip
事件.
如果有任何其他章節,請重複步驟 1 到 5。
以下程式碼範例將 JavaScript 2.x SDK 用於 HTML5 媒體播放器。您應該將此程式碼與核心媒體播放程式碼一起使用。
/* 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);
};