布萊特灣球員樣本:播放清單中最多觀賞的影片
播放器範例
在以下示例中,您將看到播放器的播放列表顯示在右側。播放清單是透過使用 Brightcove 播放器目錄擷取最受歡迎的影片 (根據大多數播放次數) 來填入。
看筆18175-觀看次數最多的視頻播放列表通過 Brightcove 學習服務( @bcls1969) 在代碼筆 .
原始碼
在 GitHub 上查看完整的解決方案。
概覽
此範例會使用存取播放 API 的 Brightcove 播放器目錄,從您的帳戶傳回觀看次數最多的影片。它類似於「熱門影片播放清單」範例,該範例使用 Analytics API 中的資料。請記住幾乎沒有差異:
布萊特灣播放器目錄(播放 API)
- 該
plays_total
字段是視頻的所有時間視頻觀看次數。 - 您可以使用目錄 .getSearch ()方法輕鬆地從播放 API 檢索數據。
分析 API
- 如果未指定
from
參數和值,則預設值為過去 30 天。 - 若要從播放 API 中Analytics API擷取相同的結果,請使用 API 要求中的
?alltime
URL 參數。
使用編碼器
以下是一些有效使用上述 CodePen 的提示:
- 通過單擊Result按鈕切換播放器的實際顯示。
- 按一下HTML/CSS/JS按鈕以顯示其中一種代碼類型。
- 本文件稍後將在 Play/HTML 組態、應用程式流程和應用程式樣式區段中討論應用程式中使用的邏輯、流程和樣式。跟著這些章節中的資訊一起遵循的最佳方式是:
- 單擊 CodePen 中的EDIT ON CODEPEN按鈕,並在一個瀏覽器/瀏覽器選項卡中提供代碼。
- 在 CodePen 中,調整您要顯示的程式碼。您可以在 CodePen 中變更不同的程式碼區段的寬度。
- 查看播放器/HTML 配置 , 申請流程和/或應用樣式另一個瀏覽器/瀏覽器選項卡中的部分。您現在可以遵循程式碼說明,並同時檢視程式碼。
開發順序
以下是推薦的開發順序:
- 使用網頁內嵌播放程式實作來測試播放器、外掛程式和 CSS 的功能 (如果需要 CSS)
- 將插件的 JavaScript 和 CSS 放入單獨的文件中進行本地測試
- 一旦你解決了任何錯誤,將插件代碼和 CSS 部署到你的服務器
- 使用工作室將插件和 CSS 添加到您的播放器
- 如果您確定 iframe 實現更適合(詳見下一節),請替換頁內嵌播放器實現
如需這些步驟的詳細資訊,請檢閱逐步操作:插件開發指南。
iframe 或頁內嵌
在開發 Brightcove 播放器的增強功能時,您需要決定代碼是否最適合 iframe 或頁內嵌實現。最佳實踐建議是構建一個插件以與 iframe 實現一起使用。使用 iframe 播放器的優點是:
- 沒有與現有的JavaScript 和/或CSS 發生衝突
- 自動回應
- iframe 可以簡化社交媒體應用程序中的使用(或者當視頻需要「旅行」到其他應用程序時)
雖然整合頁內嵌播放程式可能會比較複雜,但有時候您會針對該實作規劃程式碼。概括,這種方法是最好的時候包含的頁面需要與播放器進行通信。具體來說,這裡有一些例子:
- 包含頁面中的程式碼需要監聽播放器賽事並採取行動
- 播放器使用包含頁面的樣式
- iframe 將導致應用程序邏輯失敗,例如從包含頁面重定向
即使您的最終實作未使用 iframe 程式碼,您仍然可以將頁面內嵌程式碼與 JavaScript 的外掛程式搭配使用,並為您的 CSS 使用個別檔案。這封裝了你的邏輯,以便您可以輕鬆地在多個玩家中使用它。
使用的 API /外掛程式資源
播放器 API 方法 |
---|
catalog.getSearch() |
播放列表() |
播放器/HTML 配置
本節詳細說明玩家建立期間所需的任何特殊配置。此外,除了頁面內嵌播放程式實作程式碼之外,還會說明必須新增至頁面的其他 HTML 元素。
播放程式組態
您為此範例建立的 Brightcove 播放程式不需要特殊設定。
其他 HTML
使用進階 (頁內嵌) 播放程式時,您需要新增 HTML 元素來指定播放清單的位置。如需詳細資訊,請參閱實施播放清單文件。
<div class="vjs-playlist"></div>
請記住將id
屬性添加到播放器嵌入代碼中的video-js
標籤。
<video-js id="myPlayerID"
...
應用程式流程
這個應用程序背後的基本邏輯是:
- 定義搜尋參數
- 取得視訊物件
- 載入播放清單
定義搜尋參數
找到標記的代碼:
// +++ Define the search parameters +++
使用目錄 GetSearch ()方法時,您必須先定義搜尋參數。此查詢將從您的帳戶返回10個視頻,並按所有視頻的觀看次數降序排列(plays_total
)。
由於我們要在 Video Cloud 帳戶中搜尋影片,因此必須使用具有搜尋功能的政策金鑰。
取得視訊物件
找到標記的代碼:
// +++ Get the video objects +++
根據catalog.getSearch()
方法的搜尋參數擷取視訊物件陣列。
載入播放清單
找到標記的代碼:
// +++ Load the playlist +++
使用此方playlist()
法將傳回的視訊物件載入播放程式的播放清單。
應用程式樣式
CSS用於設置播放器和播放列表的樣式。
外掛程式碼
通常,當將 JavaScript 轉換為布萊特灣播放器插件名義更改時,需要更改。其中一項必要的變更是以定義外掛程ready()
式的程式碼取代方法的標準使用方法。
以下是將與播放器一起使用的 JavaScript 代碼的常用開始:
videojs.getPlayer('myPlayerID').ready(function() {
var myPlayer = this;
...
});
您將變更第一行,以使用標準語法來啟動 Brightcove 播放程式外掛程式:
videojs.registerPlugin('pluginName', function(options) {
var myPlayer = this;
...
});
如前所述,您可以在本文檔的相應 GitHub 存儲庫:most-watched-playlist.js 中看到該插件的 JavaScript 代碼。
在播放器上使用外掛程式
一旦您將插件的 CSS 和 JavaScript 文件存儲在可訪問互聯網的位置,您可以使用該插件與播放器。在工作室的播放器模塊中,您可以選擇一個播放器,然後在插件部分將 URL 添加到 CSS 和 JavaScript 文件中,如果需要選項,還可以添加名稱和選項。