RTCPeerConnection (Akasha Java Browser API for J2CL)

java.lang.Object
- akasha.core.JsObject
- - akasha.EventTarget
  - - akasha.rtc.RTCPeerConnection

```
@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="RTCPeerConnection")
public class RTCPeerConnection
extends EventTarget
```
The RTCPeerConnection interface represents a WebRTC connection between the local computer and a remote peer. It provides methods to connect to a remote peer, maintain and monitor the connection, and close the connection once it's no longer needed.

See Also:

RTCPeerConnection - MDN, RTCPeerConnection - WebRTC 1.0: Real-time Communication Between Browsers

Field Summary

Fields
Modifier and Type	Field and Description
`EventHandler`	`onconnectionstatechange` The RTCPeerConnection.onconnectionstatechange property specifies an EventHandler which is called to handle the connectionstatechange event when it occurs on an instance of RTCPeerConnection.
`RTCDataChannelEventHandler`	`ondatachannel` The RTCPeerConnection.ondatachannel property is an EventHandler which specifies a function which is called when the datachannel event occurs on an RTCPeerConnection.
`RTCPeerConnectionIceEventHandler`	`onicecandidate` The RTCPeerConnection property onicecandidate property is an EventHandler which specifies a function to be called when the icecandidate event occurs on an RTCPeerConnection instance.
`RTCPeerConnectionIceErrorEventHandler`	`onicecandidateerror` The RTCPeerConnection.onicecandidateerror property is an EventHandler which specifies a function which is called to handle the icecandidateerror event when it occurs on an RTCPeerConnection instance.
`EventHandler`	`oniceconnectionstatechange` The RTCPeerConnection.oniceconnectionstatechange property is an event handler which specifies a function to be called when the iceconnectionstatechange event is fired on an RTCPeerConnection instance.
`EventHandler`	`onicegatheringstatechange` The RTCPeerConnection.onicegatheringstatechange property is an EventHandler which specifies a function to be called when the icegatheringstatechange event is sent to an RTCPeerConnection instance.
`EventHandler`	`onnegotiationneeded` The RTCPeerConnection interface's onnegotiationneeded property is an EventListener which specifies a function which is called to handle the negotiationneeded event when it occurs on an RTCPeerConnection instance.
`EventHandler`	`onsignalingstatechange` The onsignalingstatechange event handler property of the RTCPeerConnection interface specifies a function to be called when the signalingstatechange event occurs on an RTCPeerConnection interface.
`RTCTrackEventHandler`	`ontrack` The RTCPeerConnection property ontrack is an EventHandler which specifies a function to be called when the track event occurs, indicating that a track has been added to the RTCPeerConnection.

Constructor Summary

