這是 HTML5 系列教學的第三篇,也是最後一篇。前兩篇介紹了 video 與 audio 元素,並示範如何加上 controls 屬性,讓瀏覽器提供預設控制條。試過的人應該都注意到一件事:各瀏覽器的預設外觀並不一致。
如果你希望媒體元件在各瀏覽器下呈現一致的外觀,好消息是:HTML5 媒體元素提供了完整的 API。你可以用標準的 HTML 與 CSS 控制播放器的樣子,再用媒體元素的 API 去操作 audio 與 video。
本篇會一步步示範如何打造自訂媒體播放器,並示範各項 API 屬性、事件與方法的用法。以下以影片為例,音訊的處理方式完全相同。
<video id="video" controls> <source src="grass-in-the-wind-sma.mp4" type="video/mp4"> <source src="grass-in-the-wind-sma.webm" type="video/webm"> </video>
這裡刻意保留了 controls 屬性,是為了在 JavaScript 失效時,用戶仍能使用瀏覽器內建的控制條。等到自訂控制就緒,再用 JavaScript 把預設控制關掉:
<script>
var video = document.getElementById("video");
video.controls = false; // 關閉預設控制
</script>
最基礎的需求。這裡只用一個按鈕,暫停時顯示「播放」,播放中顯示「暫停」。
<div id="controls"> <button id="playpause" title="play" onclick="togglePlayPause()">Play</button> </div>
對應的 JavaScript:
function togglePlayPause() {
var playpause = document.getElementById("playpause");
if (video.paused || video.ended) {
playpause.title = "pause";
playpause.innerHTML = "pause";
video.play();
} else {
playpause.title = "play";
playpause.innerHTML = "play";
video.pause();
}
}
第一行先取得按鈕自身的參照,接著用 paused 與 ended 兩個屬性判斷影片狀態:若目前處於暫停或已播放結束,就把按鈕文字改為「pause」並呼叫 video.play();否則視為正在播放,把文字改回「play」並呼叫 video.pause()。
接下來的所有功能其實都遵循同一個模式:為 video 元素掛上事件、檢查當前狀態、呼叫對應的 API 方法。
音量滑桿可以直接用 HTML5 新的 input 類型 range 來做:
<input id="volume" min="0" max="1" step="0.1" type="range" onchange="setVolume()" />
min 與 max 決定範圍,step 決定每次滑動的幅度。滑動時觸發 onchange 去調整音量:
function setVolume() {
var volume = document.getElementById("volume");
video.volume = volume.value;
}
靜音按鈕更簡單:
<button id="mute" onclick="toggleMute()">Mute</button>
function toggleMute() {
video.muted = !video.muted;
}
把 muted 這個布林屬性設為相反值,就完成了一次靜音切換。
用戶習慣知道已經播了多少、還剩多少。用 div 與 span 就能做出一條簡易進度條,靠改變 span 的寬度來顯示進度。
<div id="progressBar"> <span id="progress"></span> </div>
#progressBar {
border: 1px solid #aaa;
color: #fff;
width: 295px;
height: 20px;
}
#progress {
background-color: #ff0000;
height: 20px;
display: inline-block;
}
function updateProgress() {
var progress = document.getElementById("progress");
var value = 0;
if (video.currentTime > 0) {
value = Math.floor((100 / video.duration) * video.currentTime);
}
progress.style.width = value + "%";
}
currentTime 代表當前播放位置(秒),duration 代表總長度(秒),兩者相除再乘上 100 就是百分比,最後寫進 span 的 CSS width。
注意這裡不能再用 onclick 或 onchange:進度條反映的是影片自身的時間流動,而不是用戶的點擊。這種情況必須改用事件監聽。媒體元素 API 提供了 timeupdate 事件,每當 currentTime 改變就會觸發:
video.addEventListener("timeupdate", updateProgress, false);
媒體元素 API 定義了許多事件,幾個常用的包括:
- playing:從暫停恢復播放時觸發
- play:暫停解除、播放恢復時觸發
- pause:呼叫 pause() 使媒體進入暫停時觸發
- ended:播放到結尾停止時觸發
- timeupdate:播放位置改變時觸發
- volumechange:音量或靜音狀態改變時觸發
為什麼要監聽這些事件?因為介面很容易不同步。用 JavaScript 關掉預設控制之後,用戶仍可能透過其他途徑操作影片——例如在 Firefox 的影片上按右鍵,選單裡一樣有播放、暫停等選項。一旦用戶從那裡操作,你自訂的按鈕就可能顯示錯誤的狀態。
好消息是,無論從哪個入口操作,對應事件都會照常觸發,因此只要監聽 play 與 pause 就能補回同步:
video.addEventListener('play', function() {
var playpause = document.getElementById("playpause");
playpause.title = "pause";
playpause.innerHTML = "pause";
}, false);
video.addEventListener('pause', function() {
var playpause = document.getElementById("playpause");
playpause.title = "play";
playpause.innerHTML = "play";
}, false);
另外也建議監聽 ended,讓影片結束時按鈕能即時回到初始狀態:
video.addEventListener('ended', function() {
this.pause();
}, false);
這裡刻意呼叫 pause(),是因為它會觸發 pause 事件,進而重用上面寫好的 pause 監聽器。當然,你也可以直接把程式碼複製進 ended 的監聽器中,或在此處額外定義其他收尾行為。
最後一個功能是播放清單,讓用戶切換要播放的影片。
<ul id="playlist">
<li><a href="#" onclick="playlistClick('grass-in-the-wind-sma');">Grass blowing in the wind</a></li>
<li><a href="#" onclick="playlistClick('tree-in-the-wind-sma');">Trees blowing in the wind</a></li>
</ul>
每個項目都呼叫 playlistClick(),參數是不含副檔名的檔案名稱:
function playlistClick(file) {
var v = document.createElement("video");
if (v.canPlayType("video/mp4") != "") {
changeSource(file + ".mp4");
} else if (v.canPlayType("video/webm") != "") {
changeSource(file + ".webm");
}
return false; // 避免 href 的預設跳轉
}
它先建立一個臨時 video 元素,用 canPlayType() 探測瀏覽器支援的格式,再把帶有正確副檔名的路徑交給 changeSource()。
function changeSource(src) {
resetPlayer();
video.src = src;
video.load();
}
並非所有瀏覽器都要求呼叫 load(),但 Safari 需要,因此養成呼叫的習慣比較保險。
resetPlayer() 負責把播放器各元件回復初始狀態,準備載入新影片:
function resetPlayer() {
var playpause = document.getElementById("playpause");
playpause.title = "play";
playpause.innerHTML = "play";
if (video.currentTime > 0) video.currentTime = 0;
updateProgress();
}
先把按鈕文字設回「play」,再把 currentTime 歸零,最後呼叫 updateProgress() 讓進度條回到起點。
到這裡,一個具備播放、暫停、音量、靜音、進度條與播放清單的 HTML5 播放器就完成了。它的外觀也許還很樸素,但透過 CSS 樣式隨時可以改頭換面。若想進一步了解媒體元素 API 的完整屬性與事件,可以參考 W3C 的 HTML5 Video Events and API 示範頁面,那裡會同步顯示 API 屬性與事件狀態,是很理想的對照教材。