布萊特灣球員樣本:圖誌覆蓋外掛程式

在本主題中,您將學習如何創建徽標疊加層插件,該插件使用標準的Overlay插件顯示視頻的徽標疊加層以及可選的點擊後到達URL。如果您打算將插件與播放器的iframe實現一起使用,則無法利用點擊後到達網址,因為新頁面只會在iframe中打開。

播放器範例

該插件可用於在播放器頂部顯示任何可用於Web的圖像覆蓋。您可以根據以下信息控制消息的顯示:

  • 位置-圖像可以在播放器上的不同位置顯示
  • 玩家事件-例如playpause或自定義事件
  • 時間間隔-視訊播放期間的指定時間

在以下示例中,您將看到一個徽標顯示在播放器的左下角。視頻播放五秒鐘後,徽標將逐漸消失。

看筆徽標疊加插件通過 Brightcove 學習服務( @bcls) 在代碼筆 .

原始碼

在 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 方法 API 事件 布萊特灣播放器外掛程式
關閉() 時間更新 顯示覆疊
上()    
目前時間()    

播放器/HTML 配置

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

播放程式組態

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

其他 HTML

顯示覆蓋外掛程式 JavaScript 檔案會使用<script>標籤連結至頁面。請注意,顯示覆蓋外掛程式的 CSS不會連結到頁面中。頁面中使用了自定義CSS,以便更輕鬆地進行更改。

應用程式流程

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

  • 定義了在適當的時間刪除覆蓋圖像的功能。
  • 定義了在適當時間顯示覆蓋圖像的功能。
  • 自定義配置選項與默認選項合併。僅當未提供自定義選項時才使用默認選項。
  • 調用該功能以顯示覆蓋圖像。

移除覆蓋

找到標記的代碼:

// ### Remove overlay ###

最初顯示疊加圖像時會調用此函數。函數中的邏輯檢查何時應刪除覆蓋圖像,包括是否設置了到期時間。此外,也會移除timeupdate事件偵聽程式。

添加疊加

找到標記的代碼:

// ### Add overlay function ###

使用用戶配置設置在此處調用覆蓋插件。這些設置確定應顯示的內容,顯示的位置以及顯示的時間。會新增timeupdate事件偵聽程式以檢查到期時間。

建置物overlayOptions

找到標記的代碼:

// ### Call function to merge default options with passed in options ###

定製配置選項和默認選項都傳遞給函數。僅當未傳入相應的自定義選項時,該函數才使用默認選項。

呼叫方showoverlay

找到標記的代碼:

// ### Show overlay ###

顯示覆蓋圖像的功能被調用。根據選項的不同,圖像可能會立即顯示或稍後顯示。

應用程式樣式

冗長的CSS定義了重疊圖像的外觀以及圖像的顯示位置。顯示覆蓋插件的默認 CSS 不是用於緩解 CSS 自定義。

外掛程式碼

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

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

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

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

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

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

在播放器上使用外掛程式

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

videojs.getPlayer('myPlayerID').ready(function() {
  var myPlayer = this;
  myPlayer.logoOverlay(
    {
      'align': 'bottom-left',
      'imageURL' : 'https://solutions.brightcove.com/bcls/brightcove-player/logo-overlay/bc-logo.png',
      'clickThruURL': 'https://support.brightcove.com/',
      'start': 'loadstart',
      'end': 5
    }
  )
});