Constructors
Constructor and Description
`RTCPeerConnection()` The RTCPeerConnection() constructor returns a newly-created RTCPeerConnection, which represents a connection between the local device and a remote peer.
`RTCPeerConnection(RTCConfiguration configuration)` The RTCPeerConnection() constructor returns a newly-created RTCPeerConnection, which represents a connection between the local device and a remote peer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConnectionstatechangeListener(EventListener callback)`
`void`	`addConnectionstatechangeListener(EventListener callback, AddEventListenerOptions options)`
`void`	`addConnectionstatechangeListener(EventListener callback, boolean useCapture)`
`void`	`addDatachannelListener(RTCDataChannelEventListener callback)`
`void`	`addDatachannelListener(RTCDataChannelEventListener callback, AddEventListenerOptions options)`
`void`	`addDatachannelListener(RTCDataChannelEventListener callback, boolean useCapture)`
`Promise<java.lang.Void>`	`addIceCandidate()` When a web site or app using RTCPeerConnection receives a new ICE candidate from the remote peer over its signaling channel, it delivers the newly-received candidate to the browser's ICE agent by calling RTCPeerConnection.addIceCandidate().
`Promise<java.lang.Void>`	`addIceCandidate(RTCIceCandidateInit candidate)` When a web site or app using RTCPeerConnection receives a new ICE candidate from the remote peer over its signaling channel, it delivers the newly-received candidate to the browser's ICE agent by calling RTCPeerConnection.addIceCandidate().
`Promise<java.lang.Void>`	`addIceCandidate(RTCIceCandidateInit candidate, VoidFunction successCallback, RTCPeerConnectionErrorCallback failureCallback)` When a web site or app using RTCPeerConnection receives a new ICE candidate from the remote peer over its signaling channel, it delivers the newly-received candidate to the browser's ICE agent by calling RTCPeerConnection.addIceCandidate().
`void`	`addIcecandidateerrorListener(RTCPeerConnectionIceErrorEventListener callback)`
`void`	`addIcecandidateerrorListener(RTCPeerConnectionIceErrorEventListener callback, AddEventListenerOptions options)`
`void`	`addIcecandidateerrorListener(RTCPeerConnectionIceErrorEventListener callback, boolean useCapture)`
`void`	`addIcecandidateListener(RTCPeerConnectionIceEventListener callback)`
`void`	`addIcecandidateListener(RTCPeerConnectionIceEventListener callback, AddEventListenerOptions options)`
`void`	`addIcecandidateListener(RTCPeerConnectionIceEventListener callback, boolean useCapture)`
`void`	`addIceconnectionstatechangeListener(EventListener callback)`
`void`	`addIceconnectionstatechangeListener(EventListener callback, AddEventListenerOptions options)`
`void`	`addIceconnectionstatechangeListener(EventListener callback, boolean useCapture)`
`void`	`addIcegatheringstatechangeListener(EventListener callback)`
`void`	`addIcegatheringstatechangeListener(EventListener callback, AddEventListenerOptions options)`
`void`	`addIcegatheringstatechangeListener(EventListener callback, boolean useCapture)`
`void`	`addNegotiationneededListener(EventListener callback)`
`void`	`addNegotiationneededListener(EventListener callback, AddEventListenerOptions options)`
`void`	`addNegotiationneededListener(EventListener callback, boolean useCapture)`
`void`	`addPeeridentityListener(EventListener callback)`
`void`	`addPeeridentityListener(EventListener callback, AddEventListenerOptions options)`
`void`	`addPeeridentityListener(EventListener callback, boolean useCapture)`
`void`	`addSignalingstatechangeListener(EventListener callback)`
`void`	`addSignalingstatechangeListener(EventListener callback, AddEventListenerOptions options)`
`void`	`addSignalingstatechangeListener(EventListener callback, boolean useCapture)`
`RTCRtpSender`	`addTrack(MediaStreamTrack track, MediaStream... streams)` The RTCPeerConnection method addTrack() adds a new media track to the set of tracks which will be transmitted to the other peer.
`void`	`addTrackListener(RTCTrackEventListener callback)`
`void`	`addTrackListener(RTCTrackEventListener callback, AddEventListenerOptions options)`
`void`	`addTrackListener(RTCTrackEventListener callback, boolean useCapture)`
`RTCRtpTransceiver`	`addTransceiver(MediaStreamTrack trackOrKind)`
`RTCRtpTransceiver`	`addTransceiver(MediaStreamTrack trackOrKind, RTCRtpTransceiverInit init)`
`RTCRtpTransceiver`	`addTransceiver(java.lang.String trackOrKind)`
`RTCRtpTransceiver`	`addTransceiver(java.lang.String trackOrKind, RTCRtpTransceiverInit init)`
`java.lang.Boolean`	`canTrickleIceCandidates()` The read-only RTCPeerConnection property canTrickleIceCandidates returns a Boolean which indicates whether or not the remote peer can accept trickled ICE candidates.
`void`	`close()` The RTCPeerConnection.close() method closes the current peer connection.
`java.lang.String`	`connectionState()` The read-only connectionState property of the RTCPeerConnection interface indicates the current state of the peer connection by returning one of the string values specified by the enum RTCPeerConnectionState.
`Promise<RTCSessionDescriptionInit>`	`createAnswer()` The createAnswer() method on the RTCPeerConnection interface creates an SDP answer to an offer received from a remote peer during the offer/answer negotiation of a WebRTC connection.
`Promise<RTCSessionDescriptionInit>`	`createAnswer(RTCAnswerOptions options)` The createAnswer() method on the RTCPeerConnection interface creates an SDP answer to an offer received from a remote peer during the offer/answer negotiation of a WebRTC connection.
`Promise<java.lang.Void>`	`createAnswer(RTCSessionDescriptionCallback successCallback, RTCPeerConnectionErrorCallback failureCallback)` The createAnswer() method on the RTCPeerConnection interface creates an SDP answer to an offer received from a remote peer during the offer/answer negotiation of a WebRTC connection.
`RTCDataChannel`	`createDataChannel(java.lang.String label)` The createDataChannel() method on the RTCPeerConnection interface creates a new channel linked with the remote peer, over which any kind of data may be transmitted.
`RTCDataChannel`	`createDataChannel(java.lang.String label, RTCDataChannelInit dataChannelDict)` The createDataChannel() method on the RTCPeerConnection interface creates a new channel linked with the remote peer, over which any kind of data may be transmitted.
`Promise<RTCSessionDescriptionInit>`	`createOffer()` The createOffer() method of the RTCPeerConnection interface initiates the creation of an SDP offer for the purpose of starting a new WebRTC connection to a remote peer.
`Promise<RTCSessionDescriptionInit>`	`createOffer(RTCOfferOptions options)` The createOffer() method of the RTCPeerConnection interface initiates the creation of an SDP offer for the purpose of starting a new WebRTC connection to a remote peer.
`Promise<java.lang.Void>`	`createOffer(RTCSessionDescriptionCallback successCallback, RTCPeerConnectionErrorCallback failureCallback)` The createOffer() method of the RTCPeerConnection interface initiates the creation of an SDP offer for the purpose of starting a new WebRTC connection to a remote peer.
`Promise<java.lang.Void>`	`createOffer(RTCSessionDescriptionCallback successCallback, RTCPeerConnectionErrorCallback failureCallback, RTCOfferOptions options)` The createOffer() method of the RTCPeerConnection interface initiates the creation of an SDP offer for the purpose of starting a new WebRTC connection to a remote peer.
`RTCSessionDescription`	`currentLocalDescription()` The read-only property RTCPeerConnection.currentLocalDescription returns an RTCSessionDescription object describing the local end of the connection as it was most recently successfully negotiated since the last time the RTCPeerConnection finished negotiating and connecting to a remote peer.
`RTCSessionDescription`	`currentRemoteDescription()` The read-only property RTCPeerConnection.currentRemoteDescription returns an RTCSessionDescription object describing the remote end of the connection as it was most recently successfully negotiated since the last time the RTCPeerConnection finished negotiating and connecting to a remote peer.
`static Promise<RTCCertificate>`	`generateCertificate(AlgorithmIdentifier keygenAlgorithm)` The static RTCPeerConnection.generateCertificate() function creates an X.509 certificate and corresponding private key, returning a promise that resolves with the new RTCCertificate once it's generated.
`static Promise<RTCCertificate>`	`generateCertificate(JsObject keygenAlgorithm)` The static RTCPeerConnection.generateCertificate() function creates an X.509 certificate and corresponding private key, returning a promise that resolves with the new RTCCertificate once it's generated.
`static Promise<RTCCertificate>`	`generateCertificate(java.lang.String keygenAlgorithm)` The static RTCPeerConnection.generateCertificate() function creates an X.509 certificate and corresponding private key, returning a promise that resolves with the new RTCCertificate once it's generated.
`RTCConfiguration`	`getConfiguration()` The RTCPeerConnection.getConfiguration() method returns an RTCConfiguration object which indicates the current configuration of the RTCPeerConnection on which the method is called.
`Promise<java.lang.String>`	`getIdentityAssertion()` The RTCPeerConnection.getIdentityAssertion() method initiates the gathering of an identity assertion.
`JsArray<RTCRtpReceiver>`	`getReceivers()` The RTCPeerConnection.getReceivers() method returns an array of RTCRtpReceiver objects, each of which represents one RTP receiver.
`JsArray<RTCRtpSender>`	`getSenders()` The RTCPeerConnection method getSenders() returns an array of RTCRtpSender objects, each of which represents the RTP sender responsible for transmitting one track's data.
`Promise<RTCStatsReport>`	`getStats()` The RTCPeerConnection method getStats() returns a promise which resolves with data providing statistics about either the overall connection or about the specified MediaStreamTrack.
`Promise<RTCStatsReport>`	`getStats(MediaStreamTrack selector)` The RTCPeerConnection method getStats() returns a promise which resolves with data providing statistics about either the overall connection or about the specified MediaStreamTrack.
`JsArray<RTCRtpTransceiver>`	`getTransceivers()` The RTCPeerConnection interface's getTransceivers() method returns a list of the RTCRtpTransceiver objects being used to send and receive data on the connection.
`java.lang.String`	`iceConnectionState()` The read-only property RTCPeerConnection.iceConnectionState returns an enum of type RTCIceConnectionState which state of the ICE agent associated with the RTCPeerConnection.
`java.lang.String`	`iceGatheringState()` The read-only property RTCPeerConnection.iceGatheringState returns an enum of type RTCIceGatheringState that describes connection's ICE gathering state.
`java.lang.String`	`idpErrorInfo()`
`java.lang.String`	`idpLoginUrl()`
`RTCSessionDescription`	`localDescription()` The read-only property RTCPeerConnection.localDescription returns an RTCSessionDescription describing the session for the local end of the connection.
`Promise<RTCIdentityAssertion>`	`peerIdentity()` The read-only RTCPeerConnection property peerIdentity returns a JavaScript Promise that resolves to an RTCIdentityAssertion which contains a DOMString identifying the remote peer.
`RTCSessionDescription`	`pendingLocalDescription()` The read-only property RTCPeerConnection.pendingLocalDescription returns an RTCSessionDescription object describing a pending configuration change for the local end of the connection.
`RTCSessionDescription`	`pendingRemoteDescription()` The read-only property RTCPeerConnection.pendingRemoteDescription returns an RTCSessionDescription object describing a pending configuration change for the remote end of the connection.
`RTCSessionDescription`	`remoteDescription()` The read-only property RTCPeerConnection.remoteDescription returns a RTCSessionDescription describing the session (which includes configuration and media information) for the remote end of the connection.
`void`	`removeConnectionstatechangeListener(EventListener callback)`
`void`	`removeConnectionstatechangeListener(EventListener callback, boolean useCapture)`
`void`	`removeConnectionstatechangeListener(EventListener callback, EventListenerOptions options)`
`void`	`removeDatachannelListener(RTCDataChannelEventListener callback)`
`void`	`removeDatachannelListener(RTCDataChannelEventListener callback, boolean useCapture)`
`void`	`removeDatachannelListener(RTCDataChannelEventListener callback, EventListenerOptions options)`
`void`	`removeIcecandidateerrorListener(RTCPeerConnectionIceErrorEventListener callback)`
`void`	`removeIcecandidateerrorListener(RTCPeerConnectionIceErrorEventListener callback, boolean useCapture)`
`void`	`removeIcecandidateerrorListener(RTCPeerConnectionIceErrorEventListener callback, EventListenerOptions options)`
`void`	`removeIcecandidateListener(RTCPeerConnectionIceEventListener callback)`
`void`	`removeIcecandidateListener(RTCPeerConnectionIceEventListener callback, boolean useCapture)`
`void`	`removeIcecandidateListener(RTCPeerConnectionIceEventListener callback, EventListenerOptions options)`
`void`	`removeIceconnectionstatechangeListener(EventListener callback)`
`void`	`removeIceconnectionstatechangeListener(EventListener callback, boolean useCapture)`
`void`	`removeIceconnectionstatechangeListener(EventListener callback, EventListenerOptions options)`
`void`	`removeIcegatheringstatechangeListener(EventListener callback)`
`void`	`removeIcegatheringstatechangeListener(EventListener callback, boolean useCapture)`
`void`	`removeIcegatheringstatechangeListener(EventListener callback, EventListenerOptions options)`
`void`	`removeNegotiationneededListener(EventListener callback)`
`void`	`removeNegotiationneededListener(EventListener callback, boolean useCapture)`
`void`	`removeNegotiationneededListener(EventListener callback, EventListenerOptions options)`
`void`	`removePeeridentityListener(EventListener callback)`
`void`	`removePeeridentityListener(EventListener callback, boolean useCapture)`
`void`	`removePeeridentityListener(EventListener callback, EventListenerOptions options)`
`void`	`removeSignalingstatechangeListener(EventListener callback)`
`void`	`removeSignalingstatechangeListener(EventListener callback, boolean useCapture)`
`void`	`removeSignalingstatechangeListener(EventListener callback, EventListenerOptions options)`
`void`	`removeTrack(RTCRtpSender sender)` The RTCPeerConnection.removeTrack() method tells the local end of the connection to stop sending media from the specified track, without actually removing the corresponding RTCRtpSender from the list of senders as reported by RTCPeerConnection.getSenders().
`void`	`removeTrackListener(RTCTrackEventListener callback)`
`void`	`removeTrackListener(RTCTrackEventListener callback, boolean useCapture)`
`void`	`removeTrackListener(RTCTrackEventListener callback, EventListenerOptions options)`
`void`	`restartIce()` The WebRTC API's RTCPeerConnection interface offers the restartIce() method to allow a web application to easily request that ICE candidate gathering be redone on both ends of the connection.
`RTCSctpTransport`	`sctp()` The read-only sctp property on the RTCPeerConnection interface returns an RTCSctpTransport describing the SCTP transport over which SCTP data is being sent and received.
`void`	`setConfiguration()` The RTCPeerConnection.setConfiguration() method sets the current configuration of the RTCPeerConnection based on the values included in the specified RTCConfiguration object.
`void`	`setConfiguration(RTCConfiguration configuration)` The RTCPeerConnection.setConfiguration() method sets the current configuration of the RTCPeerConnection based on the values included in the specified RTCConfiguration object.
`void`	`setIdentityProvider(java.lang.String provider)` The RTCPeerConnection.setIdentityProvider() method sets the Identity Provider (IdP) to the triplet given in parameter: its name, the protocol used to communicate with it (optional) and an optional username.
`void`	`setIdentityProvider(java.lang.String provider, RTCIdentityProviderOptions options)` The RTCPeerConnection.setIdentityProvider() method sets the Identity Provider (IdP) to the triplet given in parameter: its name, the protocol used to communicate with it (optional) and an optional username.
`Promise<java.lang.Void>`	`setLocalDescription()` The RTCPeerConnection method setLocalDescription() changes the local description associated with the connection.
`Promise<java.lang.Void>`	`setLocalDescription(RTCLocalSessionDescriptionInit description)` The RTCPeerConnection method setLocalDescription() changes the local description associated with the connection.
`Promise<java.lang.Void>`	`setLocalDescription(RTCLocalSessionDescriptionInit description, VoidFunction successCallback, RTCPeerConnectionErrorCallback failureCallback)` The RTCPeerConnection method setLocalDescription() changes the local description associated with the connection.
`Promise<java.lang.Void>`	`setRemoteDescription(RTCSessionDescriptionInit description)` The RTCPeerConnection method setRemoteDescription() sets the specified session description as the remote peer's current offer or answer.
`Promise<java.lang.Void>`	`setRemoteDescription(RTCSessionDescriptionInit description, VoidFunction successCallback, RTCPeerConnectionErrorCallback failureCallback)` The RTCPeerConnection method setRemoteDescription() sets the specified session description as the remote peer's current offer or answer.
`java.lang.String`	`signalingState()` The read-only signalingState property on the RTCPeerConnection interface returns one of the string values specified by the RTCSignalingState enum; these values describe the state of the signaling process on the local end of the connection while connecting or reconnecting to another peer.

Methods inherited from class akasha.EventTarget
addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject
assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, is, isExtensible, isFrozen, isSealed, keys, preventExtensions, seal, setPrototypeOf, valueOf_, values

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- onconnectionstatechange
```
@Nullable
public EventHandler onconnectionstatechange
```
  The RTCPeerConnection.onconnectionstatechange property specifies an EventHandler which is called to handle the connectionstatechange event when it occurs on an instance of RTCPeerConnection. This happens whenever the aggregate state of the connection changes.
  
  See Also:
  
  RTCPeerConnection.onconnectionstatechange - MDN, RTCPeerConnection.onconnectionstatechange - WebRTC 1.0: Real-time Communication Between Browsers
- ondatachannel
```
@Nullable
public RTCDataChannelEventHandler ondatachannel
```
  The RTCPeerConnection.ondatachannel property is an EventHandler which specifies a function which is called when the datachannel event occurs on an RTCPeerConnection. This event, of type RTCDataChannelEvent, is sent when an RTCDataChannel is added to the connection by the remote peer calling createDataChannel().
  
  See Also:
  
  RTCPeerConnection.ondatachannel - MDN, RTCPeerConnection.ondatachannel - WebRTC 1.0: Real-time Communication Between Browsers
- onicecandidate
```
@Nullable
public RTCPeerConnectionIceEventHandler onicecandidate
```
  The RTCPeerConnection property onicecandidate property is an EventHandler which specifies a function to be called when the icecandidate event occurs on an RTCPeerConnection instance. This happens whenever the local ICE agent needs to deliver a message to the other peer through the signaling server.
  
  See Also:
  
  RTCPeerConnection.onicecandidate - MDN, RTCPeerConnection.onicecandidate - WebRTC 1.0: Real-time Communication Between Browsers
- onicecandidateerror
```
@Nullable
public RTCPeerConnectionIceErrorEventHandler onicecandidateerror
```
  The RTCPeerConnection.onicecandidateerror property is an EventHandler which specifies a function which is called to handle the icecandidateerror event when it occurs on an RTCPeerConnection instance. This event is fired when an error occurs during the ICE candidate gathering process.
  
  See Also:
  
  RTCPeerConnection.onicecandidateerror - MDN, RTCPeerConnection.onicecandidateerror - WebRTC 1.0: Real-time Communication Between Browsers
- oniceconnectionstatechange
```
@Nullable
public EventHandler oniceconnectionstatechange
```
  The RTCPeerConnection.oniceconnectionstatechange property is an event handler which specifies a function to be called when the iceconnectionstatechange event is fired on an RTCPeerConnection instance. This happens when the state of the connection's ICE agent, as represented by the iceConnectionState property, changes.
  
  See Also:
  
  RTCPeerConnection.oniceconnectionstatechange - MDN, RTCPeerConnection.oniceconnectionstatechange - WebRTC 1.0: Real-time Communication Between Browsers
- onicegatheringstatechange
```
@Nullable
public EventHandler onicegatheringstatechange
```
  The RTCPeerConnection.onicegatheringstatechange property is an EventHandler which specifies a function to be called when the icegatheringstatechange event is sent to an RTCPeerConnection instance. This happens when the ICE gathering state—that is, whether or not the ICE agent is actively gathering candidates—changes.
  
  See Also:
  
  RTCPeerConnection.onicegatheringstatechange - MDN, RTCPeerConnection.onicegatheringstatechange - WebRTC 1.0: Real-time Communication Between Browsers
- onnegotiationneeded
```
@Nullable
public EventHandler onnegotiationneeded
```
  The RTCPeerConnection interface's onnegotiationneeded property is an EventListener which specifies a function which is called to handle the negotiationneeded event when it occurs on an RTCPeerConnection instance. This event is fired when a change has occurred which requires session negotiation. This negotiation should be carried out as the offerer, because some session changes cannot be negotiated as the answerer.
  
  See Also:
  
  RTCPeerConnection.onnegotiationneeded - MDN, RTCPeerConnection.onnegotiationneeded - WebRTC 1.0: Real-time Communication Between Browsers
- onsignalingstatechange
```
@Nullable
public EventHandler onsignalingstatechange
```
  The onsignalingstatechange event handler property of the RTCPeerConnection interface specifies a function to be called when the signalingstatechange event occurs on an RTCPeerConnection interface.
  
  See Also:
  
  RTCPeerConnection.onsignalingstatechange - MDN, RTCPeerConnection.onsignalingstatechange - WebRTC 1.0: Real-time Communication Between Browsers
- ontrack
```
@Nullable
public RTCTrackEventHandler ontrack
```
  The RTCPeerConnection property ontrack is an EventHandler which specifies a function to be called when the track event occurs, indicating that a track has been added to the RTCPeerConnection.
  
  See Also:
  
  RTCPeerConnection.ontrack - MDN, RTCPeerConnection.ontrack - WebRTC 1.0: Real-time Communication Between Browsers

Constructor Detail
- RTCPeerConnection
```
public RTCPeerConnection(@Nonnull
                         RTCConfiguration configuration)
