1. 簡介
WebRTC 是一項開放原始碼專案,可讓網頁和原生應用程式即時傳輸音訊、影片和資料。
WebRTC 有多個 JavaScript API,點選連結即可查看示範。
getUserMedia():擷取音訊和影片。MediaRecorder:錄製音訊和影片。RTCPeerConnection:在使用者之間串流播放音訊和影片。RTCDataChannel:在使用者之間串流資料。
哪裡可以使用 WebRTC?
Firefox、Opera,以及 Chrome 電腦版和 Android 版。WebRTC 也適用於 iOS 和 Android 的原生應用程式。
什麼是信號?
WebRTC 使用 RTCPeerConnection 在瀏覽器之間傳送串流資料,但也需要協調通訊和傳送控制訊息的機制,這個程序稱為信號。WebRTC 未指定信號方法和通訊協定。在本程式碼實驗室中,您將使用 Socket.IO 傳送訊息,但還有許多替代方案。
什麼是 STUN 和 TURN?
WebRTC 採用點對點設計,可讓使用者透過最直接的路徑連線。不過,WebRTC 是為了因應實際網路環境而建構:用戶端應用程式需要周遊網路位址轉譯 (NAT) 閘道和防火牆,而點對點網路則需要備用方案,以防直接連線失敗。在這個過程中,WebRTC API 會使用 STUN 伺服器取得電腦的 IP 位址,並使用 TURN 伺服器做為中繼伺服器,以防點對點通訊失敗。(詳情請參閱「WebRTC in the real world」)。
WebRTC 安全嗎?
所有 WebRTC 元件都必須加密,且其 JavaScript API 只能從安全來源 (HTTPS 或 localhost) 使用。WebRTC 標準並未定義信號機制,因此您必須確保使用安全通訊協定。
2. 總覽
建構應用程式,使用網路攝影機取得影片和拍攝快照,並透過 WebRTC 與其他使用者分享。過程中,您將瞭解如何使用核心 WebRTC API,以及如何使用 Node.js 設定訊息伺服器。
課程內容
- 取得網路攝影機的影片
- 使用 RTCPeerConnection 串流播放影片
- 使用 RTCDataChannel 串流資料
- 設定信號服務來交換訊息
- 結合對等互連連線和信號
- 拍照並透過資料管道分享
軟硬體需求
- Chrome 47 以上版本
- Web Server for Chrome,或使用您選擇的網路伺服器。
- 程式碼範例
- 文字編輯器
- 具備 HTML、CSS 和 JavaScript 的基本知識
3. 取得程式碼範例
下載程式碼
如果您熟悉 Git,可以從 GitHub 複製這個程式碼實驗室的程式碼:
git clone https://github.com/googlecodelabs/webrtc-web
或者,您也可以點選下列按鈕,下載程式碼的 .zip 檔案:
開啟下載的 ZIP 檔案。這項操作會解壓縮專案資料夾 (adaptive-web-media),其中包含本程式碼實驗室每個步驟各自對應的資料夾,以及所有必要資源。
您會在名為 work 的目錄中執行所有程式碼編寫工作。
step-nn 資料夾包含本程式碼實驗室各步驟的完成版本。僅供參考。
安裝及驗證網路伺服器
雖然您可以使用自己的網路伺服器,但本程式碼實驗室是專為與 Chrome 網路伺服器搭配使用而設計。如果尚未安裝,可以前往 Chrome 線上應用程式商店下載。

安裝 Web Server for Chrome 應用程式後,請點選書籤列、新分頁或應用程式啟動器中的 Chrome 應用程式捷徑:

按一下「Web Server」圖示:

接著,您會看到以下對話方塊,可用來設定本機網路伺服器:

按一下「選擇資料夾」按鈕,然後選取剛建立的 work 資料夾。這樣一來,您就能在 Chrome 中使用「Web Server URL(s)」部分「Web Server」對話方塊中醒目顯示的網址,查看進行中的工作。
在「Options」下方,勾選「Automatically show index.html」旁的方塊,如下所示:

接著,將標示為「Web Server: STARTED」的切換鈕滑到左側,再滑回右側,即可停止並重新啟動伺服器。

現在,請在網路瀏覽器中點選醒目顯示的網路伺服器網址,前往工作網站。您應該會看到類似下方的頁面,對應 work/index.html:

顯然,這個應用程式還沒有任何有趣的功能。到目前為止,它只是我們用來確保網路伺服器正常運作的最小骨架。您將在後續步驟中新增功能和版面配置。
4. 透過網路攝影機串流播放影片
課程內容
在這個步驟中,您將瞭解如何:
- 從網路攝影機取得影片串流。
- 操控串流播放。
- 使用 CSS 和 SVG 操控影片。
這個步驟的完整版本位於 step-01 資料夾中。
一點 HTML...
在 work 目錄的 index.html 中,新增 video 元素和 script 元素:
<!DOCTYPE html>
<html>
<head>
<title>Realtime communication with WebRTC</title>
<link rel="stylesheet" href="css/main.css">
</head>
<body>
<h1>Realtime communication with WebRTC</h1>
<video autoplay playsinline></video>
<script src="js/main.js"></script>
</body>
</html>
...以及一點 JavaScript
在 js 資料夾的 main.js 中加入以下內容:
'use strict';
// On this codelab, you will be streaming only video (video: true).
const mediaStreamConstraints = {
video: true,
};
// Video element where stream will be placed.
const localVideo = document.querySelector('video');
// Local stream that will be reproduced on the video.
let localStream;
// Handles success by adding the MediaStream to the video element.
function gotLocalMediaStream(mediaStream) {
localStream = mediaStream;
localVideo.srcObject = mediaStream;
}
// Handles error by logging a message to the console with the error message.
function handleLocalMediaStreamError(error) {
console.log('navigator.getUserMedia error: ', error);
}
// Initializes media stream.
navigator.mediaDevices.getUserMedia(mediaStreamConstraints)
.then(gotLocalMediaStream).catch(handleLocalMediaStreamError);
試試看
在瀏覽器中開啟 index.html,應該會看到類似下方的畫面 (當然,畫面會顯示網路攝影機的影像):

