RTCPeerConnection

L'interface RTCPeerConnection représente une connexion WebRTC entre un ordinateur local et un pair distant. Elle fournit des méthodes pour se connecter à un pair distant, entretenir et surveiller la connexion et fermer la connexion dès qu'elle n'est plus nécessaire.

Constructeur

RTCPeerConnection() (en-US)
Renvoie un nouvel objet RTCPeerConnection qui représente la connexion entre l'appareil local et le pair distant.

Méthodes statiques

generateCertificate() (en-US)
Crée un certificat X.509 et la clé privée correspondante. Cette méthode renvoie une promesse dont la valeur de résolution sera le nouvel objet RTCCertificate (en-US) une fois généré.

Propriétés

Cette interface hérite également des propriétés de EventTarget.

canTrickleIceCandidates (en-US) Lecture seule
Renvoie un booléen qui indique si un pair distant peut accepter ou non les candidats ICE au goutte-à-goutte (trickled ICE candidates).
connectionState (en-US) Lecture seule
Indique l'état actuel de la connexion au pair en renvoyant une de ces chaînes de caractères new, connecting, connected, disconnected, failed ou closed.
currentLocalDescription (en-US) Lecture seule
Renvoie un objet RTCSessionDescription (en-US) qui décrit la partie locale de la connexion qui a été négociée avec succès le plus récemment depuis la dernière fois où cette connexion RTCPeerConnection a terminé de négocier et s'est connectée à un pair distant. Cet objet inclut également une liste des candidats ICE qui peuvent avoir déjà été générés par l'agent ICE depuis que l'offre ou la réponse représentée par la description a été instanciée en premier lieu.
currentRemoteDescription (en-US) Lecture seule
Renvoie un objet RTCSessionDescription (en-US) qui décrit la connexion pour le pair distant pour la connexion qui a été négociée avec succès le plus récemment depuis la dernière fois où cette connexion RTCPeerConnection a terminé de négocier et s'est connectée à un pair distant. Cet objet inclut également une liste des candidats ICE qui peuvent avoir déjà été générés par l'agent ICE depuis que l'offre ou la réponse représentée par la description a été instanciée en premier lieu.
iceConnectionState (en-US) Lecture seule
Renvoie une chaîne de caractères qui indique l'état de l'agent ICE associée à cette connexion RTCPeerConnection. La chaîne de caractères peut être l'une de celles-ci : new, checking, connected, completed, failed, disconnected ou closed.
iceGatheringState (en-US) Lecture seule
Renvoie une chaîne de caractères qui décrit l'état de collection ICE de la connexion. Cela permet de détecter par exemple lorsque la collecte des candidats ICE a terminé. Les valeurs possibles pour cette chaîne sont new, gathering ou complete.
localDescription (en-US) Lecture seule
Renvoie un objet RTCSessionDescription (en-US) qui décrit la session pour la partie locale de la connexion. Si la session n'a pas encore été initialisée, renvoie null.
peerIdentity (en-US) Lecture seule
Renvoie une promesse dont la valeur de résolution sera un objet RTCIdentityAssertion (en-US) contenant une chaîne de caractères identifiant le pair distant. Une fois que la promesse a été résolue avec succès, l'identité obtenue est celle du pair cible et ne changera pas pour la durée de la connexion.
pendingLocalDescription (en-US) Lecture seule
Renvoie un objet RTCSessionDescription (en-US) qui décrit un changement de configuration en attente pour la partie locale de la connexion. Cela ne décrit pas la connexion dans son état actuel mais telle qu'elle pourrait être dans un futur proche.
pendingRemoteDescription (en-US) Lecture seule
Renvoie un objet RTCSessionDescription (en-US) qui décrit un changement de configuration en attente pour la partie distante de la connexion. Cela ne décrit pas la connexion dans son état actuel mais telle qu'elle pourrait être dans un futur proche.
remoteDescription (en-US) Lecture seule
Renvoie un objet RTCSessionDescription (en-US) qui décrit la session, y compris la configuration, les informations sur le média pour la partie distante de la connexion. Si la session n'est pas encore initialisée, renvoie null.
sctp (en-US) Lecture seule
Renvoie un objet RTCSctpTransport (en-US) qui décrit la couche de transport SCTP sur laquelle les données SCTP sont envoyées et reçues. Si SCTP n'a pas été négocié, renvoie null.
signalingState (en-US) Lecture seule
Renvoie une chaîne de caractères qui décrit l'état du processus de signal pour la partie locale de la connexion lors de la connexion ou de la reconnexion à un autre pair. Cette chaîne peut avoir l'une des valeurs suivantes : stable, have-local-offer, have-remote-offer, have-local-pranswer ou have-remote-pranswer.