```
  The RTCPeerConnection() constructor returns a newly-created RTCPeerConnection, which represents a connection between the local device and a remote peer.
  
  See Also:
  
  RTCPeerConnection.RTCPeerConnection - MDN, RTCPeerConnection() - WebRTC 1.0: Real-time Communication Between Browsers
- RTCPeerConnection
```
public RTCPeerConnection()
```
  The RTCPeerConnection() constructor returns a newly-created RTCPeerConnection, which represents a connection between the local device and a remote peer.
  
  See Also:
  
  RTCPeerConnection.RTCPeerConnection - MDN, RTCPeerConnection() - WebRTC 1.0: Real-time Communication Between Browsers

Method Detail

canTrickleIceCandidates
```
@JsProperty(name="canTrickleIceCandidates")
 @Nullable
public java.lang.Boolean canTrickleIceCandidates()
```
The read-only RTCPeerConnection property canTrickleIceCandidates returns a Boolean which indicates whether or not the remote peer can accept trickled ICE candidates.

See Also:

RTCPeerConnection.canTrickleIceCandidates - MDN, RTCPeerConnection.canTrickleIceCandidates - WebRTC 1.0: Real-time Communication Between Browsers

connectionState
```
@JsProperty(name="connectionState")
 @Nonnull
 @RTCPeerConnectionState
