Guide du WebRTC

1. Vue d'ensemble

Lorsque deux navigateurs doivent communiquer, ils ont généralement besoin d'un serveur intermédiaire pour coordonner la communication, en passant des messages entre eux. Mais avoir un serveur au milieu entraîne un retard dans la communication entre les navigateurs.

Dans ce didacticiel, nous allons découvrir WebRTC, un projet open source qui permet aux navigateurs et aux applications mobiles de communiquer directement entre eux en temps réel. Ensuite, nous le verrons en action en écrivant une application simple qui crée une connexion peer-to-peer pour partager des données entre deux clients HTML.

Nous utiliserons HTML, JavaScript et la bibliothèque WebSocket ainsi que le support WebRTC intégré dans les navigateurs Web pour créer un client. Et nous allons créer un serveur de signalisation avec Spring Boot, en utilisant WebSocket comme protocole de communication. Enfin, nous verrons comment ajouter des flux vidéo et audio à cette connexion.

2. Fondamentaux et concepts du WebRTC

Voyons comment deux navigateurs communiquent dans un scénario typique sans WebRTC.

Supposons que nous ayons deux navigateurs et que le navigateur 1 ait besoin d'envoyer un message au navigateur 2 . Le navigateur 1 l' envoie d'abord au serveur :

Une fois que le serveur a reçu le message, il le traite, trouve le navigateur 2 et lui envoie le message:

Puisque le serveur doit traiter le message avant de l'envoyer au navigateur 2, la communication a lieu en temps quasi réel. Bien sûr, nous aimerions que ce soit en temps réel.

WebRTC résout ce problème en créant un canal direct entre les deux navigateurs, éliminant ainsi le besoin du serveur :

En conséquence, le temps nécessaire pour transmettre les messages d'un navigateur à un autre est considérablement réduit car les messages sont désormais acheminés directement de l'expéditeur au destinataire . Cela enlève également la lourde charge et la bande passante des serveurs et les fait partager entre les clients impliqués.

3. Prise en charge de WebRTC et des fonctionnalités intégrées

WebRTC est pris en charge par les principaux navigateurs tels que Chrome, Firefox, Opera et Microsoft Edge, ainsi que par des plates-formes comme Android et iOS.

WebRTC n'a pas besoin d'installer de plugins externes dans notre navigateur car la solution est livrée prête à l'emploi avec le navigateur.

De plus, dans une application temps réel typique impliquant la transmission vidéo et audio, nous devons fortement dépendre des bibliothèques C ++, et nous devons gérer de nombreux problèmes, notamment:

  • Dissimulation des pertes de paquets
  • Annulation d'écho
  • Adaptivité de la bande passante
  • Tampon dynamique de la gigue
  • Contrôle automatique du gain
  • Réduction et suppression du bruit
  • Image «nettoyage»

Mais WebRTC gère toutes ces préoccupations sous le capot , ce qui simplifie les communications en temps réel entre les clients.

4. Connexion peer-to-peer

Contrairement à une communication client-serveur, où il existe une adresse connue pour le serveur et où le client connaît déjà l'adresse du serveur avec lequel communiquer, dans une connexion P2P (peer-to-peer), aucun des pairs n'a d'adresse directe à un autre pair .

Pour établir une connexion peer-to-peer, quelques étapes sont nécessaires pour permettre aux clients de:

  • se rendre disponible pour la communication
  • s'identifier et partager des informations liées au réseau
  • partager et convenir du format des données, du mode et des protocoles impliqués
  • partager des données

WebRTC définit un ensemble d'API et de méthodologies pour effectuer ces étapes.

Pour que les clients se découvrent, partagent les détails du réseau, puis partagent le format des données, WebRTC utilise un mécanisme appelé signalisation .

5. Signalisation

La signalisation fait référence aux processus impliqués dans la découverte de réseau, la création d'une session, la gestion de la session et l'échange des métadonnées de capacité multimédia.