Gestionnaires d'évènements

Cette interface hérite des gestionnaires d'évènements de EventTarget.

onconnectionstatechange (en-US)
Un gestionnaire d'évènements (en-US) appelé pour gérer l'évènement connectionstatechange (en-US). Cet évènement se produit lorsque l'état aggrégé de la connexion évolue. L'état aggrégé correspond à la combinaison des états de l'ensemble des transports de réseau individuel utilisés par la connexion
ondatachannel (en-US)
Un gestionnaire d'évènements (en-US) qui définit une fonction appelée pour gérer l'évènement datachannel (en-US). Cet évènement de type RTCDataChannelEvent (en-US) est envoyé lorsqu'un canal RTCDataChannel (en-US) est ajouté à la connexion par le pair distant qui a appelé createDataChannel() (en-US).
onicecandidate (en-US)
Un gestionnaire d'évènements (en-US) qui définit une fonction appelée pour gérer l'évènement icecandidate (en-US). Cela se produit lorsque l'agent ICE local a besoin de délivrer un message à l'autre pair via le serveur de signal.
onicecandidateerror (en-US)
Un gestionnaire d'évènements (en-US) qui définit une fonction appelée pour gérer l'évènement icecandidateerror (en-US). Cet évènement est déclenché lorsqu'une erreur se produit lors du processus de collecte des candidats ICE.
oniceconnectionstatechange (en-US)
Un gestionnaire d'évènements (en-US) qui définit une fonction appelée pour gérer l'évènement iceconnectionstatechange (en-US). Cela se produit lorsque l'agent ICE local a besoin de délivrer un message à l'autre pair via le serveur de signal.
onicegatheringstatechange (en-US)
Un gestionnaire d'évènements (en-US) qui définit une fonction appelée pour gérer l'évènement icegatheringstatechange (en-US). Cela se produit lorsque l'état de collecte ICE évolue.
onnegotiationneeded (en-US)
Un gestionnaire d'évènements (en-US) qui définit une fonction appelée pour gérer l'évènement negotiationneeded (en-US). Cet évènement est déclenché lorsqu'un changement a eu lieu et qui nécessite une négociation de session. La négociation devrait être menée par le requêtant, car certaines modifications de sessions ne peuvent pas être négociés par le répondant.
onsignalingstatechange (en-US)
Un gestionnaire d'évènements (en-US) qui définit une fonction appelée pour gérer l'évènement signalingstatechange (en-US). La fonction reçoit en entrée un évènement qui est celui envoyé lorsque l'état signalingState (en-US) du pair de la connexion change. Cela peut avoir lieu suite à un appel à setLocalDescription() (en-US) ou à setRemoteDescription() (en-US).
ontrack (en-US)
Un gestionnaire d'évènements (en-US) qui définit une fonction appelée pour gérer l'évènement track (en-US). L'évènement reçu en argument de la fonction est de type RTCTrackEvent (en-US). Cet évènement est envoyé lorsqu'un nouvel objet entrant MediaStreamTrack (en-US) a été créé et associé avec un objet RTCRtpReceiver (en-US) ajouté à l'ensemble des destinataires de la connexion.

Propriétés obsolètes

onaddstream (en-US) This is an obsolete API and is no longer guaranteed to work.
Un gestionnaire d'évènements (en-US) qui définit une fonction appelée pour gérer l'évènement obsolète addstream (en-US).
onremovestream (en-US) This is an obsolete API and is no longer guaranteed to work.
Un gestionnaire d'évènements (en-US) qui définit une fonction appelée pour gérer l'évènement obsolète removestream (en-US).

Méthodes

Cette interface hérite également des méthodes de EventTarget.