public java.lang.String connectionState()
```
The read-only connectionState property of the RTCPeerConnection interface indicates the current state of the peer connection by returning one of the string values specified by the enum RTCPeerConnectionState.

See Also:

RTCPeerConnection.connectionState - MDN, RTCPeerConnection.connectionState - WebRTC 1.0: Real-time Communication Between Browsers

currentLocalDescription
```
@JsProperty(name="currentLocalDescription")
 @Nullable
public RTCSessionDescription currentLocalDescription()
```
The read-only property RTCPeerConnection.currentLocalDescription returns an RTCSessionDescription object describing the local end of the connection as it was most recently successfully negotiated since the last time the RTCPeerConnection finished negotiating and connecting to a remote peer. Also included is a list of any ICE candidates that may already have been generated by the ICE agent since the offer or answer represented by the description was first instantiated.

See Also:

RTCPeerConnection.currentLocalDescription - MDN, RTCPeerConnection.currentLocalDescription - WebRTC 1.0: Real-time Communication Between Browsers

currentRemoteDescription
```
@JsProperty(name="currentRemoteDescription")
 @Nullable
public RTCSessionDescription currentRemoteDescription()
```
The read-only property RTCPeerConnection.currentRemoteDescription returns an RTCSessionDescription object describing the remote end of the connection as it was most recently successfully negotiated since the last time the RTCPeerConnection finished negotiating and connecting to a remote peer. Also included is a list of any ICE candidates that may already have been generated by the ICE agent since the offer or answer represented by the description was first instantiated.

See Also:

RTCPeerConnection.currentRemoteDescription - MDN, RTCPeerConnection.currentRemoteDescription - WebRTC 1.0: Real-time Communication Between Browsers

iceConnectionState
```
@JsProperty(name="iceConnectionState")
 @Nonnull
 @RTCIceConnectionState
public java.lang.String iceConnectionState()
```
The read-only property RTCPeerConnection.iceConnectionState returns an enum of type RTCIceConnectionState which state of the ICE agent associated with the RTCPeerConnection.

See Also:

RTCPeerConnection.iceConnectionState - MDN, RTCPeerConnection.iceConnectionState - WebRTC 1.0: Real-time Communication Between Browsers

iceGatheringState
```
@JsProperty(name="iceGatheringState")
 @Nonnull
 @RTCIceGatheringState
public java.lang.String iceGatheringState()
```
The read-only property RTCPeerConnection.iceGatheringState returns an enum of type RTCIceGatheringState that describes connection's ICE gathering state. This lets you detect, for example, when collection of ICE candidates has finished.

See Also:

RTCPeerConnection.iceGatheringState - MDN, RTCPeerConnection.iceGatheringState - WebRTC 1.0: Real-time Communication Between Browsers

idpErrorInfo

@JsProperty(name="idpErrorInfo")
 @Nullable
public java.lang.String idpErrorInfo()

idpLoginUrl

@JsProperty(name="idpLoginUrl")
 @Nullable
public java.lang.String idpLoginUrl()

localDescription
```
@JsProperty(name="localDescription")
 @Nullable
public RTCSessionDescription localDescription()
```
The read-only property RTCPeerConnection.localDescription returns an RTCSessionDescription describing the session for the local end of the connection. If it has not yet been set, this is null .

See Also:

RTCPeerConnection.localDescription - MDN, RTCPeerConnection.localDescription - WebRTC 1.0: Real-time Communication Between Browsers

peerIdentity
```
@JsProperty(name="peerIdentity")
 @Nonnull
public Promise<RTCIdentityAssertion> peerIdentity()
```
The read-only RTCPeerConnection property peerIdentity returns a JavaScript Promise that resolves to an RTCIdentityAssertion which contains a DOMString identifying the remote peer.

See Also:

RTCPeerConnection.peerIdentity - MDN, Identity for WebRTC

pendingLocalDescription
```
@JsProperty(name="pendingLocalDescription")
 @Nullable
public RTCSessionDescription pendingLocalDescription()
```
The read-only property RTCPeerConnection.pendingLocalDescription returns an RTCSessionDescription object describing a pending configuration change for the local end of the connection. This does not describe the connection as it currently stands, but as it may exist in the near future. Use RTCPeerConnection.currentLocalDescription or RTCPeerConnection.localDescription to get the current state of the endpoint. For details on the difference, see Pending and current descriptions in WebRTC connectivity.

See Also:

RTCPeerConnection.pendingLocalDescription - MDN, RTCPeerConnection.pendingLocalDescription - WebRTC 1.0: Real-time Communication Between Browsers

pendingRemoteDescription
```
@JsProperty(name="pendingRemoteDescription")
 @Nullable
public RTCSessionDescription pendingRemoteDescription()
```
The read-only property RTCPeerConnection.pendingRemoteDescription returns an RTCSessionDescription object describing a pending configuration change for the remote end of the connection. This does not describe the connection as it currently stands, but as it may exist in the near future. Use RTCPeerConnection.currentRemoteDescription or RTCPeerConnection.remoteDescription to get the current session description for the remote endpoint. For details on the difference, see Pending and current descriptions in WebRTC connectivity.

See Also:

RTCPeerConnection.pendingRemoteDescription - MDN, RTCPeerConnection.pendingRemoteDescription - WebRTC 1.0: Real-time Communication Between Browsers

remoteDescription
```
@JsProperty(name="remoteDescription")
 @Nullable
