布萊特灣球員樣本:與模式對話框的年齡門

在本主題中,您將學習如何使用帶有簡單年齡門模式窗口的Brightcove Player。用戶必須在視頻播放之前單擊模態窗口來證明自己的年齡。

播放器範例

本示例使用ModalDialog最初覆蓋播放器。當用戶通過單擊模態窗口確認年齡時,將顯示控件並播放視頻。通過單擊模式窗口上的任意位置來測試功能。

看筆18193-brightcove-player-sample-age-gate-modaldialog通過 Brightcove 學習服務( @bcls1969) 在代碼筆 .

原始碼

在 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 事件 ModalDialog API方法
添加孩子() 準備 打開()
    上()
    關閉()

播放器/HTML 配置

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

應用程式流程

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

  • 顯示帶有文本的可點擊ModalDialog。
  • 當用戶單擊ModalDialog文本時,關閉ModalDialog並開始視頻播放。

顯示ModalDialog文本

加載視頻後立即顯示ModalDialog。年齡門文本被定義為ModalDialog的選項。

配置ModalDialog

找到標記的代碼:

// +++ Configure the ModalDialog +++

創建一個選項對象,並為模態對話框類設置屬性。如需有關此物件的詳細資訊,請參閱實作模式對話方塊文件。在這裡,我們執行以下操作:

  • 定義年齡門文字
  • 將對話框設置為臨時對話框,以便我們將其關閉
  • 隱藏對話框上的關閉按鈕

實例化並打開ModalDialog

找到標記的代碼:

// +++ Instantiate and open the ModalDialog +++

使用我們的年齡門文本實例化對話框,將其添加到播放器並打開對話框。

在ModalDialog上監聽click事件

找到標記的代碼:

// +++ Listen for the click event on the ModalDialog +++

在模式對話框中,為該事件添加一個事click件偵聽器。當用戶選擇年齡門文字時,關閉對話框並開始視頻播放。

應用程式樣式

CSS設置樣式並在ModalDialog中放置年齡門文本。

外掛程式碼

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

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

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

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

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

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

在播放器上使用外掛程式

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