DieRTCPeerConnection-Schnittstelle repräsentiert eine WebRTC-Verbindung zwischen dem lokalen Computer und einem entfernten Peer.Sie bietet Methoden, um sich mit einem entfernten Peer zu verbinden, die Verbindung zu pflegen und zu überwachen sowie die Verbindung zu schließen, wenn sie nicht mehr benötigt wird.

Konstruktor

RTCPeerConnection()

Gibt eine neueRTCPeerConnection zurück, die eine Verbindung zwischen dem lokalen Gerät und einem entfernten Peer darstellt.

Instanz-Eigenschaften

Erbt auch Eigenschaften vonEventTarget.

canTrickleIceCandidatesSchreibgeschützt

Gibt einen booleschen Wert zurück, der angibt, ob der entfernte Peertrickle ICE candidates akzeptieren kann oder nicht.

connectionStateSchreibgeschützt

Gibt den aktuellen Zustand der Peer-Verbindung zurück, einer der Strings:new,connecting,connected,disconnected,failed oderclosed.

currentLocalDescriptionSchreibgeschützt

Gibt einRTCSessionDescription-Objekt zurück, das das lokale Ende der Verbindung beschreibt, wie es zuletzt erfolgreich ausgehandelt wurde, seitdem dieserRTCPeerConnection das Verhandeln und Verbinden mit einem entfernten Peer abgeschlossen hat.Ebenfalls enthalten ist eine Liste aller ICE-Kandidaten, die bereits vom ICE-Agenten seit dem ersten Instanziieren des in der Beschreibung dargestellten Angebots oder der Antwort generiert worden sein könnten.

currentRemoteDescriptionSchreibgeschützt

Gibt einRTCSessionDescription-Objekt zurück, das das entfernte Ende der Verbindung beschreibt, wie es zuletzt erfolgreich ausgehandelt wurde, seitdem dieserRTCPeerConnection das Verhandeln und Verbinden mit einem entfernten Peer abgeschlossen hat.Ebenfalls enthalten ist eine Liste aller ICE-Kandidaten, die bereits vom ICE-Agenten seit dem ersten Instanziieren des in der Beschreibung dargestellten Angebots oder der Antwort generiert worden sein könnten.

iceConnectionStateSchreibgeschützt

Gibt einen String zurück, der den Zustand des ICE-Agenten beschreibt, der mit dieser RTCPeer-Verbindung assoziiert ist.Er kann einen der folgenden Werte annehmen:new,checking,connected,completed,failed,disconnected oderclosed.

iceGatheringStateSchreibgeschützt

Gibt einen String zurück, der den ICE-Sammelzustand der Verbindung beschreibt.Dies ermöglicht es Ihnen beispielsweise zu erkennen, wann das Sammeln von ICE-Kandidaten abgeschlossen ist.Mögliche Werte sind:new,gathering odercomplete.

localDescriptionSchreibgeschützt

Gibt einRTCSessionDescription zurück,das die Sitzung für das lokale Ende der Verbindung beschreibt.Falls es noch nicht festgelegt wurde, wirdnull zurückgegeben.

peerIdentitySchreibgeschützt

Gibt einPromise zurück, das aufgelöst wird zu einemRTCIdentityAssertion, das einen String enthält, der den entfernten Peer identifiziert.Sobald dieses Versprechen erfolgreich aufgelöst wird, ist die resultierende Identität die Ziel-Peer-Identität und wird sich für die Dauer der Verbindung nicht ändern.

pendingLocalDescriptionSchreibgeschützt

Gibt einRTCSessionDescription-Objekt zurück, das eine anstehende Konfigurationsänderung für das lokale Ende der Verbindung beschreibt.Dies beschreibt nicht die aktuelle Verbindung, sondern wie sie sich in naher Zukunft darstellen könnte.

pendingRemoteDescriptionSchreibgeschützt

Gibt einRTCSessionDescription-Objekt zurück, das eine anstehende Konfigurationsänderung für das entfernte Ende der Verbindung beschreibt.Dies beschreibt nicht die aktuelle Verbindung, sondern wie sie sich in naher Zukunft darstellen könnte.

remoteDescriptionSchreibgeschützt

Gibt einRTCSessionDescription-Objekt zurück, das die Sitzung, einschließlich Konfiguration und Medieninformationen, für das entfernte Ende der Verbindung beschreibt.Falls dies noch nicht festgelegt wurde, wirdnull zurückgegeben.

sctpSchreibgeschützt

Gibt einRTCSctpTransport-Objekt zurück, das dieSCTP-Transportschicht beschreibt, über die SCTP-Daten gesendet und empfangen werden.Falls SCTP nicht ausgehandelt wurde, ist dieser Wertnull.

signalingStateSchreibgeschützt