public RTCSessionDescription remoteDescription()
```
The read-only property RTCPeerConnection.remoteDescription returns a RTCSessionDescription describing the session (which includes configuration and media information) for the remote end of the connection. If this hasn't been set yet, this is null.

See Also:

RTCPeerConnection.remoteDescription - MDN, RTCPeerConnection.remoteDescription - WebRTC 1.0: Real-time Communication Between Browsers

sctp
```
@JsProperty(name="sctp")
 @Nullable
public RTCSctpTransport sctp()
```
The read-only sctp property on the RTCPeerConnection interface returns an RTCSctpTransport describing the SCTP transport over which SCTP data is being sent and received. If SCTP hasn't been negotiated, this value is null.

See Also:

RTCPeerConnection.sctp - MDN, RTCPeerConnection.sctp - WebRTC 1.0: Real-time Communication Between Browsers

signalingState
```
@JsProperty(name="signalingState")
 @Nonnull
 @RTCSignalingState
public java.lang.String signalingState()
```
The read-only signalingState property on the RTCPeerConnection interface returns one of the string values specified by the RTCSignalingState enum; these values describe the state of the signaling process on the local end of the connection while connecting or reconnecting to another peer. See Signaling in Lifetime of a WebRTC session for more details about the signaling process.

See Also:

RTCPeerConnection.signalingState - MDN, RTCPeerConnection.signalingState - WebRTC 1.0: Real-time Communication Between Browsers

addIceCandidate
```
@Nonnull
public Promise<java.lang.Void> addIceCandidate(@Nonnull
                                                        RTCIceCandidateInit candidate)
```
When a web site or app using RTCPeerConnection receives a new ICE candidate from the remote peer over its signaling channel, it delivers the newly-received candidate to the browser's ICE agent by calling RTCPeerConnection.addIceCandidate().

See Also:

RTCPeerConnection.addIceCandidate - MDN, RTCPeerConnection.addIceCandidate() - WebRTC 1.0: Real-time Communication Between Browsers

addIceCandidate
```
@Nonnull
public Promise<java.lang.Void> addIceCandidate()
```
When a web site or app using RTCPeerConnection receives a new ICE candidate from the remote peer over its signaling channel, it delivers the newly-received candidate to the browser's ICE agent by calling RTCPeerConnection.addIceCandidate().

See Also:

RTCPeerConnection.addIceCandidate - MDN, RTCPeerConnection.addIceCandidate() - WebRTC 1.0: Real-time Communication Between Browsers

addIceCandidate

@Nonnull
public Promise<java.lang.Void> addIceCandidate(@Nonnull
                                                        RTCIceCandidateInit candidate,
                                                        @Nonnull
                                                        VoidFunction successCallback,
                                                        @Nonnull
                                                        RTCPeerConnectionErrorCallback failureCallback)

When a web site or app using RTCPeerConnection receives a new ICE candidate from the remote peer over its signaling channel, it delivers the newly-received candidate to the browser's ICE agent by calling RTCPeerConnection.addIceCandidate().

See Also:: RTCPeerConnection.addIceCandidate - MDN, RTCPeerConnection.addIceCandidate() - WebRTC 1.0: Real-time Communication Between Browsers

close
```
public void close()
```
The RTCPeerConnection.close() method closes the current peer connection.

See Also:

RTCPeerConnection.close - MDN, RTCPeerConnection.close() - WebRTC 1.0: Real-time Communication Between Browsers

createAnswer
```
@Nonnull
public Promise<RTCSessionDescriptionInit> createAnswer(@Nonnull
                                                                RTCAnswerOptions options)
```
The createAnswer() method on the RTCPeerConnection interface creates an SDP answer to an offer received from a remote peer during the offer/answer negotiation of a WebRTC connection. The answer contains information about any media already attached to the session, codecs and options supported by the browser, and any ICE candidates already gathered. The answer is delivered to the returned Promise, and should then be sent to the source of the offer to continue the negotiation process.

See Also:

RTCPeerConnection.createAnswer - MDN, createAnswer() - WebRTC 1.0: Real-time Communication Between Browsers

createAnswer
```
@Nonnull
public Promise<RTCSessionDescriptionInit> createAnswer()
```
The createAnswer() method on the RTCPeerConnection interface creates an SDP answer to an offer received from a remote peer during the offer/answer negotiation of a WebRTC connection. The answer contains information about any media already attached to the session, codecs and options supported by the browser, and any ICE candidates already gathered. The answer is delivered to the returned Promise, and should then be sent to the source of the offer to continue the negotiation process.

See Also:

RTCPeerConnection.createAnswer - MDN, createAnswer() - WebRTC 1.0: Real-time Communication Between Browsers

createAnswer
```
@Nonnull
public Promise<java.lang.Void> createAnswer(@Nonnull
                                                     RTCSessionDescriptionCallback successCallback,
                                                     @Nonnull
                                                     RTCPeerConnectionErrorCallback failureCallback)
```
The createAnswer() method on the RTCPeerConnection interface creates an SDP answer to an offer received from a remote peer during the offer/answer negotiation of a WebRTC connection. The answer contains information about any media already attached to the session, codecs and options supported by the browser, and any ICE candidates already gathered. The answer is delivered to the returned Promise, and should then be sent to the source of the offer to continue the negotiation process.

See Also:

RTCPeerConnection.createAnswer - MDN, createAnswer() - WebRTC 1.0: Real-time Communication Between Browsers

createOffer
```
@Nonnull
public Promise<RTCSessionDescriptionInit> createOffer(@Nonnull
                                                               RTCOfferOptions options)
```
The createOffer() method of the RTCPeerConnection interface initiates the creation of an SDP offer for the purpose of starting a new WebRTC connection to a remote peer.

See Also:

RTCPeerConnection.createOffer - MDN, createOffer() - WebRTC 1.0: Real-time Communication Between Browsers

createOffer
```
@Nonnull
public Promise<RTCSessionDescriptionInit> createOffer()
```
The createOffer() method of the RTCPeerConnection interface initiates the creation of an SDP offer for the purpose of starting a new WebRTC connection to a remote peer.

See Also:

RTCPeerConnection.createOffer - MDN, createOffer() - WebRTC 1.0: Real-time Communication Between Browsers

createOffer

@Nonnull
public Promise<java.lang.Void> createOffer(@Nonnull
                                                    RTCSessionDescriptionCallback successCallback,
                                                    @Nonnull
                                                    RTCPeerConnectionErrorCallback failureCallback,
                                                    @Nonnull
                                                    RTCOfferOptions options)

The createOffer() method of the RTCPeerConnection interface initiates the creation of an SDP offer for the purpose of starting a new WebRTC connection to a remote peer.

See Also:: RTCPeerConnection.createOffer - MDN, createOffer() - WebRTC 1.0: Real-time Communication Between Browsers

createOffer

@Nonnull
public Promise<java.lang.Void> createOffer(@Nonnull
                                                    RTCSessionDescriptionCallback successCallback,
                                                    @Nonnull
                                                    RTCPeerConnectionErrorCallback failureCallback)

The createOffer() method of the RTCPeerConnection interface initiates the creation of an SDP offer for the purpose of starting a new WebRTC connection to a remote peer.

See Also:: RTCPeerConnection.createOffer - MDN, createOffer() - WebRTC 1.0: Real-time Communication Between Browsers

getConfiguration
```
@Nonnull
public RTCConfiguration getConfiguration()
```
The RTCPeerConnection.getConfiguration() method returns an RTCConfiguration object which indicates the current configuration of the RTCPeerConnection on which the method is called.

See Also:

RTCPeerConnection.getConfiguration - MDN, getConfiguration() - WebRTC 1.0: Real-time Communication Between Browsers

restartIce
```
public void restartIce()
```
The WebRTC API's RTCPeerConnection interface offers the restartIce() method to allow a web application to easily request that ICE candidate gathering be redone on both ends of the connection.

See Also:

RTCPeerConnection.restartIce - MDN, RTCPeerConnection.restartIce() - WebRTC 1.0: Real-time Communication Between Browsers

setConfiguration
```
public void setConfiguration(@Nonnull
                             RTCConfiguration configuration)
