L'interfaceRTCPeerConnection 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()

Renvoie un nouvel objetRTCPeerConnection qui représente la connexion entre l'appareil local et le pair distant.

Méthodes statiques

generateCertificate()

Crée un certificat X.509 et la clé privée correspondante. Cette méthode renvoie unepromesse dont la valeur de résolution sera le nouvel objetRTCCertificate une fois généré.

Propriétés

Cette interface hérite également des propriétés deEventTarget.

canTrickleIceCandidatesLecture seule

Renvoie un booléen qui indique si un pair distant peut accepter ou nonles candidats ICE au goutte-à-goutte (trickled ICE candidates).

connectionStateLecture seule

Indique l'état actuel de la connexion au pair en renvoyant une de ces chaînes de caractèresnew,connecting,connected,disconnected,failed ouclosed.

currentLocalDescriptionLecture seule

Renvoie un objetRTCSessionDescription 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 connexionRTCPeerConnection 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.

currentRemoteDescriptionLecture seule

Renvoie un objetRTCSessionDescription 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 connexionRTCPeerConnection 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.

iceConnectionStateLecture seule

Renvoie une chaîne de caractères qui indique l'état de l'agent ICE associée à cette connexionRTCPeerConnection. La chaîne de caractères peut être l'une de celles-ci :new,checking,connected,completed,failed,disconnected ouclosed.

iceGatheringStateLecture 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 sontnew,gathering oucomplete.

localDescriptionLecture seule

Renvoie un objetRTCSessionDescription qui décrit la session pour la partie locale de la connexion. Si la session n'a pas encore été initialisée, renvoienull.

peerIdentityLecture seule

Renvoie unepromesse dont la valeur de résolution sera un objetRTCIdentityAssertion 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.

pendingLocalDescriptionLecture seule

Renvoie un objetRTCSessionDescription 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.

pendingRemoteDescriptionLecture seule

Renvoie un objetRTCSessionDescription 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.

remoteDescriptionLecture seule

Renvoie un objetRTCSessionDescription 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, renvoienull.

sctpLecture seule

Renvoie un objetRTCSctpTransport qui décrit la couche de transportSCTP sur laquelle les données SCTP sont envoyées et reçues. Si SCTP n'a pas été négocié, renvoienull.

signalingStateLecture 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 ouhave-remote-pranswer.

Gestionnaires d'évènements

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

onconnectionstatechange

Ungestionnaire d'évènements appelé pour gérer l'évènementconnectionstatechange. 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

Ungestionnaire d'évènements qui définit une fonction appelée pour gérer l'évènementdatachannel. Cet évènement de typeRTCDataChannelEvent est envoyé lorsqu'un canalRTCDataChannel est ajouté à la connexion par le pair distant qui a appelécreateDataChannel().

onicecandidate

Ungestionnaire d'évènements qui définit une fonction appelée pour gérer l'évènementicecandidate. Cela se produit lorsque l'agentICE local a besoin de délivrer un message à l'autre pair via le serveur de signal.

onicecandidateerror

Ungestionnaire d'évènements qui définit une fonction appelée pour gérer l'évènementicecandidateerror. Cet évènement est déclenché lorsqu'une erreur se produit lors du processus de collecte des candidatsICE.

oniceconnectionstatechange

Ungestionnaire d'évènements qui définit une fonction appelée pour gérer l'évènementiceconnectionstatechange. Cela se produit lorsque l'agentICE local a besoin de délivrer un message à l'autre pair via le serveur de signal.

onicegatheringstatechange

Ungestionnaire d'évènements qui définit une fonction appelée pour gérer l'évènementicegatheringstatechange. Cela se produit lorsque l'état de collecteICE évolue.

onnegotiationneeded

Ungestionnaire d'évènements qui définit une fonction appelée pour gérer l'évènementnegotiationneeded. 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

Ungestionnaire d'évènements qui définit une fonction appelée pour gérer l'évènementsignalingstatechange. La fonction reçoit en entrée un évènement qui est celui envoyé lorsque l'étatsignalingState du pair de la connexion change. Cela peut avoir lieu suite à un appel àsetLocalDescription() ou àsetRemoteDescription().

ontrack

Ungestionnaire d'évènements qui définit une fonction appelée pour gérer l'évènementtrack. L'évènement reçu en argument de la fonction est de typeRTCTrackEvent. Cet évènement est envoyé lorsqu'un nouvel objet entrantMediaStreamTrack a été créé et associé avec un objetRTCRtpReceiver ajouté à l'ensemble des destinataires de la connexion.

Propriétés obsolètes

onaddstreamObsolète

Ungestionnaire d'évènements qui définit une fonction appelée pour gérer l'évènement obsolèteaddstream.

onremovestreamObsolète

Ungestionnaire d'évènements qui définit une fonction appelée pour gérer l'évènement obsolèteremovestream.

Méthodes

Cette interface hérite également des méthodes deEventTarget.

addIceCandidate()

Ajoute un nouveau candidat distant à la description distante deRTCPeerConnection qui décrit l'état à l'extrémité distante de la connexion

addTrack()

Ajoute un nouvel objetMediaStreamTrack à l'ensemble des pistes qui seront transmises au pair distant.

addTransceiver()