addIceCandidate() (en-US)
Ajoute un nouveau candidat distant à la description distante de RTCPeerConnection qui décrit l'état à l'extrémité distante de la connexion
addTrack() (en-US)
Ajoute un nouvel objet MediaStreamTrack (en-US) à l'ensemble des pistes qui seront transmises au pair distant.
addTransceiver() (en-US)
Crée un nouvel objet RTCRtpTransceiver (en-US) et l'ajoute à l'ensemble des émetteurs-récepteurs associés à la connexion. Chaque émetteur-récepteur représente un flux bidirectionnel associé à un récepteur RTCRtpSender (en-US) et à un émetteur RTCRtpReceiver (en-US).
close() (en-US)
Ferme la connexion courante vers le pair.
createAnswer() (en-US)
Initie la création d'une réponse SDP à une offre reçue par un pair distant pendant la négociation offre/réponse d'une connexion WebRTC. La réponse contient des informations sur les médias déjà attachés à la session, les codecs et options pris en charge par le navigateur ainsi que sur les éventuels candidats ICE déjà collectés.
createDataChannel() (en-US)
Initie la création d'un nouveau canal relié au pair distant qui permettra de transmettre tout type de données. Cela peut être utile pour le transfert de contenu en arrière-plan comme des images, fichiers, discussions, paquets pour l'état d'un jeu multijoueur, etc.
createOffer() (en-US)
Initie la création d'une offre SDP afin de démarrer une nouvelle connexion WebRTC avec un pair distant. L'offre SDP inclut des informations à propos des éventuels objets MediaStreamTrack (en-US) déjà attachés à la session WebRTC, des codecs, des options prises en charge par le navigateur ainsi que sur les éventuels candidats déjà collectés par l'agent ICE afin de pouvoir envoyer ces informations via le canal de signalement à un pair potentiel pour demander une connexion ou mettre à jour la configuration d'une connexion existante.
getConfiguration() (en-US)
Renvoie un objet RTCConfiguration (en-US) qui indique la configuration courante de la connexion.
getIdentityAssertion() (en-US)
Initie la collecte d'une assertion d'identité et renvoie une promesse qui est résolue en l'assertion d'identité encodée dans une chaîne de caractères. Cette méthode aura un effet uniquement si signalingState (en-US) ne vaut pas closed.
getReceivers() (en-US)
Renvoie un tableu d'objets RTCRtpReceiver (en-US) dont chacun représente un récepteur RTP.
getSenders() (en-US)
Renvoie un tableau d'objets RTCRtpSender (en-US) dont chacun représente un émetteur RTP dont le rôle est de transmettre les données d'une piste.
getStats() (en-US)
Renvoie une promesse dont la valeur de résolution sont des statistiques quant à la connexion globale ou à la piste MediaStreamTrack (en-US) indiquée.
getTransceivers() (en-US)
Renvoie une liste de l'ensemble des objets RTCRtpTransceiver (en-US) utilisés afin d'envoyer et de recevoir des données sur la connexion.
removeTrack() (en-US)
Indique à la partie locale de la connexion d'arrêter d'envoyer des médias sur la piste indiquée sans pour autant retirer l'objet RTCRtpSender (en-US) correspondant de la liste des récepteurs telle que fournie par getSenders() (en-US). Si la piste est déjà arrêtée ou si elle n'est pas dans la liste des émetteurs de la connexion, cette méthode n'a pas d'effet.
restartIce() (en-US)
Permet de demander facilement une nouvelle collecte de candidats ICE à chaque extrémité de la connexion. Cela simplifie le processus en permettant à l'appelant ou au recevant d'utiliser la même méthode pour déclencher un redémarrage ICE.
setConfiguration()
Définit la configuration courante de la connexion en fonction des valeurs incluses dans l'objet RTCConfiguration (en-US) passé en argument. Cela permet de modifier les serveurs ICE utilisés par la connexion ainsi que les règles de transport utilisées.
setIdentityProvider() (en-US)
Définit le fournisseur d'identité (Identity Provider ou IdP) par le triplet fourni en paramètres : le nom, le protocole de communication et le nom d'utilisateur. Le protocole et le nom d'utilisateur sont optionnels.
setLocalDescription() (en-US)
Modifie la description locale associée à la connexion. Cette description définit les propriétés de l'extrémité locale de la connexion, y compris le format de média. Cette méthode renvoie une promesse qui est résolue de façon asynchrone lorsque la description a été modifiée.
setRemoteDescription() (en-US)
Définit la description de la connexion pour l'extrémité distante pour l'offre ou la réponse courante. Cette description définit les propriétés de l'extrémité distante de la connexion, y compris le format de média. Cette méthode renvoie une promesse qui est résolue de façon asynchrone lorsque la description a été modifiée.

Méthodes obsolètes