```
The RTCPeerConnection.setConfiguration() method sets the current configuration of the RTCPeerConnection based on the values included in the specified RTCConfiguration object. This lets you change the ICE servers used by the connection and which transport policies to use.

See Also:

RTCPeerConnection.setConfiguration - MDN, setConfiguration() - WebRTC 1.0: Real-time Communication Between Browsers

setConfiguration
```
public void setConfiguration()
```
The RTCPeerConnection.setConfiguration() method sets the current configuration of the RTCPeerConnection based on the values included in the specified RTCConfiguration object. This lets you change the ICE servers used by the connection and which transport policies to use.

See Also:

RTCPeerConnection.setConfiguration - MDN, setConfiguration() - WebRTC 1.0: Real-time Communication Between Browsers

setLocalDescription
```
@Nonnull
public Promise<java.lang.Void> setLocalDescription(@Nonnull
                                                            RTCLocalSessionDescriptionInit description)
```
The RTCPeerConnection method setLocalDescription() changes the local description associated with the connection. This description specifies the properties of the local end of the connection, including the media format.

See Also:

RTCPeerConnection.setLocalDescription - MDN, RTCPeerConnection.setLocalDescription() - WebRTC 1.0: Real-time Communication Between Browsers

setLocalDescription
```
@Nonnull
public Promise<java.lang.Void> setLocalDescription()
```
The RTCPeerConnection method setLocalDescription() changes the local description associated with the connection. This description specifies the properties of the local end of the connection, including the media format.

See Also:

RTCPeerConnection.setLocalDescription - MDN, RTCPeerConnection.setLocalDescription() - WebRTC 1.0: Real-time Communication Between Browsers

setLocalDescription

@Nonnull
public Promise<java.lang.Void> setLocalDescription(@Nonnull
                                                            RTCLocalSessionDescriptionInit description,
                                                            @Nonnull
                                                            VoidFunction successCallback,
                                                            @Nonnull
                                                            RTCPeerConnectionErrorCallback failureCallback)

The RTCPeerConnection method setLocalDescription() changes the local description associated with the connection. This description specifies the properties of the local end of the connection, including the media format.

See Also:: RTCPeerConnection.setLocalDescription - MDN, RTCPeerConnection.setLocalDescription() - WebRTC 1.0: Real-time Communication Between Browsers

setRemoteDescription
```
@Nonnull
public Promise<java.lang.Void> setRemoteDescription(@Nonnull
                                                             RTCSessionDescriptionInit description)
```
The RTCPeerConnection method setRemoteDescription() sets the specified session description as the remote peer's current offer or answer. The description specifies the properties of the remote end of the connection, including the media format.

See Also:

RTCPeerConnection.setRemoteDescription - MDN, RTCPeerConnection.setRemoteDescription() - WebRTC 1.0: Real-time Communication Between Browsers

setRemoteDescription

@Nonnull
public Promise<java.lang.Void> setRemoteDescription(@Nonnull
                                                             RTCSessionDescriptionInit description,
                                                             @Nonnull
                                                             VoidFunction successCallback,
                                                             @Nonnull
                                                             RTCPeerConnectionErrorCallback failureCallback)

The RTCPeerConnection method setRemoteDescription() sets the specified session description as the remote peer's current offer or answer. The description specifies the properties of the remote end of the connection, including the media format.

See Also:: RTCPeerConnection.setRemoteDescription - MDN, RTCPeerConnection.setRemoteDescription() - WebRTC 1.0: Real-time Communication Between Browsers

generateCertificate
```
@Nonnull
public static Promise<RTCCertificate> generateCertificate(@Nonnull
                                                                   AlgorithmIdentifier keygenAlgorithm)
```
The static RTCPeerConnection.generateCertificate() function creates an X.509 certificate and corresponding private key, returning a promise that resolves with the new RTCCertificate once it's generated.

See Also:

RTCPeerConnection.generateCertificate - MDN, RTCPeerConnection.generateCertificate() - WebRTC 1.0: Real-time Communication Between Browsers

generateCertificate
```
@Nonnull
public static Promise<RTCCertificate> generateCertificate(@Nonnull
                                                                   JsObject keygenAlgorithm)
```
The static RTCPeerConnection.generateCertificate() function creates an X.509 certificate and corresponding private key, returning a promise that resolves with the new RTCCertificate once it's generated.

See Also:

RTCPeerConnection.generateCertificate - MDN, RTCPeerConnection.generateCertificate() - WebRTC 1.0: Real-time Communication Between Browsers

generateCertificate
```
@Nonnull
public static Promise<RTCCertificate> generateCertificate(@Nonnull
                                                                   java.lang.String keygenAlgorithm)
```
The static RTCPeerConnection.generateCertificate() function creates an X.509 certificate and corresponding private key, returning a promise that resolves with the new RTCCertificate once it's generated.

See Also:

RTCPeerConnection.generateCertificate - MDN, RTCPeerConnection.generateCertificate() - WebRTC 1.0: Real-time Communication Between Browsers

addTrack

@Nonnull
public RTCRtpSender addTrack(@Nonnull
                                      MediaStreamTrack track,
                                      @Nonnull
                                      MediaStream... streams)

The RTCPeerConnection method addTrack() adds a new media track to the set of tracks which will be transmitted to the other peer.

See Also:: RTCPeerConnection.addTrack - MDN, RTCPeerConnection.addTrack() - WebRTC 1.0: Real-time Communication Between Browsers

addTransceiver

@Nonnull
public RTCRtpTransceiver addTransceiver(@Nonnull
                                                 MediaStreamTrack trackOrKind,
                                                 @Nonnull
                                                 RTCRtpTransceiverInit init)

addTransceiver

@Nonnull
public RTCRtpTransceiver addTransceiver(@Nonnull
                                                 java.lang.String trackOrKind,
                                                 @Nonnull
                                                 RTCRtpTransceiverInit init)

addTransceiver

@Nonnull
public RTCRtpTransceiver addTransceiver(@Nonnull
                                                 MediaStreamTrack trackOrKind)

addTransceiver

@Nonnull
public RTCRtpTransceiver addTransceiver(@Nonnull
                                                 java.lang.String trackOrKind)

getReceivers
```
@Nonnull
public JsArray<RTCRtpReceiver> getReceivers()
```
The RTCPeerConnection.getReceivers() method returns an array of RTCRtpReceiver objects, each of which represents one RTP receiver. Each RTP receiver manages the reception and decoding of data for a MediaStreamTrack on an RTCPeerConnection

See Also:

RTCPeerConnection.getReceivers - MDN, RTCPeerConnection.getReceivers() - WebRTC 1.0: Real-time Communication Between Browsers

getSenders
```
@Nonnull
public JsArray<RTCRtpSender> getSenders()
```
The RTCPeerConnection method getSenders() returns an array of RTCRtpSender objects, each of which represents the RTP sender responsible for transmitting one track's data.

See Also:

RTCPeerConnection.getSenders - MDN, RTCPeerConnection.getSenders() - WebRTC 1.0: Real-time Communication Between Browsers

getTransceivers
```
@Nonnull
public JsArray<RTCRtpTransceiver> getTransceivers()
```
The RTCPeerConnection interface's getTransceivers() method returns a list of the RTCRtpTransceiver objects being used to send and receive data on the connection.

See Also:

RTCPeerConnection.getTransceivers - MDN, RTCPeerConnection.getTransceivers() - WebRTC 1.0: Real-time Communication Between Browsers

removeTrack
```
public void removeTrack(@Nonnull
                        RTCRtpSender sender)