Crée un nouvel objetRTCRtpTransceiver 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écepteurRTCRtpSender et à un émetteurRTCRtpReceiver.

close()

Ferme la connexion courante vers le pair.

createAnswer()

Initie la création d'une réponseSDP à 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 candidatsICE déjà collectés.

createDataChannel()

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()

Initie la création d'une offreSDP afin de démarrer une nouvelle connexion WebRTC avec un pair distant. L'offre SDP inclut des informations à propos des éventuels objetsMediaStreamTrack 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'agentICE 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()

Renvoie un objetRTCConfiguration qui indique la configuration courante de la connexion.

getIdentityAssertion()

Initie la collecte d'une assertion d'identité et renvoie unepromesse 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 sisignalingState ne vaut pasclosed.

getReceivers()

Renvoie un tableu d'objetsRTCRtpReceiver dont chacun représente un récepteurRTP.

getSenders()

Renvoie un tableau d'objetsRTCRtpSender dont chacun représente un émetteurRTP dont le rôle est de transmettre les données d'une piste.

getStats()

Renvoie unepromesse dont la valeur de résolution sont des statistiques quant à la connexion globale ou à la pisteMediaStreamTrack indiquée.

getTransceivers()

Renvoie une liste de l'ensemble des objetsRTCRtpTransceiver utilisés afin d'envoyer et de recevoir des données sur la connexion.

removeTrack()

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'objetRTCRtpSender correspondant de la liste des récepteurs telle que fournie pargetSenders(). 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()

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émarrageICE.

setConfiguration()

Définit la configuration courante de la connexion en fonction des valeurs incluses dans l'objetRTCConfiguration passé en argument. Cela permet de modifier les serveursICE utilisés par la connexion ainsi que les règles de transport utilisées.

setIdentityProvider()

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()

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 unepromesse qui est résolue de façon asynchrone lorsque la description a été modifiée.

setRemoteDescription()

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 unepromesse qui est résolue de façon asynchrone lorsque la description a été modifiée.

Méthodes obsolètes

addStream()Obsolète

Ajoute un objetMediaStream comme source audio ou vidéo locale. La méthodeaddTrack() devrait être utilisée à la place pour chaque piste qu'on souhaite envoyer au pair distant.

createDTMFSender()Obsolète

Crée un nouvel émetteurRTCDTMFSender associé à une pisteMediaStreamTrack spécifique et qui est capable d'envoyer des signaux téléphoniquesDTMF via la connexion.

getStreamById()Obsolète

Renvoie l'objetMediaStream 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éthodesgetSenders() etgetReceivers().

removeStream()Obsolète

Supprime un fluxMediaStream qui est une source audio ou vidéo locale. Cette méthode est obsolète, on doit privilégierremoveTrack() à 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

Envoyé lorsque l'état de connectivité global de la connexionRTCPeerConnection évolue. Également disponible via la propriété de gestion d'évènementonconnectionstatechange.

datachannel

Envoyé lorsque le pair distant ajoute un canalRTCDataChannel à la connexion. Également disponible via la propriété de gestion d'évènementondatachannel.

icecandidate

Envoyé afin de demander à ce que le candidat indiqué soit transmis au pair distant. Également disponible via la propriété de gestion d'évènementonicecandidate.

icecandidateerror

Envoyé à la connexion si une erreur se produit lors de la collecte des candidatsICE. L'évènement décrit l'erreur. Également disponible via la propriété de gestion d'évènementonicecandidateerror.

iceconnectionstatechange

Envoyé lorsque l'état de la connexionICE change (par exemple lorsqu'elle se déconnecte). Également disponible via la propriété de gestion d'évènementoniceconnectionstatechange.

icegatheringstatechange

Envoyé lorsque l'état de collecte des couchesICE, tel que reflété pariceGatheringState, é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ènementonicegatheringstatechange.

negotiationneeded

Envoyé lorsqu'une négociation ou de la renégociation de la connexionICE 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ènementonnegotiationneeded.

signalingstatechange

Envoyé lorsque l'état de signalICE de la connexion change. Également disponible via la propriété de gestion d'évènementonsignalingstatechange.

track

Envoyé après qu'une nouvelle piste ait été ajoutée à une des instancesRTCRtpReceiver faisant partie de la connexion. Également disponible via la propriété de gestion d'évènementontrack.

Évènements obsolètes

addstreamObsolète

Envoyé lorsqu'un nouveau fluxMediaStream a été ajouté à la connexion. Plutôt que d'écouter cet évènement obsolète, on privilégiera les évènementstrack. Un tel évènement est envoyé pour chaque pisteMediaStreamTrack ajoutée à la connexion. Également disponible via la propriétéonaddstream.

removestreamObsolète

Envoyé lorsqu'un fluxMediaStream est retiré de la connexion. Plutôt que d'écouter cet évènement obsolète, on privilégiera les évènementsremovetrack pour chaque flux. Également disponible via la propriétéonremovestream.

Spécifications

Compatibilité des navigateurs

Voir aussi

• https://github.com/jesup/nightly-gupshup/blob/master/static/js/chat.js
• http://www.html5rocks.com/en/tutorials/webrtc/basics/#toc-simple
• TutorRoom : Une application de capture vidéo, de vidéo en pair à pair et de partage de fichiers en Node.js HTML5 (code source sur GitHub)