播放器範例
以下CodePen中的視頻使用以下WebVTT文件定義字幕:
WEBVTT
00:00.000 --> 00:05.000 align:middle line:90%
The waves rhythmically pound against the rocks.
00:05.000 --> 00:10.000 align:middle line:84%
Here in the quaint village of Yachats on the central Oregon coast.
00:10.000 --> 00:15.000 align:middle line:84%
Come visit and enjoy the surf and sand.
00:15.000 --> 00:19.000 align:middle line:84%
Remember, it never rains on the Oregon coast!
範例會在控制列中提供「下載文字記錄」按鈕,該按鈕會下載已從檔案中刪除 WebVTT 格式的文字檔案。本質上,它允許用戶基於WebVTT文件的修改版本下載字幕的文字記錄。
看筆下載成績單通過 Brightcove 學習服務( @rcrooks1969) 在代碼筆 .
原始碼
在 GitHub 上查看完整的解決方案。
使用編碼器
以下是一些有效使用上述 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 方法 | API 事件 | API 屬性 |
---|---|---|
上() | 載入啟動 | 播放者 |
player.controlBar.customControlSpacer.el() |
播放器/HTML 配置
本節詳細說明玩家建立期間所需的任何特殊配置。此外,除了頁面內嵌播放程式實作程式碼之外,還會說明必須新增至頁面的其他 HTML 元素。
播放程式組態
您為此範例建立的 Brightcove 播放程式不需要特殊設定。
其他 HTML
不會將其他 HTML 元素新增至頁面。
應用程式流程
這個應用程序背後的基本邏輯是:
- 建立一個正則表達式以從文件中刪除WebVTT格式。
- 等待
loadstart
事件並擷取標題 WebVTT 檔案的 URL。 - 建立一個按鈕並將其放置在控制欄中。
- 按一下按鈕時,使用
XMLHttpRequest()
物件下載遠端 WebVTT 檔案。 - 使用
download
JavaScript 程式庫讓瀏覽器下載檔案。
定義正則表達式
找到標記的代碼:
// ### Define the regular expression ###
您需要創建一個正則表達式以從WebVTT文件中刪除所有不需要的格式。在這種情況下,正則表達式刪除以WEBVTT文件中定義時間的標準方式開頭的行。如果您不是正則表達式專家,您可能會發現 https://regexr.com/的幫助。
檢索URL並獲取文件
找到標記的代碼:
// ### Retrieve the URL for the text track, which is in this case a WebVTT caption file ###
您必須等待loadstart
事件存取包含文字軌跡資訊的mediainfo
屬性。請注意,如果網頁是從安全 ( https ) 頁面提供,您必須變更檔案的 URL,以使用安全連線。一旦你有正確的 URL,然後調用實際返回文件的getFile()
方法。最後,您可以使用 JavaScript replace()
方法搭配規則運算式來重新格式化文字。
建立一個按鈕並將其放置在控制欄中
找到標記的代碼:
// ### Create button and place in player ###
一個 HTML 按鈕元素被構建並放置在控制欄中。請注意,click
事件偵聽程式也會動態加入。在這種情況下,按鈕位於控制欄的spacer
區域中。如需有關的進一步詳細資訊spacer
,請參閱自訂播放程式外觀文件。
根據提供的URL獲取文件
找到標記的代碼:
// ### Function that gets the actual file based on URL ###
該函數使用 AJAX,通過一個XMLHttpRequest
對象,來檢索文件。異步行為要求使用回調函數。
將修改後的文件下載到用戶計算機
找到標記的代碼:
// ### download function used for graceful browser download ###
如本文檔前面所述,默認瀏覽器的行為很可能不是您希望發生的,這是一個新的選項卡或窗口正在打開以顯示文件。此JavaScript工具會強制下載文本文件。
應用程式樣式
CSS在控制欄中設置按鈕的顏色和位置。
外掛程式碼
通常,當將 JavaScript 轉換為布萊特灣播放器插件名義更改時,需要更改。其中一項必要的變更是以定義外掛程ready()
式的程式碼取代方法的標準使用方法。
以下是將與播放器一起使用的 JavaScript 代碼的常用開始:
videojs.getPlayer('myPlayerID').ready(function() {
var myPlayer = this;
});
您將變更第一行,以使用標準語法來啟動 Brightcove 播放程式外掛程式:
videojs.registerPlugin('pluginName', function(options) {
var myPlayer = this;
...
});
如前所述,您可以在本文檔的相應 GitHub 存儲庫:download-transcript.js 中看到該插件的 JavaScript 代碼。
在播放器上使用外掛程式
一旦您將插件的 CSS 和 JavaScript 文件存儲在可訪問互聯網的位置,您可以使用該插件與播放器。在工作室的播放器模塊中,您可以選擇一個播放器,然後在插件部分將 URL 添加到 CSS 和 JavaScript 文件中,如果需要選項,還可以添加名稱和選項。