addStream() (en-US) This is an obsolete API and is no longer guaranteed to work.
Ajoute un objet MediaStream comme source audio ou vidéo locale. La méthode addTrack() (en-US) devrait être utilisée à la place pour chaque piste qu'on souhaite envoyer au pair distant.
createDTMFSender() This is an obsolete API and is no longer guaranteed to work.
Crée un nouvel émetteur RTCDTMFSender (en-US) associé à une piste MediaStreamTrack (en-US) spécifique et qui est capable d'envoyer des signaux téléphoniques DTMF via la connexion.
getStreamById() (en-US) This is an obsolete API and is no longer guaranteed to work.
Renvoie l'objet MediaStream ayant l'identifiant indiqué qui est associé à l'extrémité locale ou distante de la connexion. Cette propriété a été remplacée par les méthodes getSenders() (en-US) et getReceivers() (en-US).
removeStream() (en-US) This is an obsolete API and is no longer guaranteed to work.
Supprime un flux MediaStream qui est une source audio ou vidéo locale. Cette méthode est obsolète, on doit privilégier removeTrack() (en-US) à la place.

Évènements

On pourra intercepter ces évènements grâce à addEventListener() ou en affectant un gestionnaire d'évènement sur la propriété onnomEvenement de cette interface.

connectionstatechange (en-US)
Envoyé lorsque l'état de connectivité global de la connexion RTCPeerConnection évolue. Également disponible via la propriété de gestion d'évènement onconnectionstatechange (en-US).
datachannel (en-US)
Envoyé lorsque le pair distant ajoute un canal RTCDataChannel (en-US) à la connexion. Également disponible via la propriété de gestion d'évènement ondatachannel (en-US).
icecandidate (en-US)
Envoyé afin de demander à ce que le candidat indiqué soit transmis au pair distant. Également disponible via la propriété de gestion d'évènement onicecandidate (en-US).
icecandidateerror (en-US)
Envoyé à la connexion si une erreur se produit lors de la collecte des candidats ICE. L'évènement décrit l'erreur. Également disponible via la propriété de gestion d'évènement onicecandidateerror (en-US).
iceconnectionstatechange (en-US)
Envoyé lorsque l'état de la connexion ICE change (par exemple lorsqu'elle se déconnecte). Également disponible via la propriété de gestion d'évènement oniceconnectionstatechange (en-US).
icegatheringstatechange (en-US)
Envoyé lorsque l'état de collecte des couches ICE, tel que reflété par iceGatheringState (en-US), évolue. Cela indique si la négociation ICE n'a pas encore commencé (new), a commencé la collecte des candidats (gathering) ou si elle est terminée (complete). Également disponible via la propriété de gestion d'évènement onicegatheringstatechange (en-US).
negotiationneeded (en-US)
Envoyé lorsqu'une négociation ou de la renégociation de la connexion ICE doit être réalisée. Cela peut se produire à l'ouverture d'une connexion mais aussi lorsqu'il est nécessaire de s'adapter à des conditions réseau changeantes. Le récepteur devrait répondre en créant une offre et en l'envoyant à l'autre pair. Également disponible via la propriété de gestion d'évènement onnegotiationneeded (en-US).
signalingstatechange (en-US)
Envoyé lorsque l'état de signal ICE de la connexion change. Également disponible via la propriété de gestion d'évènement onsignalingstatechange (en-US).
track (en-US)
Envoyé après qu'une nouvelle piste ait été ajoutée à une des instances RTCRtpReceiver (en-US) faisant partie de la connexion. Également disponible via la propriété de gestion d'évènement ontrack (en-US).

Évènements obsolètes

addstream (en-US) This is an obsolete API and is no longer guaranteed to work.
Envoyé lorsqu'un nouveau flux MediaStream a été ajouté à la connexion. Plutôt que d'écouter cet évènement obsolète, on privilégiera les évènements track (en-US). Un tel évènement est envoyé pour chaque piste MediaStreamTrack (en-US) ajoutée à la connexion. Également disponible via la propriété onaddstream (en-US).
removestream (en-US) This is an obsolete API and is no longer guaranteed to work.
Envoyé lorsqu'un flux MediaStream est retiré de la connexion. Plutôt que d'écouter cet évènement obsolète, on privilégiera les évènements removetrack (en-US) pour chaque flux. Également disponible via la propriété onremovestream (en-US).

Spécifications

Specification
WebRTC 1.0: Real-Time Communication Between Browsers (WebRTC 1.0)
# interface-definition

Compatibilité des navigateurs

BCD tables only load in the browser

Voir aussi