```
The RTCPeerConnection.removeTrack() method tells the local end of the connection to stop sending media from the specified track, without actually removing the corresponding RTCRtpSender from the list of senders as reported by RTCPeerConnection.getSenders().

See Also:

RTCPeerConnection.removeTrack - MDN, RTCPeerConnection.removeTrack() - WebRTC 1.0: Real-time Communication Between Browsers

createDataChannel

@Nonnull
public RTCDataChannel createDataChannel(@Nonnull
                                                 java.lang.String label,
                                                 @Nonnull
                                                 RTCDataChannelInit dataChannelDict)

The createDataChannel() method on the RTCPeerConnection interface creates a new channel linked with the remote peer, over which any kind of data may be transmitted.

See Also:: RTCPeerConnection.createDataChannel - MDN, createDataChannel() - WebRTC 1.0: Real-time Communication Between Browsers

createDataChannel
```
@Nonnull
public RTCDataChannel createDataChannel(@Nonnull
                                                 java.lang.String label)
```
The createDataChannel() method on the RTCPeerConnection interface creates a new channel linked with the remote peer, over which any kind of data may be transmitted.

See Also:

RTCPeerConnection.createDataChannel - MDN, createDataChannel() - WebRTC 1.0: Real-time Communication Between Browsers

getStats
```
@Nonnull
public Promise<RTCStatsReport> getStats(@Nullable
                                                 MediaStreamTrack selector)
```
The RTCPeerConnection method getStats() returns a promise which resolves with data providing statistics about either the overall connection or about the specified MediaStreamTrack.

See Also:

RTCPeerConnection.getStats - MDN, RTCPeerConnection.getStats() - WebRTC 1.0: Real-time Communication Between Browsers

getStats
```
@Nonnull
public Promise<RTCStatsReport> getStats()
```
The RTCPeerConnection method getStats() returns a promise which resolves with data providing statistics about either the overall connection or about the specified MediaStreamTrack.

See Also:

RTCPeerConnection.getStats - MDN, RTCPeerConnection.getStats() - WebRTC 1.0: Real-time Communication Between Browsers

getIdentityAssertion
```
@Nonnull
public Promise<java.lang.String> getIdentityAssertion()
```
The RTCPeerConnection.getIdentityAssertion() method initiates the gathering of an identity assertion. This has an effect only if the signalingState is not "closed".

See Also:

RTCPeerConnection.getIdentityAssertion - MDN, RTCPeerConnection.getIdentityAssertion() - Identity for WebRTC

setIdentityProvider
```
public void setIdentityProvider(@Nonnull
                                java.lang.String provider,
                                @Nonnull
                                RTCIdentityProviderOptions options)
```
The RTCPeerConnection.setIdentityProvider() method sets the Identity Provider (IdP) to the triplet given in parameter: its name, the protocol used to communicate with it (optional) and an optional username. The IdP will be used only when an assertion is needed.

See Also:

RTCPeerConnection.setIdentityProvider - MDN, RTCPeerConnection.setIdentityProvider() - Identity for WebRTC

setIdentityProvider
```
public void setIdentityProvider(@Nonnull
                                java.lang.String provider)