Ceci est essentiel car les clients ont besoin de se connaître à l'avance pour initier la communication.

Pour réaliser tout cela, WebRTC ne spécifie pas de norme de signalisation et laisse le soin à l'implémentation du développeur. Ainsi, cela nous offre la flexibilité d'utiliser WebRTC sur une gamme d'appareils avec n'importe quelle technologie et protocole de prise en charge.

5.1. Construire le serveur de signalisation

Pour le serveur de signalisation, nous allons créer un serveur WebSocket à l'aide de Spring Boot . Nous pouvons commencer avec un projet Spring Boot vide généré à partir de Spring Initializr.

Pour utiliser WebSocket pour notre implémentation, ajoutons la dépendance à notre pom.xml :

 org.springframework.boot spring-boot-starter-websocket 

Nous pouvons toujours trouver la dernière version à utiliser depuis Maven Central.

L'implémentation du serveur de signalisation est simple - nous allons créer un point de terminaison qu'une application cliente peut utiliser pour s'enregistrer en tant que connexion WebSocket.

Pour ce faire dans Spring Boot, écrivons une classe @Configuration qui étend WebSocketConfigurer et remplace la méthode registerWebSocketHandlers :

@Configuration @EnableWebSocket public class WebSocketConfiguration implements WebSocketConfigurer { @Override public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(new SocketHandler(), "/socket") .setAllowedOrigins("*"); } }

Note that we've identified /socket as the URL that we'll register from the client that we'll be building in the next step. We also passed in a SocketHandler as an argument to the addHandler method — this is actually the message handler that we'll create next.

5.2. Creating Message Handler in Signaling Server

The next step is to create a message handler to process the WebSocket messages that we'll receive from multiple clients.

This is essential to aid the exchange of metadata between the different clients to establish a direct WebRTC connection.

Here, to keep things simple, when we receive the message from a client, we will send it to all other clients except to itself.

To do this, we can extend TextWebSocketHandler from the Spring WebSocket library and override both the handleTextMessage and afterConnectionEstablished methods:

@Component public class SocketHandler extends TextWebSocketHandler { Listsessions = new CopyOnWriteArrayList(); @Override public void handleTextMessage(WebSocketSession session, TextMessage message) throws InterruptedException, IOException { for (WebSocketSession webSocketSession : sessions) { if (webSocketSession.isOpen() && !session.getId().equals(webSocketSession.getId())) { webSocketSession.sendMessage(message); } } } @Override public void afterConnectionEstablished(WebSocketSession session) throws Exception { sessions.add(session); } } 

As we can see in the afterConnectionEstablished method, we add the received session to a list of sessions so that we can keep track of all the clients.

And when we receive a message from any of the clients, as can be seen in the handleTextMessage, we iterate over all the client sessions in the list and send the message to all other clients except the sender by comparing the session id of the sender and the sessions in the list.

6. Exchanging Metadata

In a P2P connection, the clients can be very different from each other. For example, Chrome on Android can connect to Mozilla on a Mac.

Hence, the media capabilities of these devices can vary widely. Therefore, it's essential for a handshake between peers to agree upon the media types and codecs used for communication.

In this phase, WebRTC uses the SDP (Session Description Protocol) to agree on the metadata between the clients.

To achieve this, the initiating peer creates an offer that must be set as a remote descriptor by the other peer. In addition, the other peer then generates an answer that is accepted as a remote descriptor by the initiating peer.

The connection is established when this process is complete.

7. Setting Up the Client

Let's create our WebRTC client such that it can act both as the initiating peer and the remote peer.

We'll begin by creating an HTML file called index.html and a JavaScript file named client.js which index.html will use.

To connect to our signaling server, we create a WebSocket connection to it. Assuming that the Spring Boot signaling server that we built is running on //localhost:8080, we can create the connection:

var conn = new WebSocket('ws://localhost:8080/socket');

To send a message to the signaling server, we'll create a send method that will be used to pass the message in the upcoming steps:

function send(message) { conn.send(JSON.stringify(message)); }

8. Setting Up a Simple RTCDataChannel

After setting up the client in the client.js, we need to create an object for the RTCPeerConnection class. Here, we set up the object and enable the data channel by passing RtpDataChannels as true:

var peerConnection = new RTCPeerConnection(configuration, { optional : [ { RtpDataChannels : true } ] });

In this example, the purpose of the configuration object is to pass in the STUN (Session Traversal Utilities for NAT) and TURN (Traversal Using Relays around NAT) servers and other configurations that we'll be discussing in the latter part of this tutorial. For this example, it's sufficient to pass in null.

Now, we can create a dataChannel to use for message passing:

var dataChannel = peerConnection.createDataChannel("dataChannel", { reliable: true });

Subsequently, we can create listeners for various events on the data channel:

dataChannel.onerror = function(error) { console.log("Error:", error); }; dataChannel.onclose = function() { console.log("Data channel is closed"); };

9. Establishing a Connection With ICE

The next step in establishing a WebRTC connection involves the ICE (Interactive Connection Establishment) and SDP protocols, where the session descriptions of the peers are exchanged and accepted at both peers.

The signaling server is used to send this information between the peers. This involves a series of steps where the clients exchange connection metadata through the signaling server.

9.1. Creating an Offer

Firstly, we create an offer and set it as the local description of the peerConnection. We then send the offer to the other peer:

peerConnection.createOffer(function(offer) { send({ event : "offer", data : offer }); peerConnection.setLocalDescription(offer); }, function(error) { // Handle error here });

Here, the send method makes a call to the signaling server to pass the offer information.

Note that we are free to implement the logic of the send method with any server-side technology.

9.2. Handling ICE Candidates

Secondly, we need to handle the ICE candidates. WebRTC uses the ICE (Interactive Connection Establishment) protocol to discover the peers and establish the connection.

When we set the local description on the peerConnection, it triggers an icecandidate event.

This event should transmit the candidate to the remote peer so that the remote peer can add it to its set of remote candidates.

To do this, we create a listener for the onicecandidate event:

peerConnection.onicecandidate = function(event) { if (event.candidate) { send({ event : "candidate", data : event.candidate }); } };

The icecandidate event triggers again with an empty candidate string when all the candidates are gathered.

We must pass this candidate object as well to the remote peer. We pass this empty candidate string to ensure that the remote peer knows that all the icecandidate objects are gathered.

Also, the same event is triggered again to indicate that the ICE candidate gathering is complete with the value of candidate object set to null on the event. This need not be passed on to the remote peer.

9.3. Receiving the ICE Candidate

Thirdly, we need to process the ICE candidate sent by the other peer.

The remote peer, upon receiving this candidate, should add it to its candidate pool:

peerConnection.addIceCandidate(new RTCIceCandidate(candidate));

9.4. Receiving the Offer

After that, when the other peer receives the offer, it must set it as the remote description. In addition, it must generate an answer, which is sent to the initiating peer:

peerConnection.setRemoteDescription(new RTCSessionDescription(offer)); peerConnection.createAnswer(function(answer) { peerConnection.setLocalDescription(answer); send({ event : "answer", data : answer }); }, function(error) { // Handle error here });

9.5. Receiving the Answer

Finally, the initiating peer receives the answer and sets it as the remote description:

handleAnswer(answer){ peerConnection.setRemoteDescription(new RTCSessionDescription(answer)); }

With this, WebRTC establishes a successful connection.

Now, we can send and receive data between the two peers directly, without the signaling server.

10. Sending a Message

Now that we've established the connection, we can send messages between the peers using the send method of the dataChannel:

dataChannel.send(“message”);

Likewise, to receive the message on the other peer, let's create a listener for the onmessage event:

dataChannel.onmessage = function(event) { console.log("Message:", event.data); };

With this step, we have created a fully functional WebRTC data channel. We can now send and receive data between the clients. Additionally, we can add video and audio channels to this.

11. Adding Video and Audio Channels

When WebRTC establishes a P2P connection, we can easily transfer audio and video streams directly.

11.1. Obtaining the Media Stream

Firstly, we need to obtain the media stream from the browser. WebRTC provides an API for this:

const constraints = { video: true,audio : true }; navigator.mediaDevices.getUserMedia(constraints). then(function(stream) { /* use the stream */ }) .catch(function(err) { /* handle the error */ });

We can specify the frame rate, width, and height of the video using the constraints object.

The constraint object also allows specifying the camera used in the case of mobile devices:

var constraints = { video : { frameRate : { ideal : 10, max : 15 }, width : 1280, height : 720, facingMode : "user" } };

Also, the value of facingMode can be set to “environment” instead of “user” if we want to enable the back camera.

11.2. Sending the Stream

Secondly, we have to add the stream to the WebRTC peer connection object:

peerConnection.addStream(stream);

Adding the stream to the peer connection triggers the addstream event on the connected peers.

11.3. Receiving the Stream

Thirdly, to receive the stream on the remote peer, we can create a listener.

Let's set this stream to an HTML video element:

peerConnection.onaddstream = function(event) { videoElement.srcObject = event.stream; };

12. NAT Issues

In the real world, firewall and NAT (Network Address Traversal) devices connect our devices to the public Internet.

NAT provides the device an IP address for usage within the local network. So, this address is not accessible outside the local network. Without a public address, peers are unable to communicate with us.

To address this issue, WebRTC uses two mechanisms:

  1. STUN
  2. TURN

13. Using STUN

STUN is the simplest approach to this problem. Before sharing the network information to the peer, the client makes a request to a STUN server. The responsibility of the STUN server is to return the IP address from which it receives the request.

So, by querying the STUN server, we get our own public-facing IP address. We then share this IP and port information to the peer we want to connect to. The other peers can do the same to share their public-facing IPs.

To use a STUN server, we can simply pass the URL in the configuration object for creating the RTCPeerConnection object:

var configuration = { "iceServers" : [ { "url" : "stun:stun2.1.google.com:19302" } ] }; 

14. Using TURN

In contrast, TURN is a fallback mechanism used when WebRTC is unable to establish a P2P connection. The role of the TURN server is to relay data directly between the peers. In this case, the actual stream of data flows through the TURN servers. Using the default implementations, TURN servers also act as STUN servers.

TURN servers are publicly available, and clients can access them even if they are behind a firewall or proxy.

But, using a TURN server is not truly a P2P connection, as an intermediate server is present.

Remarque: TURN est un dernier recours lorsque nous ne parvenons pas à établir une connexion P2P. Comme les données transitent par le serveur TURN, cela nécessite beaucoup de bande passante, et nous n'utilisons pas le P2P dans ce cas.

Semblable à STUN, nous pouvons fournir l'URL du serveur TURN dans le même objet de configuration:

{ 'iceServers': [ { 'urls': 'stun:stun.l.google.com:19302' }, { 'urls': 'turn:10.158.29.39:3478?transport=udp', 'credential': 'XXXXXXXXXXXXX', 'username': 'XXXXXXXXXXXXXXX' }, { 'urls': 'turn:10.158.29.39:3478?transport=tcp', 'credential': 'XXXXXXXXXXXXX', 'username': 'XXXXXXXXXXXXXXX' } ] }

15. Conclusion

Dans ce tutoriel, nous avons discuté de ce qu'est le projet WebRTC et présenté ses concepts fondamentaux. Nous avons ensuite construit une application simple pour partager des données entre deux clients HTML.

Nous avons également discuté des étapes de création et d'établissement d'une connexion WebRTC.

De plus, nous avons examiné l'utilisation des serveurs STUN et TURN comme mécanisme de secours en cas de défaillance de WebRTC.

Vous pouvez consulter les exemples fournis dans cet article sur GitHub.