布萊特灣球員樣本:播放 API 分頁

在本主題中,您將學習從Playback API檢索數據時如何實現播放列表分頁。

限制

播放器範例

本示例使用Brightcove播放器在播放器中顯示視頻以及播放列表中的前3個視頻。選擇下一部影片按鈕以顯示播放列表中的後3個視頻。當您到達播放列表中的最後一組視頻時,顯示的視頻將環繞到播放列表的開頭。

看筆18171播放api分頁通過Brightcove學習服務( @ bcls1969) 上密碼筆

原始碼

觀看GitHub上的完整解決方案

播放API

本示例使用Playback API從指定的播放列表返回視頻。為了翻閱播放列表中的視頻,此示例使用以下請求URL參數:

  • limit -定義要從Playback API返回的視頻數
  • offset -設置要從Playback API播放列表中跳過的視頻數

使用編碼器

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

  • 按一下Result按鈕來切換播放器的實際顯示。
  • 按一下HTML/CSS/JS按鈕以顯示其中一種代碼類型。
  • 在本文件後面,應用程序中使用的邏輯,流程和樣式將在播放器 /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 方法 描述
目錄. 取得視訊 () 對具有指定ID的視頻進行目錄請求並在請求完成時調用回調的方法。
目錄. 載入 () 將視頻加載到播放器的方法。
播放清單 () 將視頻對像數組分配給播放器播放列表的方法。請注意,此方法也可以用於檢索播放器中當前正在播放的播放列表,但在本文檔中將不以這種方式使用。

播放器/HTML 配置

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

播放程式組態

  • 在Video Cloud Studio中,導航到玩家們模塊,然後設定值部分。選擇編輯按鈕並執行以下操作:
    • 設置顯示播放列表選擇已啟用
    • 將「調整大小」選項設定為「回應式」。
    • 設置播放器尺寸以適合您的網頁。

其他 HTML

添加一個下一部影片按鈕可獲取播放列表中的下一組3個視頻。

選用性:添加一個容器以顯示當前的Playback API請求URL。

應用程式流程

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

  • 加載第一組視頻。
  • 「聆聽下一個影片」按鈕
  • 創建請求URL。
  • 獲取下一組視頻數據。
  • 將當前播放列表加載到播放器中。

加載第一組視頻

找到標記的代碼:

    // +++ Load first set of videos +++

使用catalog庫以獲取指定播放列表ID的播放列表對象。將第一組視頻加載到播放器中。

「聆聽下一個影片」按鈕

找到標記的代碼:

    // +++ Listen for Next Videos button +++

添加事件偵聽器以將下一組視頻加載到播放列表中。

創建請求URL

找到標記的代碼:

    // +++ Create request URL +++

使用來創建Playback API請求網址limitoffset參數。

獲取視頻數據

找到標記的代碼:

    // +++ Get video data +++

呼叫播放 API 以取得播放清單中的下一組影片。

加載視頻數據

找到標記的代碼:

    // +++ Load video data +++

呼叫播放 API 以取得播放清單中的下一組影片。將第一個視頻加載到播放器中。將陣列中的視頻加載到播放器的播放列表中。

應用程式樣式

CSS設置播放器的樣式以及播放器下方的水平播放列表。

外掛程式碼

通常,當將 JavaScript 轉換為布萊特灣播放器插件名義更改時,需要更改。一個必要的更改是用定義插件的代碼替換ready()方法的標準使用。

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

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

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

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

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

在播放器上使用外掛程式

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