Gibt einen String zurück, der den Zustand des Signalisierungsprozesses am lokalen Ende der Verbindung beschreibt, während ein anderes Peer verbunden oder erneut verbunden wird.Es ist einer der folgenden Werte:stable,have-local-offer,have-remote-offer,have-local-pranswer,have-remote-pranswer oderclosed.

Statische Methoden

RTCPeerConnection.generateCertificate()

Erstellt ein X.509-Zertifikat und seinen entsprechenden privaten Schlüssel und gibt einPromise zurück, das auf das neueRTCCertificate aufgelöst wird, sobald es generiert wurde.

Instanz-Methoden

Erbt auch Methoden vonEventTarget.

addIceCandidate()

Fügt einen neuen entfernten Kandidaten zur Remote-Beschreibung derRTCPeerConnection hinzu, welche den Zustand des entfernten Verbindungsendes beschreibt.

addTrack()

Fügt einen neuenMediaStreamTrack zu der Menge von Tracks hinzu, die zum anderen Peer übertragen werden sollen.

addTransceiver()

Erstellt einen neuenRTCRtpTransceiver und fügt ihn zur Menge der mit der Verbindung assoziierten Transceiver hinzu.Jeder Transceiver repräsentiert einen bidirektionalen Stream, mit einemRTCRtpSender und einemRTCRtpReceiver, die damit assoziiert sind.

close()

Schließt die aktuelle Peer-Verbindung.

createAnswer()

Initiiert die Erstellung einerSDP-Antwort auf ein Angebot, das von einem entfernten Peer während der Angebot-/Antwort-Verhandlung einer WebRTC-Verbindung empfangen wurde.Die Antwort enthält Informationen über alle Medien, die bereits an die Sitzung angehängt wurden, Codecs und Optionen, die vom Browser unterstützt werden, sowie alle bereits gesammeltenICE-Kandidaten.

createDataChannel()

Initiiert die Erstellung eines neuen Kanals, der mit dem entfernten Peer verbunden ist und über den alle Arten von Daten übertragen werden können.Dies kann nützlich sein für Back-Channel-Inhalte, wie Bilder, Dateitransfers, Textchats, Spiel-Aktualisierungspakete und so weiter.

createOffer()

Initiiert die Erstellung einesSDP-Angebots, um eine neue WebRTC-Verbindung zu einem entfernten Peer zu starten.Das SDP-Angebot enthält Informationen über alleMediaStreamTrack-Objekte, die bereits an die WebRTC-Sitzung angehängt sind, Codec und Optionen, die vom Browser unterstützt werden, sowie alle bereits gesammelten Kandidaten durch denICE-Agenten, um sie über den Signalisierungskanal an einen potentiellen Peer zu senden, um entweder eine Verbindung anzufordern oder die Konfiguration einer bestehenden Verbindung zu aktualisieren.

getConfiguration()

Gibt ein Objekt zurück, das die aktuelle Konfiguration der Verbindung anzeigt.

getIdentityAssertion()

Initiiert das Sammeln einer Identitätsaussage und gibt einPromise zurück, das auf eine als String codierte Identitätsaussage aufgelöst wird.Dies hat nur einen Effekt, wennsignalingState nichtclosed ist.

getReceivers()

Gibt ein Array vonRTCRtpReceiver-Objekten zurück, von denen jedes einenRTP-Empfänger repräsentiert.

getSenders()

Gibt ein Array vonRTCRtpSender-Objekten zurück, von denen jedes denRTP-Sender repräsentiert, der für die Datenübertragung eines Tracks verantwortlich ist.

getStats()

Gibt einPromise zurück, das mit Daten aufgelöst wird, die Statistikinformationen über entweder die gesamte Verbindung oder über den angegebenenMediaStreamTrack liefern.

getTransceivers()

Gibt eine Liste allerRTCRtpTransceiver-Objekte zurück, die zum Senden und Empfangen von Daten auf der Verbindung verwendet werden.

removeTrack()

Weist das lokale Ende der Verbindung an, das Senden von Medien des angegebenen Tracks zu stoppen, ohne den entsprechendenRTCRtpSender aus der Liste der Sender zu entfernen,wie sie vongetSenders() angegeben wird.Wenn der Track bereits gestoppt ist oder sich nicht in der Senderliste der Verbindung befindet, hat diese Methode keinen Effekt.

restartIce()

Ermöglicht eine einfache Anforderung, dass das Sammeln von ICE-Kandidaten an beiden Enden der Verbindung erneut durchgeführt wird.Dies vereinfacht den Prozess, indem die gleiche Methode verwendet wird, entweder vom Anrufer oder vom Empfänger, um einenICE-Neustart auszulösen.

setConfiguration()

Legt die aktuelle Konfiguration der Verbindung basierend auf den in dem angegebenen Objekt enthaltenen Werten fest.Dies ermöglicht es Ihnen, die von der Verbindung verwendetenICE-Server und welche Transportpolitiken verwendet werden sollen, zu ändern.