```
The RTCPeerConnection.setIdentityProvider() method sets the Identity Provider (IdP) to the triplet given in parameter: its name, the protocol used to communicate with it (optional) and an optional username. The IdP will be used only when an assertion is needed.

See Also:

RTCPeerConnection.setIdentityProvider - MDN, RTCPeerConnection.setIdentityProvider() - Identity for WebRTC

addDatachannelListener

@JsOverlay
public final void addDatachannelListener(@Nonnull
                                                    RTCDataChannelEventListener callback,
                                                    @Nonnull
                                                    AddEventListenerOptions options)

addDatachannelListener

@JsOverlay
public final void addDatachannelListener(@Nonnull
                                                    RTCDataChannelEventListener callback,
                                                    boolean useCapture)

addDatachannelListener

@JsOverlay
public final void addDatachannelListener(@Nonnull
                                                    RTCDataChannelEventListener callback)

removeDatachannelListener

@JsOverlay
public final void removeDatachannelListener(@Nonnull
                                                       RTCDataChannelEventListener callback,
                                                       @Nonnull
                                                       EventListenerOptions options)

removeDatachannelListener

@JsOverlay
public final void removeDatachannelListener(@Nonnull
                                                       RTCDataChannelEventListener callback,
                                                       boolean useCapture)

removeDatachannelListener

@JsOverlay
public final void removeDatachannelListener(@Nonnull
                                                       RTCDataChannelEventListener callback)

addIcecandidateListener

@JsOverlay
public final void addIcecandidateListener(@Nonnull
                                                     RTCPeerConnectionIceEventListener callback,
                                                     @Nonnull
                                                     AddEventListenerOptions options)

addIcecandidateListener

@JsOverlay
public final void addIcecandidateListener(@Nonnull
                                                     RTCPeerConnectionIceEventListener callback,
                                                     boolean useCapture)

addIcecandidateListener

@JsOverlay
public final void addIcecandidateListener(@Nonnull
                                                     RTCPeerConnectionIceEventListener callback)

removeIcecandidateListener

@JsOverlay
public final void removeIcecandidateListener(@Nonnull
                                                        RTCPeerConnectionIceEventListener callback,
                                                        @Nonnull
                                                        EventListenerOptions options)

removeIcecandidateListener

@JsOverlay
public final void removeIcecandidateListener(@Nonnull
                                                        RTCPeerConnectionIceEventListener callback,
                                                        boolean useCapture)

removeIcecandidateListener

@JsOverlay
public final void removeIcecandidateListener(@Nonnull
                                                        RTCPeerConnectionIceEventListener callback)

addIcecandidateerrorListener

@JsOverlay
public final void addIcecandidateerrorListener(@Nonnull
                                                          RTCPeerConnectionIceErrorEventListener callback,
                                                          @Nonnull
                                                          AddEventListenerOptions options)

addIcecandidateerrorListener

@JsOverlay
public final void addIcecandidateerrorListener(@Nonnull
                                                          RTCPeerConnectionIceErrorEventListener callback,
                                                          boolean useCapture)

addIcecandidateerrorListener

@JsOverlay
public final void addIcecandidateerrorListener(@Nonnull
                                                          RTCPeerConnectionIceErrorEventListener callback)

removeIcecandidateerrorListener

@JsOverlay
public final void removeIcecandidateerrorListener(@Nonnull
                                                             RTCPeerConnectionIceErrorEventListener callback,
                                                             @Nonnull
                                                             EventListenerOptions options)

removeIcecandidateerrorListener

@JsOverlay
public final void removeIcecandidateerrorListener(@Nonnull
                                                             RTCPeerConnectionIceErrorEventListener callback,
                                                             boolean useCapture)

removeIcecandidateerrorListener

@JsOverlay
public final void removeIcecandidateerrorListener(@Nonnull
                                                             RTCPeerConnectionIceErrorEventListener callback)

addTrackListener

@JsOverlay
public final void addTrackListener(@Nonnull
                                              RTCTrackEventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addTrackListener

@JsOverlay
public final void addTrackListener(@Nonnull
                                              RTCTrackEventListener callback,
                                              boolean useCapture)

addTrackListener

@JsOverlay
public final void addTrackListener(@Nonnull
                                              RTCTrackEventListener callback)

removeTrackListener

@JsOverlay
public final void removeTrackListener(@Nonnull
                                                 RTCTrackEventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeTrackListener

@JsOverlay
public final void removeTrackListener(@Nonnull
                                                 RTCTrackEventListener callback,
                                                 boolean useCapture)

removeTrackListener

@JsOverlay
public final void removeTrackListener(@Nonnull
                                                 RTCTrackEventListener callback)

addConnectionstatechangeListener

@JsOverlay
public final void addConnectionstatechangeListener(@Nonnull
                                                              EventListener callback,
                                                              @Nonnull
                                                              AddEventListenerOptions options)

addConnectionstatechangeListener

@JsOverlay
public final void addConnectionstatechangeListener(@Nonnull
                                                              EventListener callback,
                                                              boolean useCapture)

addConnectionstatechangeListener

@JsOverlay
public final void addConnectionstatechangeListener(@Nonnull
                                                              EventListener callback)

removeConnectionstatechangeListener

@JsOverlay
public final void removeConnectionstatechangeListener(@Nonnull
                                                                 EventListener callback,
                                                                 @Nonnull
                                                                 EventListenerOptions options)

removeConnectionstatechangeListener

@JsOverlay
public final void removeConnectionstatechangeListener(@Nonnull
                                                                 EventListener callback,
                                                                 boolean useCapture)

removeConnectionstatechangeListener

@JsOverlay
public final void removeConnectionstatechangeListener(@Nonnull
                                                                 EventListener callback)

addIceconnectionstatechangeListener

@JsOverlay
public final void addIceconnectionstatechangeListener(@Nonnull
                                                                 EventListener callback,
                                                                 @Nonnull
                                                                 AddEventListenerOptions options)

addIceconnectionstatechangeListener

@JsOverlay
public final void addIceconnectionstatechangeListener(@Nonnull
                                                                 EventListener callback,
                                                                 boolean useCapture)

addIceconnectionstatechangeListener

@JsOverlay
public final void addIceconnectionstatechangeListener(@Nonnull
                                                                 EventListener callback)

removeIceconnectionstatechangeListener

@JsOverlay
public final void removeIceconnectionstatechangeListener(@Nonnull
                                                                    EventListener callback,
                                                                    @Nonnull
                                                                    EventListenerOptions options)

removeIceconnectionstatechangeListener

@JsOverlay
public final void removeIceconnectionstatechangeListener(@Nonnull
                                                                    EventListener callback,
                                                                    boolean useCapture)

removeIceconnectionstatechangeListener

@JsOverlay
public final void removeIceconnectionstatechangeListener(@Nonnull
                                                                    EventListener callback)

addIcegatheringstatechangeListener

@JsOverlay
public final void addIcegatheringstatechangeListener(@Nonnull
                                                                EventListener callback,
                                                                @Nonnull
                                                                AddEventListenerOptions options)

addIcegatheringstatechangeListener

@JsOverlay
public final void addIcegatheringstatechangeListener(@Nonnull
                                                                EventListener callback,
                                                                boolean useCapture)

addIcegatheringstatechangeListener

@JsOverlay
public final void addIcegatheringstatechangeListener(@Nonnull
                                                                EventListener callback)

removeIcegatheringstatechangeListener

@JsOverlay
public final void removeIcegatheringstatechangeListener(@Nonnull
                                                                   EventListener callback,
                                                                   @Nonnull
                                                                   EventListenerOptions options)

removeIcegatheringstatechangeListener

@JsOverlay
public final void removeIcegatheringstatechangeListener(@Nonnull
                                                                   EventListener callback,
                                                                   boolean useCapture)

removeIcegatheringstatechangeListener

@JsOverlay
public final void removeIcegatheringstatechangeListener(@Nonnull
                                                                   EventListener callback)

addNegotiationneededListener

@JsOverlay
public final void addNegotiationneededListener(@Nonnull
                                                          EventListener callback,
                                                          @Nonnull
                                                          AddEventListenerOptions options)

addNegotiationneededListener

@JsOverlay
public final void addNegotiationneededListener(@Nonnull
                                                          EventListener callback,
                                                          boolean useCapture)

addNegotiationneededListener

@JsOverlay
public final void addNegotiationneededListener(@Nonnull
                                                          EventListener callback)

removeNegotiationneededListener

@JsOverlay
public final void removeNegotiationneededListener(@Nonnull
                                                             EventListener callback,
                                                             @Nonnull
                                                             EventListenerOptions options)

removeNegotiationneededListener

@JsOverlay
public final void removeNegotiationneededListener(@Nonnull
                                                             EventListener callback,
                                                             boolean useCapture)

removeNegotiationneededListener

@JsOverlay
public final void removeNegotiationneededListener(@Nonnull
                                                             EventListener callback)

addPeeridentityListener

@JsOverlay
public final void addPeeridentityListener(@Nonnull
                                                     EventListener callback,
                                                     @Nonnull
                                                     AddEventListenerOptions options)

addPeeridentityListener

@JsOverlay
public final void addPeeridentityListener(@Nonnull
                                                     EventListener callback,
                                                     boolean useCapture)

addPeeridentityListener

@JsOverlay
public final void addPeeridentityListener(@Nonnull
                                                     EventListener callback)

removePeeridentityListener

@JsOverlay
public final void removePeeridentityListener(@Nonnull
                                                        EventListener callback,
                                                        @Nonnull
                                                        EventListenerOptions options)

removePeeridentityListener

@JsOverlay
public final void removePeeridentityListener(@Nonnull
                                                        EventListener callback,
                                                        boolean useCapture)

removePeeridentityListener

@JsOverlay
public final void removePeeridentityListener(@Nonnull
                                                        EventListener callback)

addSignalingstatechangeListener

@JsOverlay
public final void addSignalingstatechangeListener(@Nonnull
                                                             EventListener callback,
                                                             @Nonnull
                                                             AddEventListenerOptions options)

addSignalingstatechangeListener

@JsOverlay
public final void addSignalingstatechangeListener(@Nonnull
                                                             EventListener callback,
                                                             boolean useCapture)

addSignalingstatechangeListener

@JsOverlay
public final void addSignalingstatechangeListener(@Nonnull
                                                             EventListener callback)

removeSignalingstatechangeListener

@JsOverlay
public final void removeSignalingstatechangeListener(@Nonnull
                                                                EventListener callback,
                                                                @Nonnull
                                                                EventListenerOptions options)

removeSignalingstatechangeListener

@JsOverlay
public final void removeSignalingstatechangeListener(@Nonnull
                                                                EventListener callback,
                                                                boolean useCapture)

removeSignalingstatechangeListener

@JsOverlay
public final void removeSignalingstatechangeListener(@Nonnull
                                                                EventListener callback)

Class RTCPeerConnection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class akasha.EventTarget

Methods inherited from class akasha.core.JsObject

Methods inherited from class java.lang.Object

Field Detail

onconnectionstatechange

ondatachannel

onicecandidate

onicecandidateerror

oniceconnectionstatechange

onicegatheringstatechange

onnegotiationneeded

onsignalingstatechange

ontrack

Constructor Detail

RTCPeerConnection

RTCPeerConnection

Method Detail

canTrickleIceCandidates

connectionState

currentLocalDescription

currentRemoteDescription

iceConnectionState

iceGatheringState

idpErrorInfo

idpLoginUrl

localDescription

peerIdentity

pendingLocalDescription

pendingRemoteDescription

remoteDescription

sctp

signalingState

addIceCandidate

addIceCandidate

addIceCandidate

close

createAnswer

createAnswer

createAnswer

createOffer

createOffer

createOffer

createOffer

getConfiguration

restartIce

setConfiguration

setConfiguration

setLocalDescription

setLocalDescription

setLocalDescription

setRemoteDescription

setRemoteDescription

generateCertificate

generateCertificate

generateCertificate

addTrack

addTransceiver

addTransceiver

addTransceiver

addTransceiver

getReceivers

getSenders

getTransceivers

removeTrack

createDataChannel

createDataChannel

getStats

getStats

getIdentityAssertion

setIdentityProvider

setIdentityProvider

addDatachannelListener

addDatachannelListener

addDatachannelListener

removeDatachannelListener

removeDatachannelListener