布萊特灣球員樣本:進度列中的章節標記

在本主題中,您將學習如何在進度欄中添加標記以顯示定義的章節。

播放器範例

開始播放視頻後,您會在進度欄中看到藍色標記,指示視頻中已定義章節的位置。您可以使用章節圖標跳到章節並確認位置。

看筆進度條中的章節標記通過 Brightcove 學習服務( @rcrooks1969) 在代碼筆 .

原始碼

在 GitHub 上查看完整的解決方案

使用編碼器

以下是一些有效使用上述 CodePen 的提示:

  • 通過單擊Result按鈕切換播放器的實際顯示。
  • 按一下HTML/CSS/JS按鈕以顯示其中一種代碼類型。
  • 本文件稍後將在 Play/HTML 組態、應用程式流程和應用程式樣式區段中討論應用程式中使用的邏輯、流和樣式。跟著這些章節中的資訊一起遵循的最佳方式是:
    1. 單擊 CodePen 中的EDIT ON CODEPEN按鈕,並在一個瀏覽器/瀏覽器選項卡中提供代碼。
    2. 在 CodePen 中,調整您要顯示的程式碼。您可以在 CodePen 中變更不同的程式碼區段的寬度。
    3. 查看播放器/HTML 配置 , 申請流程和/或應用樣式另一個瀏覽器/瀏覽器選項卡中的部分。您現在可以遵循程式碼說明,並同時檢視程式碼。

開發順序

以下是推薦的開發順序:

  1. 使用網頁內嵌播放程式實作來測試播放器、外掛程式和 CSS 的功能 (如果需要 CSS)
  2. 將插件的 JavaScript 和 CSS 放入單獨的文件中進行本地測試
  3. 一旦你解決了任何錯誤,將插件代碼和 CSS 部署到你的服務器
  4. 使用工作室將插件和 CSS 添加到您的播放器
  5. 如果您確定 iframe 實現更適合(詳見下一節),請替換頁內嵌播放器實現

如需這些步驟的詳細資訊,請檢閱逐步操作:插件開發指南。

iframe 或頁內嵌

在開發 Brightcove 播放器的增強功能時,您需要決定代碼是否最適合 iframe 或頁內嵌實現。最佳實踐建議是構建一個插件以與 iframe 實現一起使用。使用 iframe 播放器的優點是:

  • 沒有與現有的JavaScript 和/或CSS 發生衝突
  • 自動回應
  • iframe 可以簡化社交媒體應用程序中的使用(或者當視頻需要「旅行」到其他應用程序時)

雖然整合頁內嵌播放程式可能會比較複雜,但有時候您會針對該實作規劃程式碼。概括,這種方法是最好的時候包含的頁面需要與播放器進行通信。具體來說,這裡有一些例子:

  • 包含頁面中的程式碼需要監聽播放器賽事並採取行動
  • 播放器使用包含頁面的樣式
  • iframe 將導致應用程序邏輯失敗,例如從包含頁面重定向

即使您的最終實作未使用 iframe 程式碼,您仍然可以將頁面內嵌程式碼與 JavaScript 的外掛程式搭配使用,並為您的 CSS 使用個別檔案。這封裝了你的邏輯,以便您可以輕鬆地在多個玩家中使用它。

使用的 API /外掛程式資源

API 屬性
中介. 持續時間

播放器/HTML 配置

本節詳細說明玩家建立期間所需的任何特殊配置。此外,除了頁面內嵌播放程式實作程式碼之外,還會說明必須新增至頁面的其他 HTML 元素。

播放程式組態

您為此範例建立的 Brightcove 播放程式不需要特殊設定。

其他 HTML

不會將其他 HTML 元素新增至頁面。

應用程式流程

這個應用程序背後的基本邏輯是:

  • 從視頻信息中提取提示點數組。
  • 構建一個數組,其中包含與視頻相關的所有章節的開始時間。
  • 調用在進度條上做標記的函數。您將傳遞章節開始時間和視頻時長。

檢索包含章節提示點的數據結構

找到標記的代碼:

// ### Use the array filter function to retrieve data structure that contains chapter cue points ###

您需要從包含提示點(用作章節)的視頻信息中提取數據。您需要使用數組函數filter。由於我們沒有要與之交互的數組,因此只需使用一個空數組即可。因此,代碼[].filter。如需詳細資訊,請參閱陣列. 原型篩選 ()

提取章開始時間並存儲在數組中

找到標記的代碼:

// ### Loop over chapter cue points and get start time of each ###

這是相當直接的程式碼,可以迴圈遍歷提示點陣列,並將每個提示點放startTime入陣列中。

在進度條上放置標記

找到標記的代碼:

// ### Call function to create marks in progressbar ###

您調用將標記放置在進度條上的方法。您傳遞章節的開始時間數組和視頻時長。在函數中,您首先使用 JavaScript 的document.getElementsByClassName()方法獲取對進度條元素的引用。接下來,您將循環遍歷提示點的數組,並為每個提示點動態創建一個 div,計算它應該放在進度條上的位置的百分比,然後使用 JavaScript 的appendChild()方法將標記放在進度列上。

應用程式樣式

CSS用於控制章節標記的外觀:

.vjs-marker {
  position: absolute;
  opacity: 1;
  height: 100%;
  background-color: blue;
  width: 4px;
}

外掛程式碼

通常,當將 JavaScript 轉換為布萊特灣播放器插件名義更改時,需要更改。其中一項必要的變更是以定義外掛程ready()式的程式碼取代方法的標準使用方法。

以下是將與播放器一起使用的 JavaScript 代碼的常用開始:

videojs.getPlayer('myPlayerID').ready(function() {
  var myPlayer = this;
  ...
});

您將變更第一行,以使用標準語法來啟動 Brightcove 播放程式外掛程式:

videojs.registerPlugin('pluginName', function(options) {
  var myPlayer = this;
  ...
});

如前所述,您可以在本文檔的相應 GitHub 存儲庫:chapter-markers.js 中看到該插件的 JavaScript 代碼

在播放器上使用外掛程式

一旦您將插件的 CSS 和 JavaScript 文件存儲在可訪問互聯網的位置,您可以使用該插件與播放器。在工作室的播放器模塊中,您可以選擇一個播放器,然後在插件部分將 URL 添加到 CSS 和 JavaScript 文件中,如果需要選項,還可以添加名稱和選項。