運作方式
呼叫 getUserMedia() 後,瀏覽器會要求使用者授予相機存取權 (如果這是目前來源首次要求相機存取權)。如果成功,系統會傳回 MediaStream,媒體元素可使用 srcObject 屬性來使用該串流:
navigator.mediaDevices.getUserMedia(mediaStreamConstraints)
.then(gotLocalMediaStream).catch(handleLocalMediaStreamError);
}
function gotLocalMediaStream(mediaStream) {
localVideo.srcObject = mediaStream;
}
constraints 引數可讓您指定要取得的媒體。在這個範例中,由於音訊預設為停用,因此只會錄製影片:
const mediaStreamConstraints = {
video: true,
};
您可以使用限制條件來指定其他要求,例如影片解析度:
const hdConstraints = {
video: {
width: {
min: 1280
},
height: {
min: 720
}
}
}
MediaTrackConstraints 規格列出所有可能的限制類型,但並非所有瀏覽器都支援所有選項。如果所選相機不支援要求的解析度,系統會拒絕 getUserMedia() 並傳回 OverconstrainedError,且不會提示使用者授予相機存取權。
如果 getUserMedia() 成功,網路攝影機的影片串流會設為影片元素的來源:
function gotLocalMediaStream(mediaStream) {
localVideo.srcObject = mediaStream;
}
獎勵分數
- 傳遞至
getUserMedia()的localStream物件位於全域範圍,因此您可以透過瀏覽器控制台檢查:開啟控制台,輸入 stream,然後按下 Return 鍵。(如要在 Chrome 中查看控制台,請按下 Ctrl-Shift-J 鍵,或在 Mac 上按下 Command-Option-J 鍵)。 localStream.getVideoTracks()會傳回什麼?- 試著撥打
localStream.getVideoTracks()[0].stop()。 - 查看 constraints 物件:如果將其變更為
{audio: true, video: true},會發生什麼情況? - 影片元素的大小為何?如何透過 JavaScript 取得影片的原始大小,而非顯示大小?請使用 Chrome 開發人員工具檢查。
- 請嘗試在影片元素中加入 CSS 濾鏡。例如:
video {
filter: blur(4px) invert(1) opacity(0.5);
}
- 請嘗試新增 SVG 濾鏡。例如:
video {
filter: hue-rotate(180deg) saturate(200%);
}
您學到的內容
在這個步驟中,您學到了如何:
- 取得網路攝影機的影片。
- 設定媒體限制。
- 干擾影片元素。
這個步驟的完整版本位於 step-01 資料夾中。
提示
- 別忘了
video元素上的autoplay屬性。否則只會看到單一影格! getUserMedia()限制還有許多其他選項。請前往 webrtc.github.io/samples/src/content/peerconnection/constraints 查看示範。如您所見,該網站上有許多有趣的 WebRTC 範例。
最佳做法
- 請確認影片元素未超出容器範圍。我們新增了
width和max-width,用於設定影片的首選大小和大小上限。瀏覽器會自動計算高度:
video {
max-width: 100%;
width: 320px;
}
下一步
你已經有影片了,但要如何串流播放呢?請在下一個步驟中找出答案!
5. 使用 RTCPeerConnection 串流播放影片
課程內容
在這個步驟中,您將瞭解如何:
- 使用 WebRTC 填充碼 adapter.js 消除瀏覽器差異。
- 使用 RTCPeerConnection API 串流播放影片。
- 控制媒體擷取和串流。
這個步驟的完整版本位於 step-2 資料夾中。
什麼是 RTCPeerConnection?
RTCPeerConnection 是一種 API,用於發起 WebRTC 通話,串流視訊和音訊,以及交換資料。
這個範例會在同一個頁面上的兩個 RTCPeerConnection 物件 (稱為對等互連) 之間建立連線。
雖然不太實用,但有助於瞭解 RTCPeerConnection 的運作方式。
新增影片元素和控制按鈕
在 index.html 中,將單一影片元素替換為兩個影片元素和三個按鈕:
<video id="localVideo" autoplay playsinline></video>
<video id="remoteVideo" autoplay playsinline></video>
<div>
<button id="startButton">Start</button>
<button id="callButton">Call</button>
<button id="hangupButton">Hang Up</button>
</div>
一個影片元素會顯示 getUserMedia() 的串流,另一個則會顯示使用 RTCPeerconnection 串流的相同影片。(在實際應用中,一個影片元素會顯示本機串流,另一個則顯示遠端串流)。
新增 adapter.js 填充碼
在 main.js 連結上方,新增目前版本 adapter.js 的連結:
<script src="https://webrtc.github.io/adapter/adapter-latest.js"></script>
Index.html 現在應如下所示:
<!DOCTYPE html>
<html>
<head>
<title>Realtime communication with WebRTC</title>
<link rel="stylesheet" href="css/main.css">
</head>
<body>
<h1>Realtime communication with WebRTC</h1>
<video id="localVideo" autoplay playsinline></video>
<video id="remoteVideo" autoplay playsinline></video>
<div>
<button id="startButton">Start</button>
<button id="callButton">Call</button>
<button id="hangupButton">Hang Up</button>
</div>
<script src="https://webrtc.github.io/adapter/adapter-latest.js"></script>
<script src="js/main.js"></script>
</body>
</html>
安裝 RTCPeerConnection 程式碼
將 main.js 替換為 step-02 資料夾中的版本。
撥打電話
開啟 index.html,點選「Start」按鈕,從網路攝影機取得影片,然後點選「Call」建立對等互連連線。兩個影片元素中應會顯示相同的影片 (來自網路攝影機)。查看瀏覽器控制台,瞭解 WebRTC 記錄。
運作方式
這個步驟會執行許多操作...
WebRTC 會使用 RTCPeerConnection API 建立連線,在 WebRTC 用戶端 (稱為「對等互連」) 之間串流影片。
在這個範例中,兩個 RTCPeerConnection 物件位於同一個頁面:pc1 和 pc2。雖然實用性不高,但很適合用來示範 API 的運作方式。
在 WebRTC 對等互連之間設定通話涉及三項工作:
- 為通話的每一端建立 RTCPeerConnection,並在每一端新增來自
getUserMedia()的本機串流。 - 取得及分享網路資訊:潛在連線端點稱為 ICE 候選端點。
- 取得及分享本機和遠端描述:SDP 格式的本機媒體中繼資料。
假設 Alice 和 Bob 想使用 RTCPeerConnection 設定視訊通訊。
首先,莉莉和阿超交換網路資訊。「尋找候選項目」是指使用 ICE 架構尋找網路介面和通訊埠的程序。
- Alice 使用
onicecandidate (addEventListener('icecandidate'))處理常式建立 RTCPeerConnection 物件。這對應於 main.js 中的下列程式碼:
let localPeerConnection;
localPeerConnection = new RTCPeerConnection(servers);
localPeerConnection.addEventListener('icecandidate', handleConnection);
localPeerConnection.addEventListener(
'iceconnectionstatechange', handleConnectionChange);
- Alice 呼叫
getUserMedia(),並新增傳遞至該函式的串流:
navigator.mediaDevices.getUserMedia(mediaStreamConstraints).
then(gotLocalMediaStream).
catch(handleLocalMediaStreamError);
function gotLocalMediaStream(mediaStream) {
localVideo.srcObject = mediaStream;
localStream = mediaStream;
trace('Received local stream.');
callButton.disabled = false; // Enable call button.
}
localPeerConnection.addStream(localStream);
trace('Added local stream to localPeerConnection.');
- 當有可用的候選網路時,系統會呼叫步驟 1 的
onicecandidate處理常式。 - Alice 將序列化的候選資料傳送給 Bob。在實際應用程式中,這項程序 (稱為「信號」) 是透過訊息服務進行,您會在後續步驟中瞭解如何操作。當然,在這個步驟中,兩個 RTCPeerConnection 物件位於同一個頁面,可以直接通訊,不需要外部訊息。
- Bob 收到 Alice 的候選訊息時,會呼叫
addIceCandidate(),將候選項目新增至遠端對等互連說明:
function handleConnection(event) {
const peerConnection = event.target;
const iceCandidate = event.candidate;
if (iceCandidate) {
const newIceCandidate = new RTCIceCandidate(iceCandidate);
const otherPeer = getOtherPeer(peerConnection);
otherPeer.addIceCandidate(newIceCandidate)
.then(() => {
handleConnectionSuccess(peerConnection);
}).catch((error) => {
handleConnectionFailure(peerConnection, error);
});
trace(`${getPeerName(peerConnection)} ICE candidate:\n` +
`${event.candidate.candidate}.`);
}
}
WebRTC 對等互連也需要找出並交換本機和遠端音訊和視訊媒體資訊,例如解析度和轉碼器功能。交換媒體設定資訊的信號傳遞,是透過交換中繼資料 blob 進行,稱為「offer」和「answer」,使用工作階段描述通訊協定格式,稱為「SDP」:
- Alice 執行 RTCPeerConnection
createOffer()方法。傳回的 Promise 會提供 RTCSessionDescription:小愛本機工作階段說明:
trace('localPeerConnection createOffer start.');
localPeerConnection.createOffer(offerOptions)
.then(createdOffer).catch(setSessionDescriptionError);
- 如果成功,Alice 會使用
setLocalDescription()設定本機說明,然後使用信號管道將這個工作階段說明傳送給 Bob。 - Bob 使用
setRemoteDescription()將 Alice 傳送給他的說明設為遠端說明。 - Bob 執行 RTCPeerConnection
createAnswer()方法,並傳遞從 Alice 取得的遠端描述,以便產生與 Alice 相容的本機工作階段。createAnswer()承諾會傳遞 RTCSessionDescription:Bob 將其設為本機說明,並傳送給 Alice。 - Alice 收到 Bob 的工作階段說明後,會使用
setRemoteDescription()將其設為遠端說明。
// Logs offer creation and sets peer connection session descriptions.
function createdOffer(description) {
trace(`Offer from localPeerConnection:\n${description.sdp}`);
trace('localPeerConnection setLocalDescription start.');
localPeerConnection.setLocalDescription(description)
.then(() => {
setLocalDescriptionSuccess(localPeerConnection);
}).catch(setSessionDescriptionError);
trace('remotePeerConnection setRemoteDescription start.');
remotePeerConnection.setRemoteDescription(description)
.then(() => {
setRemoteDescriptionSuccess(remotePeerConnection);
}).catch(setSessionDescriptionError);
trace('remotePeerConnection createAnswer start.');
remotePeerConnection.createAnswer()
.then(createdAnswer)
.catch(setSessionDescriptionError);
}
// Logs answer to offer creation and sets peer connection session descriptions.
function createdAnswer(description) {
trace(`Answer from remotePeerConnection:\n${description.sdp}.`);
trace('remotePeerConnection setLocalDescription start.');
remotePeerConnection.setLocalDescription(description)
.then(() => {
setLocalDescriptionSuccess(remotePeerConnection);
}).catch(setSessionDescriptionError);
trace('localPeerConnection setRemoteDescription start.');
localPeerConnection.setRemoteDescription(description)
.then(() => {
setRemoteDescriptionSuccess(localPeerConnection);
}).catch(setSessionDescriptionError);
}
- Ping!
獎勵分數
- 請查看 chrome://webrtc-internals。這項工具會提供 WebRTC 統計資料和偵錯資料。(如需 Chrome 網址的完整清單,請前往 chrome://about)。
- 使用 CSS 設定網頁樣式:
- 將影片並排顯示。
- 將按鈕設為相同寬度,並放大文字。
- 確認版面配置在行動裝置上能正常運作。
- 在 Chrome 開發人員工具控制台中,查看
localStream、localPeerConnection和remotePeerConnection。 - 在控制台中查看
localPeerConnectionpc1.localDescription。SDP 格式是什麼樣子?
您學到的內容
在這個步驟中,您學到了如何:
- 使用 WebRTC 填充碼 adapter.js 消除瀏覽器差異。
- 使用 RTCPeerConnection API 串流播放影片。
- 控制媒體擷取和串流。
- 在對等互連之間共用媒體和網路資訊,以便進行 WebRTC 通話。
這個步驟的完整版本位於 step-2 資料夾中。
提示
- 這個步驟有許多內容需要學習!如要尋找其他資源,進一步瞭解 RTCPeerConnection,請前往 webrtc.org。如果您想使用 WebRTC,但不想處理 API,本頁面提供 JavaScript 架構的建議。
- 如要進一步瞭解 adapter.js 填充碼,請前往 adapter.js GitHub 存放區。
- 想知道全球最棒的視訊通訊應用程式是什麼樣子嗎?請參閱 AppRTC,這是 WebRTC 專案的標準應用程式,用於 WebRTC 通話:應用程式、程式碼。通話設定時間不到 500 毫秒。
最佳做法
- 為確保程式碼日後仍可正常運作,請使用新的 Promise 型 API,並透過 adapter.js 啟用與不支援這些 API 的瀏覽器相容。
下一步
這個步驟說明如何使用 WebRTC 在對等互連之間串流影片,但本程式碼實驗室也與資料有關!
在下一個步驟中,您將瞭解如何使用 RTCDataChannel 串流任意資料。
6. 使用 RTCDataChannel 交換資料
課程內容
- 如何在 WebRTC 端點 (對等互連) 之間交換資料。
這個步驟的完整版本位於 step-03 資料夾中。
更新 HTML
在這個步驟中,您將使用 WebRTC 資料管道,在同一頁面的兩個 textarea 元素之間傳送文字。這項功能雖然不太實用,但確實展示了如何使用 WebRTC 分享資料和串流影片。
從 index.html 中移除影片和按鈕元素,並替換為下列 HTML:
<textarea id="dataChannelSend" disabled
placeholder="Press Start, enter some text, then press Send."></textarea>
<textarea id="dataChannelReceive" disabled></textarea>
<div id="buttons">
<button id="startButton">Start</button>
<button id="sendButton">Send</button>
<button id="closeButton">Stop</button>
</div>
一個文字區域用於輸入文字,另一個則會顯示在對等互連之間串流的文字。
index.html 現在應如下所示:
<!DOCTYPE html>
<html>
<head>
<title>Realtime communication with WebRTC</title>
<link rel="stylesheet" href="css/main.css">
</head>
<body>
<h1>Realtime communication with WebRTC</h1>
<textarea id="dataChannelSend" disabled
placeholder="Press Start, enter some text, then press Send."></textarea>
<textarea id="dataChannelReceive" disabled></textarea>
<div id="buttons">
<button id="startButton">Start</button>
<button id="sendButton">Send</button>
<button id="closeButton">Stop</button>
</div>
<script src="https://webrtc.github.io/adapter/adapter-latest.js"></script>
<script src="js/main.js"></script>
</body>
</html>
更新 JavaScript
將 main.js 替換為 step-03/js/main.js 的內容。
試著在對等互連之間串流資料:開啟 index.html,按下「Start」設定對等互連連線,在左側的 textarea 中輸入一些文字,然後按一下「Send」,使用 WebRTC 資料管道傳輸文字。
運作方式
這段程式碼使用 RTCPeerConnection 和 RTCDataChannel 啟用文字訊息交換功能。
這個步驟中的大部分程式碼都與 RTCPeerConnection 範例相同。
sendData() 和 createConnection() 函式包含大部分的新程式碼:
function createConnection() {
dataChannelSend.placeholder = '';
var servers = null;
pcConstraint = null;
dataConstraint = null;
trace('Using SCTP based data channels');
// For SCTP, reliable and ordered delivery is true by default.
// Add localConnection to global scope to make it visible
// from the browser console.
window.localConnection = localConnection =
new RTCPeerConnection(servers, pcConstraint);
trace('Created local peer connection object localConnection');
sendChannel = localConnection.createDataChannel('sendDataChannel',
dataConstraint);
trace('Created send data channel');
localConnection.onicecandidate = iceCallback1;
sendChannel.onopen = onSendChannelStateChange;
sendChannel.onclose = onSendChannelStateChange;
// Add remoteConnection to global scope to make it visible
// from the browser console.
window.remoteConnection = remoteConnection =
new RTCPeerConnection(servers, pcConstraint);
trace('Created remote peer connection object remoteConnection');
remoteConnection.onicecandidate = iceCallback2;
remoteConnection.ondatachannel = receiveChannelCallback;
localConnection.createOffer().then(
gotDescription1,
onCreateSessionDescriptionError
);
startButton.disabled = true;
closeButton.disabled = false;
}
function sendData() {
var data = dataChannelSend.value;
sendChannel.send(data);
trace('Sent Data: ' + data);
}
RTCDataChannel 的語法刻意與 WebSocket 類似,具有 send() 方法和 message 事件。
請注意 dataConstraint 的用法。您可以設定資料管道,啟用不同類型的資料共用,例如優先考量可靠的傳送,而非效能。如要進一步瞭解選項,請前往 Mozilla 開發人員網路。
獎勵分數
- SCTP 是 WebRTC 資料通道使用的通訊協定,預設會啟用可靠且依序傳輸資料的功能。RTCDataChannel 什麼時候需要提供可靠的資料傳輸,什麼時候效能可能更重要,即使這意味著會遺失部分資料?
- 使用 CSS 改善網頁版面配置,並在「dataChannelReceive」文字區域中加入預留位置屬性。
- 在行動裝置上測試網頁。
您學到的內容
在這個步驟中,您學到了如何:
- 在兩個 WebRTC 對等互連之間建立連線。
- 在對等互連之間交換文字資料。
這個步驟的完整版本位於 step-03 資料夾中。
瞭解詳情
- WebRTC 資料管道 (雖然是幾年前的文章,但仍值得一讀)
- Why was SCTP Selected for WebRTC's Data Channel?
下一步
您已瞭解如何在同一頁面的對等互連之間交換資料,但如何在不同機器之間執行這項操作?首先,您需要設定信號通道,以便交換中繼資料訊息。請在下一個步驟中瞭解做法!
7. 設定信號服務來交換訊息
課程內容
在這個步驟中,您將瞭解如何:
- 使用
npm安裝 package.json 中指定的專案依附元件 - 執行 Node.js 伺服器,並使用 node-static 提供靜態檔案。
- 使用 Socket.IO 在 Node.js 上設定訊息服務。
- 你可以使用這項功能建立「聊天室」並交換訊息。
這個步驟的完整版本位於 step-04 資料夾中。
概念
為了設定及維護 WebRTC 通話,WebRTC 用戶端 (對等互連) 必須交換中繼資料:
- 候選 (聯播網) 資訊。
- Offer 和 answer 訊息,提供媒體相關資訊,例如解析度和轉碼器。
換句話說,必須先交換中繼資料,才能進行音訊、影片或資料的點對點串流。這項程序稱為「信號傳遞」。
在先前的步驟中,傳送端和接收端的 RTCPeerConnection 物件位於同一個頁面,因此「信號」只是在物件之間傳遞中繼資料。
在實際應用程式中,傳送端和接收端的 RTCPeerConnection 會在不同裝置的網頁上執行,因此您需要讓兩者能通訊中繼資料。
為此,您需要使用信號伺服器:可在 WebRTC 用戶端 (對等互連) 之間傳遞訊息的伺服器。實際訊息為純文字:字串化的 JavaScript 物件。
必要條件:安裝 Node.js
如要執行本程式碼實驗室的後續步驟 (step-04 至 step-06 資料夾),您必須使用 Node.js 在 localhost 上執行伺服器。
您可以直接從 Node.js 網站下載並安裝 Node.js,或使用偏好的套件管理工具。
安裝完成後,您就能匯入後續步驟所需的依附元件 (執行 npm install),以及執行小型 localhost 伺服器來執行程式碼實驗室 (執行 node index.js)。稍後需要時,系統會顯示這些指令。
關於應用程式
WebRTC 使用用戶端 JavaScript API,但實際使用時也需要信號 (訊息) 伺服器,以及 STUN 和 TURN 伺服器。進一步瞭解 WebRTC 基礎架構。
在這個步驟中,您將使用 Socket.IO Node.js 模組和 JavaScript 程式庫傳送訊息,建構簡單的 Node.js 信號伺服器。具備 Node.js 和 Socket.IO 的使用經驗會有所幫助,但沒有也無妨,因為訊息元件相當簡單。
在這個範例中,伺服器 (Node.js 應用程式) 是在 index.js 中實作,而用戶端 (網頁應用程式) 則是在 index.html 中實作。
這個步驟中的 Node.js 應用程式有兩項工作。
首先,它會轉發訊息:
socket.on('message', function (message) {
log('Got message: ', message);
socket.broadcast.emit('message', message);
});
第二,管理 WebRTC 視訊通訊「聊天室」:
if (numClients === 0) {
socket.join(room);
socket.emit('created', room, socket.id);
} else if (numClients === 1) {
socket.join(room);
socket.emit('joined', room, socket.id);
io.sockets.in(room).emit('ready');
} else { // max two clients
socket.emit('full', room);
}
我們的 WebRTC 應用程式最多允許兩個對等互連共用一個聊天室。
HTML 和 JavaScript
更新 index.html,如下所示:
<!DOCTYPE html>
<html>
<head>
<title>Realtime communication with WebRTC</title>
<link rel="stylesheet" href="css/main.css">
</head>
<body>
<h1>Realtime communication with WebRTC</h1>
<script src="/socket.io/socket.io.js"></script>
<script src="js/main.js"></script>
</body>
</html>
在這個步驟中,頁面上不會顯示任何內容,所有記錄都會傳送至瀏覽器控制台。(如要在 Chrome 中查看控制台,請按下 Ctrl-Shift-J 鍵,或在 Mac 上按下 Command-Option-J 鍵)。
將 js/main.js 替換為以下內容:
'use strict';
var isInitiator;
window.room = prompt("Enter room name:");
var socket = io.connect();
if (room !== "") {
console.log('Message from client: Asking to join room ' + room);
socket.emit('create or join', room);
}
socket.on('created', function(room, clientId) {
isInitiator = true;
});
socket.on('full', function(room) {
console.log('Message from client: Room ' + room + ' is full :^(');
});
socket.on('ipaddr', function(ipaddr) {
console.log('Message from client: Server IP address is ' + ipaddr);
});
socket.on('joined', function(room, clientId) {
isInitiator = false;
});
socket.on('log', function(array) {
console.log.apply(console, array);
});
設定 Socket.IO 以在 Node.js 上執行
在 HTML 檔案中,您可能已看到正在使用 Socket.IO 檔案:
<script src="/socket.io/socket.io.js"></script>
在 work 目錄的最上層,建立名為 package.json 的檔案,並加入下列內容:
{
"name": "webrtc-codelab",
"version": "0.0.1",
"description": "WebRTC codelab",
"dependencies": {
"node-static": "^0.7.10",
"socket.io": "^1.2.0"
}
}
這是應用程式資訊清單,會告知 Node Package Manager (npm) 要安裝哪些專案依附元件。
如要安裝依附元件 (例如 /socket.io/socket.io.js),請在 work 目錄中,透過指令列終端機執行下列指令:
npm install
您應該會看到安裝記錄,結尾大致如下:

如您所見,npm 已安裝 package.json 中定義的依附元件。
在 work 目錄的頂層 (而非 js 目錄) 建立新檔案 index.js,並加入下列程式碼:
'use strict';
var os = require('os');
var nodeStatic = require('node-static');
var http = require('http');
var socketIO = require('socket.io');
var fileServer = new(nodeStatic.Server)();
var app = http.createServer(function(req, res) {
fileServer.serve(req, res);
}).listen(8080);
var io = socketIO.listen(app);
io.sockets.on('connection', function(socket) {
// convenience function to log server messages on the client
function log() {
var array = ['Message from server:'];
array.push.apply(array, arguments);
socket.emit('log', array);
}
socket.on('message', function(message) {
log('Client said: ', message);
// for a real app, would be room-only (not broadcast)
socket.broadcast.emit('message', message);
});
socket.on('create or join', function(room) {
log('Received request to create or join room ' + room);
var clientsInRoom = io.sockets.adapter.rooms[room];
var numClients = clientsInRoom ? Object.keys(clientsInRoom.sockets).length : 0;
log('Room ' + room + ' now has ' + numClients + ' client(s)');
if (numClients === 0) {
socket.join(room);
log('Client ID ' + socket.id + ' created room ' + room);
socket.emit('created', room, socket.id);
} else if (numClients === 1) {
log('Client ID ' + socket.id + ' joined room ' + room);
io.sockets.in(room).emit('join', room);
socket.join(room);
socket.emit('joined', room, socket.id);
io.sockets.in(room).emit('ready');
} else { // max two clients
socket.emit('full', room);
}
});
socket.on('ipaddr', function() {
var ifaces = os.networkInterfaces();
for (var dev in ifaces) {
ifaces[dev].forEach(function(details) {
if (details.family === 'IPv4' && details.address !== '127.0.0.1') {
socket.emit('ipaddr', details.address);
}
});
}
});
});
在指令列終端機中,於 work 目錄執行下列指令:
node index.js
在瀏覽器中開啟 localhost:8080。
每次開啟這個網址時,系統都會提示你輸入會議室名稱。如要加入同一個聊天室,請每次都選擇相同的聊天室名稱,例如「foo」。
開啟新分頁,然後再次開啟 localhost:8080。選擇相同的房間名稱。
在第三個分頁或視窗中開啟 localhost:8080。再次選擇相同的房間名稱。
查看每個分頁中的控制台,應該會看到上述 JavaScript 程式碼的記錄。
獎勵分數
- 有哪些替代訊息機制?使用「純」WebSocket 時,可能會遇到哪些問題?
- 擴充這個應用程式時,可能會遇到哪些問題?您能否開發一種方法,測試數千或數百萬個同時發出的房間請求?
- 這個應用程式會使用 JavaScript 提示取得聊天室名稱。找出從網址取得聊天室名稱的方法。舉例來說,localhost:8080/foo 會提供聊天室名稱
foo。
您學到的內容
在這個步驟中,您學到了如何:
- 使用 npm 安裝 package.json 中指定的專案依附元件。
- 執行 Node.js 伺服器,提供靜態檔案。
- 使用 socket.io 在 Node.js 上設定訊息服務。
- 你可以使用這項功能建立「聊天室」並交換訊息。
這個步驟的完整版本位於 step-04 資料夾中。
瞭解詳情
下一步
瞭解如何使用信號,讓兩位使用者建立對等互連連線。
8. 結合對等互連連線和信號
課程內容
在這個步驟中,您將瞭解如何:
- 使用在 Node.js 上執行的 Socket.IO 執行 WebRTC 信號服務
- 使用該服務在對等互連之間交換 WebRTC 中繼資料。
這個步驟的完整版本位於 step-05 資料夾中。
取代 HTML 和 JavaScript
將 index.html 的內容替換為下列內容:
<!DOCTYPE html>
<html>
<head>
<title>Realtime communication with WebRTC</title>
<link rel="stylesheet" href="/css/main.css">
</head>
<body>
<h1>Realtime communication with WebRTC</h1>
<div id="videos">
<video id="localVideo" autoplay muted></video>
<video id="remoteVideo" autoplay></video>
</div>
<script src="/socket.io/socket.io.js"></script>
<script src="https://webrtc.github.io/adapter/adapter-latest.js"></script>
<script src="js/main.js"></script>
</body>
</html>
將 js/main.js 替換為 step-05/js/main.js 的內容。
執行 Node.js 伺服器
如果您不是從工作目錄執行本程式碼實驗室,可能需要安裝 step-05 資料夾或目前工作資料夾的依附元件。在目前使用的目錄中執行下列指令:
npm install
安裝完成後,如果 Node.js 伺服器未執行,請在 work 目錄中呼叫下列指令來啟動伺服器:
node index.js
請確認您使用的是上一個步驟中實作 Socket.IO 的 index.js 版本。如要進一步瞭解 Node 和 Socket IO,請參閱「設定信號服務來交換訊息」一節。
在瀏覽器中開啟 localhost:8080。
在新分頁或視窗中再次開啟 localhost:8080。一個影片元素會顯示 getUserMedia() 的本機串流,另一個則會顯示使用 RTCPeerconnection 串流的「遠端」影片。
在瀏覽器控制台中查看記錄。
獎勵點數
- 這個應用程式僅支援一對一視訊通訊。如何變更設計,讓多人共用同一個視訊通訊聊天室?
- 範例中硬式編碼了聊天室名稱 foo。如何啟用其他房間名稱?
- 使用者如何分享聊天室名稱?嘗試建立替代方案,避免分享會議室名稱。
- 如何修改應用程式
- 使用畫布元素拍照並取得資料。
- 與遠端使用者交換圖片資料。
如需這個步驟的完整版本,請參閱 step-06 資料夾。
運作方式
您先前已瞭解如何使用 RTCDataChannel 交換文字訊息。
這個步驟可讓您分享整個檔案,在本範例中,就是使用 getUserMedia() 拍攝的相片。
這個步驟的核心部分如下:
- 建立資料管道。請注意,在這個步驟中,您不會將任何媒體串流新增至對等互連連線。
- 使用
getUserMedia()擷取使用者的網路攝影機視訊串流:
var video = document.getElementById('video');
function grabWebCamVideo() {
console.log('Getting user media (video) ...');
navigator.mediaDevices.getUserMedia({
video: true
})
.then(gotStream)
.catch(function(e) {
alert('getUserMedia() error: ' + e.name);
});
}
- 使用者點選「Snap」按鈕後,從影片串流中擷取快照 (影片影格),並顯示在
canvas元素中:
var photo = document.getElementById('photo');
var photoContext = photo.getContext('2d');
function snapPhoto() {
photoContext.drawImage(video, 0, 0, photo.width, photo.height);
show(photo, sendBtn);
}
- 使用者點選「Send」按鈕時,將圖片轉換為位元組,並使用資料管道傳送:
function sendPhoto() {
// Split data channel message in chunks of this byte length.
var CHUNK_LEN = 64000;
var img = photoContext.getImageData(0, 0, photoContextW, photoContextH),
len = img.data.byteLength,
n = len / CHUNK_LEN | 0;
console.log('Sending a total of ' + len + ' byte(s)');
dataChannel.send(len);
// split the photo and send in chunks of about 64KB
for (var i = 0; i < n; i++) {
var start = i * CHUNK_LEN,
end = (i + 1) * CHUNK_LEN;
console.log(start + ' - ' + (end - 1));
dataChannel.send(img.data.subarray(start, end));
}
// send the reminder, if any
if (len % CHUNK_LEN) {
console.log('last ' + len % CHUNK_LEN + ' byte(s)');
dataChannel.send(img.data.subarray(n * CHUNK_LEN));
}
}
- 接收端會將資料管道訊息位元組轉換回圖片,並向使用者顯示圖片:
function receiveDataChromeFactory() {
var buf, count;
return function onmessage(event) {
if (typeof event.data === 'string') {
buf = window.buf = new Uint8ClampedArray(parseInt(event.data));
count = 0;
console.log('Expecting a total of ' + buf.byteLength + ' bytes');
return;
}
var data = new Uint8ClampedArray(event.data);
buf.set(data, count);
count += data.byteLength;
console.log('count: ' + count);
if (count === buf.byteLength) {
// we're done: all data chunks have been received
console.log('Done. Rendering photo.');
renderPhoto(buf);
}
};
}
function renderPhoto(data) {
var canvas = document.createElement('canvas');
canvas.width = photoContextW;
canvas.height = photoContextH;
canvas.classList.add('incomingPhoto');
// trail is the element holding the incoming images
trail.insertBefore(canvas, trail.firstChild);
var context = canvas.getContext('2d');
var img = context.createImageData(photoContextW, photoContextH);
img.data.set(data);
context.putImageData(img, 0, 0);
}
取得程式碼
將 work 資料夾的內容替換為 step-06 的內容。work 中的 index.html 檔案現在應如下所示:
<!DOCTYPE html>
<html>
<head>
<title>Realtime communication with WebRTC</title>
<link rel="stylesheet" href="/css/main.css">
</head>
<body>
<h1>Realtime communication with WebRTC</h1>
<h2>
<span>Room URL: </span><span id="url">...</span>
</h2>
<div id="videoCanvas">
<video id="camera" autoplay></video>
<canvas id="photo"></canvas>
<script src="js/main.js"></script>
</body>
</html>
如果您不是從工作目錄執行本程式碼研究室,可能需要安裝 step-06 資料夾或目前工作資料夾的依附元件。只要在目前使用的目錄中執行下列指令即可:
npm install
安裝完成後,如果 Node.js 伺服器未執行,請從 work 目錄呼叫下列指令來啟動伺服器:
node index.js
請確認您使用的是實作 Socket.IO 的 index.js 版本,並記得在變更後重新啟動 Node.js 伺服器。如要進一步瞭解 Node 和 Socket IO,請參閱「設定信號服務來交換訊息」一節。
視需要點選「允許」按鈕,允許應用程式使用網路攝影機。
應用程式會建立隨機聊天室 ID,並將該 ID 新增至網址。在新的瀏覽器分頁或視窗中,開啟網址列中的網址。
點選「Snap & Send」按鈕,然後查看頁面底部另一個分頁中的「Incoming」區域。應用程式會在分頁之間轉移相片。
畫面應如下所示:

獎勵分數
- 如何變更程式碼,以便分享任何檔案類型?
瞭解詳情
- MediaStream Image Capture API:用於拍照和控制相機的 API,即將在瀏覽器中推出!
- MediaRecorder API,用於錄製音訊和影片:示範、說明文件。
您學到的內容
- 如何拍照並使用 canvas 元素取得相片資料。
- 如何與遠端使用者交換資料。
如需這個步驟的完整版本,請參閱 step-06 資料夾。
9. 恭喜
您已成功建構應用程式,可即時串流影片及交換資料!
您學到的內容
在本程式碼實驗室中,您學到如何:
- 取得網路攝影機的影片。
- 使用 RTCPeerConnection 串流播放影片。
- 使用 RTCDataChannel 串流資料。
- 設定信號服務來交換訊息。
- 結合對等互連連線和信號。
- 拍照並透過資料管道分享。
後續步驟
- 查看標準 WebRTC 即時通訊應用程式 AppRTC 的程式碼和架構:應用程式、程式碼。
- 試用 github.com/webrtc/samples 的即時示範。
瞭解詳情
- webrtc.org 提供多種資源,協助您開始使用 WebRTC。