setIdentityProvider()

Setzt den Identity Provider (IdP) auf das im Parameter angegebene Triplet: seinen Namen, das Protokoll, das verwendet wird, um mit ihm zu kommunizieren und einen Benutzernamen.Das Protokoll und der Benutzername sind optional.

setLocalDescription()

Ändert die mit der Verbindung verknüpfte lokale Beschreibung.Diese Beschreibung gibt die Eigenschaften des lokalen Endes der Verbindung an, einschließlich des Medienformats.Es gibt einPromise zurück, das erfüllt wird, sobald die Beschreibung asynchron geändert wurde.

setRemoteDescription()

Setzt die angegebene Sitzungsbeschreibung als aktuelles Angebot oder Antwort des entfernten Peers.Die Beschreibung spezifiziert die Eigenschaften des entfernten Endes der Verbindung, einschließlich des Medienformats.Es gibt einPromise zurück, das erfüllt wird, sobald die Beschreibung asynchron geändert wurde.

Veraltete Methoden

addStream()VeraltetNicht standardisiert

Fügt einenMediaStream als lokale Audio- oder Videoquelle hinzu.Anstatt diese veraltete Methode zu verwenden, sollten Sie stattdessenaddTrack() für jeden Track verwenden, den Sie an den entfernten Peer senden möchten.

createDTMFSender()VeraltetNicht standardisiert

Erstellt einen neuenRTCDTMFSender, der mit einem bestimmtenMediaStreamTrack assoziiert ist und DTMF-Telefonsignalisierung über die Verbindung senden kann.

removeStream()VeraltetNicht standardisiert

Entfernt einenMediaStream als lokale Audio- oder Videoquelle.Weil diese Methode veraltet ist, sollten Sie stattdessenremoveTrack() verwenden.

Ereignisse

Hören Sie diese Ereignisse mitaddEventListener() oder indem Sie einen Ereignis-Listener der Eigenschaftoneventname dieser Schnittstelle zuweisen.

connectionstatechange

Wird gesendet, wenn sich der allgemeine Verbindungsstatus derRTCPeerConnection ändert.

datachannel

Wird gesendet, wenn der entfernte Peer einenRTCDataChannel zur Verbindung hinzufügt.

icecandidate

Wird gesendet, um anzufordern, dass der angegebene Kandidat an den entfernten Peer übertragen wird.

icecandidateerror

Wird an die Verbindung gesendet, wenn während des Sammelns vonICE-Kandidaten ein Fehler auftritt. Das Ereignis beschreibt den Fehler.

iceconnectionstatechange

Wird gesendet, wenn sich der Zustand derICE-Verbindung verändert, beispielsweise wenn sie getrennt wird.

icegatheringstatechange

Wird gesendet, wenn sich der Sammelzustand derICE-Schicht, dargestellt durchiceGatheringState, ändert.Dies zeigt an, ob die ICE-Verhandlung noch nicht begonnen hat (new), begonnen hat, Kandidaten zu sammeln (gathering), oder abgeschlossen ist (complete).

negotiationneeded

Wird gesendet, wenn die Verhandlung oder Neuverhandlung derICE-Verbindung durchgeführt werden muss;Dies kann sowohl beim ersten Öffnen einer Verbindung passieren, als auch wenn es notwendig ist, sich an sich ändernde Netzwerkbedingungen anzupassen.Der Empfänger sollte reagieren, indem er ein Angebot erstellt und es an den anderen Peer sendet.

signalingstatechange

Wird gesendet, wenn sich der Signalisierungszustand derICE-Verbindung ändert.

track

Wird gesendet, nachdem ein neuer Track zu einer derRTCRtpReceiver-Instanzen hinzugefügt wurde, die die Verbindung bilden.

Veraltete Ereignisse

addstreamVeraltetNicht standardisiert

Wird gesendet, wenn ein neuerMediaStream zur Verbindung hinzugefügt wird.Anstatt auf dieses veraltete Ereignis zu hören, sollten Sie auftrack-Ereignisse hören;eines wird für jedenMediaStreamTrack gesendet, der der Verbindung hinzugefügt wird.

removestreamVeraltetNicht standardisiert

Wird gesendet, wenn einMediaStream aus der Verbindung entfernt wird.Anstatt auf dieses veraltete Ereignis zu hören, sollten Sie aufremovetrack-Ereignisse auf jedem Stream hören.

Spezifikationen

Browser-Kompatibilität

Siehe auch

• https://github.com/jesup/nightly-gupshup/blob/master/static/js/chat.js
• Erste Schritte mit WebRTC
• TutorRoom: Node.js HTML-Videoaufzeichnung, Peer-to-Peer-Video- und Dateifreigabeanwendung (Quellcode auf GitHub)