The RTCPeerConnection interface represents a WebRTC connection the local computer and a remote peer. It provides methods to to a remote peer, maintain and monitor the connection, and close connection once it's no longer needed.
The RTCPeerConnection interface represents a WebRTC connection the local computer and a remote peer. It provides methods to to a remote peer, maintain and monitor the connection, and close connection once it's no longer needed.
(add-ice-candidate this & args)
Method.
When a web site or app using rtc.RTCPeerConnection
receives
new ICE candidate from the remote peer over its signaling channel,
delivers the newly-received candidate to the browser's ICE agent
calling RTCPeerConnection.addIceCandidate().
`aPromise = pc.addIceCandidate(candidate);
addIceCandidate(candidate, successCallback, failureCallback);`
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/addIceCandidate
Method. When a web site or app using `rtc.RTCPeerConnection` receives new ICE candidate from the remote peer over its signaling channel, delivers the newly-received candidate to the browser's ICE agent calling RTCPeerConnection.addIceCandidate(). `aPromise = pc.addIceCandidate(candidate); addIceCandidate(candidate, successCallback, failureCallback);` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/addIceCandidate`
(add-stream this media-stream)
Method.
The obsolete rtc.RTCPeerConnection
method addStream() adds
media.MediaStream
as a local source of audio or video. Instead
using this obsolete method, you should instead use web.addTrack()
for each track you wish to send to the remote peer.
rtcPeerConnection.addStream(mediaStream);
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/addStream
Method. The obsolete `rtc.RTCPeerConnection` method addStream() adds `media.MediaStream` as a local source of audio or video. Instead using this obsolete method, you should instead use `web.addTrack()` for each track you wish to send to the remote peer. `rtcPeerConnection.addStream(mediaStream);` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/addStream`
(add-track this & args)
Method.
The rtc.RTCPeerConnection
method addTrack() adds a new media
to the set of tracks which will be transmitted to the other peer.
rtpSender = rtcPeerConnection.addTrack(track, stream...);
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/addTrack
Method. The `rtc.RTCPeerConnection` method addTrack() adds a new media to the set of tracks which will be transmitted to the other peer. `rtpSender = rtcPeerConnection.addTrack(track, stream...);` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/addTrack`
(can-trickle-ice-candidates this)
Property.
The read-only rtc.RTCPeerConnection
property canTrickleIceCandidates
a web.Boolean
which indicates whether or not the remote peer
accept trickled ICE candidates.
var canTrickle = RTCPeerConnection.canTrickleIceCandidates;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/canTrickleIceCandidates
Property. The read-only `rtc.RTCPeerConnection` property canTrickleIceCandidates a `web.Boolean` which indicates whether or not the remote peer accept trickled ICE candidates. `var canTrickle = RTCPeerConnection.canTrickleIceCandidates;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/canTrickleIceCandidates`
(close this & args)
Method.
The RTCPeerConnection.close() method closes the current peer
`peerConnection.close();
This method has no parameters, and returns nothing.
Calling this method terminates the RTCPeerConnection's ICE agent, ending any ongoing ICE processing and any active streams. This also releases any resources in use by the ICE agent, including TURN permissions. All rtc.RTCRtpSender
objects are considered to be stopped once this returns (they may still be in the process of stopping, but for all intents and purposes, they're stopped).
Once this method returns, the signaling state as returned by rtc.RTCPeerConnection.signalingState
is closed.
Make sure that you delete all references to the previous rtc.RTCPeerConnection
before attempting to create a new one that connects to the same remote peer, as not doing so might result in some errors depending on the browser.`
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/close
Method. The RTCPeerConnection.close() method closes the current peer `peerConnection.close(); This method has no parameters, and returns nothing. Calling this method terminates the RTCPeerConnection's ICE agent, ending any ongoing ICE processing and any active streams. This also releases any resources in use by the ICE agent, including TURN permissions. All `rtc.RTCRtpSender` objects are considered to be stopped once this returns (they may still be in the process of stopping, but for all intents and purposes, they're stopped). Once this method returns, the signaling state as returned by `rtc.RTCPeerConnection.signalingState` is closed. Make sure that you delete all references to the previous `rtc.RTCPeerConnection` before attempting to create a new one that connects to the same remote peer, as not doing so might result in some errors depending on the browser.` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/close`
(connection-state this)
Property.
The read-only connectionState property of the rtc.RTCPeerConnection
indicates the current state of the peer connection by returning
of the string values specified by the enum RTCPeerConnectionState.
var connectionState = RTCPeerConnection.connectionState;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/connectionState
Property. The read-only connectionState property of the `rtc.RTCPeerConnection` indicates the current state of the peer connection by returning of the string values specified by the enum RTCPeerConnectionState. `var connectionState = RTCPeerConnection.connectionState;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/connectionState`
Constructor.
The RTCPeerConnection() constructor returns a newly-created rtc.RTCPeerConnection
, which represents a connection between the local device and a remote peer.
configuration Optional An RTCConfiguration dictionary providing options to configure the new connection.
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/RTCPeerConnection
Constructor. The RTCPeerConnection() constructor returns a newly-created `rtc.RTCPeerConnection`, which represents a connection between the local device and a remote peer. configuration Optional An RTCConfiguration dictionary providing options to configure the new connection. See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/RTCPeerConnection`
(create-answer this & args)
Method.
The createAnswer() method on the rtc.RTCPeerConnection
interface
an SDP answer to an offer received from a remote peer during
offer/answer negotiation of a WebRTC connection. The answer contains
about any media already attached to the session, codecs and options
by the browser, and any ICE candidates already gathered. The
is delivered to the returned web.Promise
, and should then be
to the source of the offer to continue the negotiation process.
`aPromise = RTCPeerConnection.createAnswer([options]);
RTCPeerConnection.createAnswer(successCallback, failureCallback[, options]);`
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/createAnswer
Method. The createAnswer() method on the `rtc.RTCPeerConnection` interface an SDP answer to an offer received from a remote peer during offer/answer negotiation of a WebRTC connection. The answer contains about any media already attached to the session, codecs and options by the browser, and any ICE candidates already gathered. The is delivered to the returned `web.Promise`, and should then be to the source of the offer to continue the negotiation process. `aPromise = RTCPeerConnection.createAnswer([options]); RTCPeerConnection.createAnswer(successCallback, failureCallback[, options]);` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/createAnswer`
(create-data-channel this & args)
Method.
The createDataChannel() method on the rtc.RTCPeerConnection
creates a new channel linked with the remote peer, over which
kind of data may be transmitted.
dataChannel = RTCPeerConnection.createDataChannel(label[, options]);
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/createDataChannel
Method. The createDataChannel() method on the `rtc.RTCPeerConnection` creates a new channel linked with the remote peer, over which kind of data may be transmitted. `dataChannel = RTCPeerConnection.createDataChannel(label[, options]);` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/createDataChannel`
(create-offer this & args)
Method.
The createOffer() method of the rtc.RTCPeerConnection
interface
the creation of an SDP offer for the purpose of starting a new
connection to a remote peer.
`aPromise = myPeerConnection.createOffer([options]);
myPeerConnection.createOffer(successCallback, failureCallback, [options])`
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/createOffer
Method. The createOffer() method of the `rtc.RTCPeerConnection` interface the creation of an SDP offer for the purpose of starting a new connection to a remote peer. `aPromise = myPeerConnection.createOffer([options]); myPeerConnection.createOffer(successCallback, failureCallback, [options])` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/createOffer`
(current-local-description this)
Property.
The read-only property RTCPeerConnection.currentLocalDescription
an rtc.RTCSessionDescription
object describing the local end
the connection as it was most recently successfully negotiated
the last time the rtc.RTCPeerConnection
finished negotiating
connecting to a remote peer. Also included is a list of any ICE
that may already have been generated by the ICE agent since the
or answer represented by the description was first instantiated.
sessionDescription = RTCPeerConnection.currentLocalDescription;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/currentLocalDescription
Property. The read-only property RTCPeerConnection.currentLocalDescription an `rtc.RTCSessionDescription` object describing the local end the connection as it was most recently successfully negotiated the last time the `rtc.RTCPeerConnection` finished negotiating connecting to a remote peer. Also included is a list of any ICE that may already have been generated by the ICE agent since the or answer represented by the description was first instantiated. `sessionDescription = RTCPeerConnection.currentLocalDescription;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/currentLocalDescription`
(current-remote-description this)
Property.
The read-only property RTCPeerConnection.currentRemoteDescription
an rtc.RTCSessionDescription
object describing the remote end
the connection as it was most recently successfully negotiated
the last time the rtc.RTCPeerConnection
finished negotiating
connecting to a remote peer. Also included is a list of any ICE
that may already have been generated by the ICE agent since the
or answer represented by the description was first instantiated.
sessionDescription = RTCPeerConnection.currentRemoteDescription;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/currentRemoteDescription
Property. The read-only property RTCPeerConnection.currentRemoteDescription an `rtc.RTCSessionDescription` object describing the remote end the connection as it was most recently successfully negotiated the last time the `rtc.RTCPeerConnection` finished negotiating connecting to a remote peer. Also included is a list of any ICE that may already have been generated by the ICE agent since the or answer represented by the description was first instantiated. `sessionDescription = RTCPeerConnection.currentRemoteDescription;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/currentRemoteDescription`
(default-ice-servers this)
Property.
The read-only property RTCPeerConnection.defaultIceServers returns
array of objects based on the rtc.RTCIceServer
dictionary,
indicates what, if any, ICE servers the browser will use by default
none are provided to the rtc.RTCPeerConnection
in its rtc.RTCConfiguration
.
browsers are not required to provide any default ICE servers
all.
var defaultIceServers = RTCPeerConnection.defaultIceServers;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/defaultIceServers
Property. The read-only property RTCPeerConnection.defaultIceServers returns array of objects based on the `rtc.RTCIceServer` dictionary, indicates what, if any, ICE servers the browser will use by default none are provided to the `rtc.RTCPeerConnection` in its `rtc.RTCConfiguration`. browsers are not required to provide any default ICE servers all. `var defaultIceServers = RTCPeerConnection.defaultIceServers;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/defaultIceServers`
(generate-certificate this keygen-algorithm)
Method.
The generateCertificate() method of the rtc.RTCPeerConnection
creates and stores an X.509 certificate and corresponding private
then returns an rtc.RTCCertificate
, providing access to it.
var cert = RTCPeerConnection.generateCertificate(keygenAlgorithm)
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/generateCertificate
Method. The generateCertificate() method of the `rtc.RTCPeerConnection` creates and stores an X.509 certificate and corresponding private then returns an `rtc.RTCCertificate`, providing access to it. `var cert = RTCPeerConnection.generateCertificate(keygenAlgorithm)` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/generateCertificate`
(get-configuration this)
Method.
The RTCPeerConnection.getConfiguration() method returns an rtc.RTCConfiguration
which indicates the current configuration of the rtc.RTCPeerConnection
which the method is called.
var configuration = RTCPeerConnection.getConfiguration();
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getConfiguration
Method. The RTCPeerConnection.getConfiguration() method returns an `rtc.RTCConfiguration` which indicates the current configuration of the `rtc.RTCPeerConnection` which the method is called. `var configuration = RTCPeerConnection.getConfiguration();` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getConfiguration`
(get-identity-assertion this & args)
Method.
The RTCPeerConnection.getIdentityAssertion() method initiates
gathering of an identity assertion. This has an effect only if
web.signalingState
is not "closed".
`pc.getIdentityAssertion();
There is neither parameter nor return value for this method.`
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getIdentityAssertion
Method. The RTCPeerConnection.getIdentityAssertion() method initiates gathering of an identity assertion. This has an effect only if `web.signalingState` is not \"closed\". `pc.getIdentityAssertion(); There is neither parameter nor return value for this method.` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getIdentityAssertion`
(get-local-streams this & args)
Method.
The RTCPeerConnection.getLocalStreams() method returns an array MediaStream associated with the local end of the connection. array may be empty.
`var mediaStreams[] = pc.getLocalStreams();
The return value is an web.Array
of media.MediaStream
objects.`
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getLocalStreams
Method. The RTCPeerConnection.getLocalStreams() method returns an array MediaStream associated with the local end of the connection. array may be empty. `var mediaStreams[] = pc.getLocalStreams(); The return value is an `web.Array` of `media.MediaStream` objects.` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getLocalStreams`
(get-receivers this)
Method.
The RTCPeerConnection.getReceivers() method returns an array
rtc.RTCRtpReceiver
objects, each of which represents one RTP
Each RTP receiver manages the reception and decoding of data
a media.MediaStreamTrack
on an rtc.RTCPeerConnection
var receivers[] = RTCPeerConnection.getReceivers();
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getReceivers
Method. The RTCPeerConnection.getReceivers() method returns an array `rtc.RTCRtpReceiver` objects, each of which represents one RTP Each RTP receiver manages the reception and decoding of data a `media.MediaStreamTrack` on an `rtc.RTCPeerConnection` `var receivers[] = RTCPeerConnection.getReceivers();` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getReceivers`
(get-remote-streams this & args)
Method.
The RTCPeerConnection.getRemoteStreams() method returns an array MediaStream associated with the remote end of the connection. array may be empty.
`var mediaStreams[] = pc.getRemoteStreams();
The return value is an web.Array
of media.MediaStream
objects.`
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getRemoteStreams
Method. The RTCPeerConnection.getRemoteStreams() method returns an array MediaStream associated with the remote end of the connection. array may be empty. `var mediaStreams[] = pc.getRemoteStreams(); The return value is an `web.Array` of `media.MediaStream` objects.` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getRemoteStreams`
(get-senders this)
Method.
The rtc.RTCPeerConnection
method getSenders() returns an array
rtc.RTCRtpSender
objects, each of which represents the RTP
responsible for transmitting one track's data.
var senders = RTCPeerConnection.getSenders();
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getSenders
Method. The `rtc.RTCPeerConnection` method getSenders() returns an array `rtc.RTCRtpSender` objects, each of which represents the RTP responsible for transmitting one track's data. `var senders = RTCPeerConnection.getSenders();` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getSenders`
(get-stats this selector)
Method.
The rtc.RTCPeerConnection
method getStats() returns a promise
resolves with data providing statistics about either the overall
or about the specified media.MediaStreamTrack
.
promise = rtcPeerConnection.getStats(selector)
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getStats
Method. The `rtc.RTCPeerConnection` method getStats() returns a promise resolves with data providing statistics about either the overall or about the specified `media.MediaStreamTrack`. `promise = rtcPeerConnection.getStats(selector)` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getStats`
(get-stream-by-id this id)
Method.
The RTCPeerConnection.getStreamById() method returns the MediaStream the given id that is associated with local or remote end of the If no stream matches, it returns null.
var mediaStream = pc.getStream(id);
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getStreamById
Method. The RTCPeerConnection.getStreamById() method returns the MediaStream the given id that is associated with local or remote end of the If no stream matches, it returns null. `var mediaStream = pc.getStream(id);` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getStreamById`
(get-transceivers this)
Method.
The rtc.RTCPeerConnection
interface's getTransceivers() method
a list of the rtc.RTCRtpTransceiver
objects being used to send
receive data on the connection.
transceiverList = rtcPeerConnection.getTransceivers();
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getTransceivers
Method. The `rtc.RTCPeerConnection` interface's getTransceivers() method a list of the `rtc.RTCRtpTransceiver` objects being used to send receive data on the connection. `transceiverList = rtcPeerConnection.getTransceivers();` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getTransceivers`
(ice-connection-state this)
Property.
The read-only property RTCPeerConnection.iceConnectionState returns
enum of type RTCIceConnectionState which state of the ICE agent
with the rtc.RTCPeerConnection
.
var state = RTCPeerConnection.iceConnectionState;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/iceConnectionState
Property. The read-only property RTCPeerConnection.iceConnectionState returns enum of type RTCIceConnectionState which state of the ICE agent with the `rtc.RTCPeerConnection`. `var state = RTCPeerConnection.iceConnectionState;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/iceConnectionState`
(ice-gathering-state this)
Property.
The read-only property RTCPeerConnection.iceGatheringState returns enum of type RTCIceGatheringState that describes connection's gathering state. This lets you detect, for example, when collection ICE candidates has finished.
var state = RTCPeerConnection.iceGatheringState;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/iceGatheringState
Property. The read-only property RTCPeerConnection.iceGatheringState returns enum of type RTCIceGatheringState that describes connection's gathering state. This lets you detect, for example, when collection ICE candidates has finished. `var state = RTCPeerConnection.iceGatheringState;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/iceGatheringState`
(local-description this)
Property.
The read-only property RTCPeerConnection.localDescription returns
rtc.RTCSessionDescription
describing the session for the local
of the connection. If it has not yet been set, this is null.
`var sessionDescription = peerConnection.localDescription;
On a more fundamental level, the returned value is the value of rtc.RTCPeerConnection.pendingLocalDescription
if that property isn't null; otherwise, the value of rtc.RTCPeerConnection.currentLocalDescription
is returned. See Pending and current descriptions in WebRTC connectivity for details on this algorithm and why it's used.`
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/localDescription
Property. The read-only property RTCPeerConnection.localDescription returns `rtc.RTCSessionDescription` describing the session for the local of the connection. If it has not yet been set, this is null. `var sessionDescription = peerConnection.localDescription; On a more fundamental level, the returned value is the value of `rtc.RTCPeerConnection.pendingLocalDescription` if that property isn't null; otherwise, the value of `rtc.RTCPeerConnection.currentLocalDescription` is returned. See Pending and current descriptions in WebRTC connectivity for details on this algorithm and why it's used.` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/localDescription`
(onaddstream this)
Property.
The RTCPeerConnection.onaddstream event handler is a property
the code to execute when the addstream event, of type media.MediaStreamEvent
,
received by this rtc.RTCPeerConnection
. Such an event is sent
a media.MediaStream
is added to this connection by the remote
The event is sent immediately after the call web.setRemoteDescription()
doesn't wait for the result of the SDP negotiation.
rtcPeerConnection.onaddstream = eventHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onaddstream
Property. The RTCPeerConnection.onaddstream event handler is a property the code to execute when the addstream event, of type `media.MediaStreamEvent`, received by this `rtc.RTCPeerConnection`. Such an event is sent a `media.MediaStream` is added to this connection by the remote The event is sent immediately after the call `web.setRemoteDescription()` doesn't wait for the result of the SDP negotiation. `rtcPeerConnection.onaddstream = eventHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onaddstream`
(onconnectionstatechange this)
Property.
The RTCPeerConnection.onconnectionstatechange property specifies
web.EventHandler
which is called to handle the connectionstatechange
when it occurs on an instance of rtc.RTCPeerConnection
. This
whenever the aggregate state of the connection changes.
RTCPeerConnection.onconnectionstatechange = eventHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onconnectionstatechange
Property. The RTCPeerConnection.onconnectionstatechange property specifies `web.EventHandler` which is called to handle the connectionstatechange when it occurs on an instance of `rtc.RTCPeerConnection`. This whenever the aggregate state of the connection changes. `RTCPeerConnection.onconnectionstatechange = eventHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onconnectionstatechange`
(ondatachannel this)
Property.
The RTCPeerConnection.ondatachannel property is an web.EventHandler
specifies a function which is called when the datachannel event
on an rtc.RTCPeerConnection
. This event, of type rtc.RTCDataChannelEvent
,
sent when an rtc.RTCDataChannel
is added to the connection
the remote peer calling web.createDataChannel()
.
RTCPeerConnection.ondatachannel = function;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/ondatachannel
Property. The RTCPeerConnection.ondatachannel property is an `web.EventHandler` specifies a function which is called when the datachannel event on an `rtc.RTCPeerConnection`. This event, of type `rtc.RTCDataChannelEvent`, sent when an `rtc.RTCDataChannel` is added to the connection the remote peer calling `web.createDataChannel()`. `RTCPeerConnection.ondatachannel = function;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/ondatachannel`
(onicecandidate this)
Property.
The RTCPeerConnection property web.onicecandidate
property
an web.EventHandler
which specifies a function to be called
the icecandidate event occurs on an rtc.RTCPeerConnection
instance.
happens whenever the local ICE agent needs to deliver a message
the other peer through the signaling server.
rtcPeerConnection.onicecandidate = eventHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onicecandidate
Property. The RTCPeerConnection property `web.onicecandidate` property an `web.EventHandler` which specifies a function to be called the icecandidate event occurs on an `rtc.RTCPeerConnection` instance. happens whenever the local ICE agent needs to deliver a message the other peer through the signaling server. `rtcPeerConnection.onicecandidate = eventHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onicecandidate`
(oniceconnectionstatechange this)
Property.
The RTCPeerConnection.oniceconnectionstatechange property is
event handler which specifies a function to be called when the
event is fired on an rtc.RTCPeerConnection
instance. This happens
the state of the connection's ICE agent, as represented by the
property, changes.
RTCPeerConnection.oniceconnectionstatechange = eventHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/oniceconnectionstatechange
Property. The RTCPeerConnection.oniceconnectionstatechange property is event handler which specifies a function to be called when the event is fired on an `rtc.RTCPeerConnection` instance. This happens the state of the connection's ICE agent, as represented by the property, changes. `RTCPeerConnection.oniceconnectionstatechange = eventHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/oniceconnectionstatechange`
(onicegatheringstatechange this)
Property.
The RTCPeerConnection.onicegatheringstatechange property is an
which specifies a function to be called when the icegatheringstatechange
is sent to an rtc.RTCPeerConnection
instance. This happens
the ICE gathering state—that is, whether or not the ICE agent
actively gathering candidates—changes.
RTCPeerConnection.onicegatheringstatechange = eventHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onicegatheringstatechange
Property. The RTCPeerConnection.onicegatheringstatechange property is an which specifies a function to be called when the icegatheringstatechange is sent to an `rtc.RTCPeerConnection` instance. This happens the ICE gathering state—that is, whether or not the ICE agent actively gathering candidates—changes. `RTCPeerConnection.onicegatheringstatechange = eventHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onicegatheringstatechange`
(onidentityresult this)
Property.
The RTCPeerConnection.onidentityresult event handler is a property
the code to execute when the identityresult event, of type rtc.RTCIdentityEvent
,
received by this rtc.RTCPeerConnection
. Such an event is sent
an identity assertion is generated, via web.getIdentityAssertion()
during the creation of an offer or an answer.
peerconnection.onidentityresult = function;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onidentityresult
Property. The RTCPeerConnection.onidentityresult event handler is a property the code to execute when the identityresult event, of type `rtc.RTCIdentityEvent`, received by this `rtc.RTCPeerConnection`. Such an event is sent an identity assertion is generated, via `web.getIdentityAssertion()` during the creation of an offer or an answer. `peerconnection.onidentityresult = function;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onidentityresult`
(onidpassertionerror this)
Property.
The RTCPeerConnection.onidpassertionerror event handler is a
containing the code to execute whent the idpassertionerror event,
type rtc.RTCIdentityErrorEvent
, is received by this rtc.RTCPeerConnection
.
an event is sent when the associated identity provider (IdP)
an error while generating an identity assertion.
peerconnection.onidpassertionerror = function;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onidpassertionerror
Property. The RTCPeerConnection.onidpassertionerror event handler is a containing the code to execute whent the idpassertionerror event, type `rtc.RTCIdentityErrorEvent`, is received by this `rtc.RTCPeerConnection`. an event is sent when the associated identity provider (IdP) an error while generating an identity assertion. `peerconnection.onidpassertionerror = function;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onidpassertionerror`
(onidpvalidationerror this)
Property.
The RTCPeerConnection.onidpvalidationerror event handler is a
containing the code to execute whent the idpvalidationerror event,
type rtc.RTCIdentityErrorEvent
, is received by this rtc.RTCPeerConnection
.
an event is sent when the associated identity provider (IdP)
an error while validating an identity assertion.
peerconnection.onidpvalidationerror = function;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onidpvalidationerror
Property. The RTCPeerConnection.onidpvalidationerror event handler is a containing the code to execute whent the idpvalidationerror event, type `rtc.RTCIdentityErrorEvent`, is received by this `rtc.RTCPeerConnection`. an event is sent when the associated identity provider (IdP) an error while validating an identity assertion. `peerconnection.onidpvalidationerror = function;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onidpvalidationerror`
(onnegotiationneeded this)
Property.
The rtc.RTCPeerConnection
interface's onnegotiationneeded property
an web.EventListener
which specifies a function which is called
handle the negotiationneeded event when it occurs on an rtc.RTCPeerConnection
This event is fired when a change has occurred which requires
negotiation. This negotiation should be carried out as the offerer,
some session changes cannot be negotiated as the answerer.
RTCPeerConnection.onnegotiationneeded = eventHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onnegotiationneeded
Property. The `rtc.RTCPeerConnection` interface's onnegotiationneeded property an `web.EventListener` which specifies a function which is called handle the negotiationneeded event when it occurs on an `rtc.RTCPeerConnection` This event is fired when a change has occurred which requires negotiation. This negotiation should be carried out as the offerer, some session changes cannot be negotiated as the answerer. `RTCPeerConnection.onnegotiationneeded = eventHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onnegotiationneeded`
(onpeeridentity this)
Property.
The RTCPeerConnection.onpeeridentity event handler is a property
the code to execute whent the peeridentity event, of type web.Event
,
received by this rtc.RTCPeerConnection
. Such an event is sent
an identity assertion, received from a peer, has been successfully
peerconnection.onpeeridentity = function;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onpeeridentity
Property. The RTCPeerConnection.onpeeridentity event handler is a property the code to execute whent the peeridentity event, of type `web.Event`, received by this `rtc.RTCPeerConnection`. Such an event is sent an identity assertion, received from a peer, has been successfully `peerconnection.onpeeridentity = function;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onpeeridentity`
(onremovestream this)
Property.
The RTCPeerConnection.onremovestream event handler is a property
the code to execute when the removestream event, of type media.MediaStreamEvent
,
received by this rtc.RTCPeerConnection
. Such an event is sent
a media.MediaStream
is removed from this connection.
peerconnection.onremovestream = function;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onremovestream
Property. The RTCPeerConnection.onremovestream event handler is a property the code to execute when the removestream event, of type `media.MediaStreamEvent`, received by this `rtc.RTCPeerConnection`. Such an event is sent a `media.MediaStream` is removed from this connection. `peerconnection.onremovestream = function;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onremovestream`
(onsignalingstatechange this)
Property.
The onsignalingstatechange property of the rtc.RTCPeerConnection
is an web.EventHandler
which specifies a function to be called
the signalingstatechange event occurs on an rtc.RTCPeerConnection
RTCPeerConnection.onsignalingstatechange = errorHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onsignalingstatechange
Property. The onsignalingstatechange property of the `rtc.RTCPeerConnection` is an `web.EventHandler` which specifies a function to be called the signalingstatechange event occurs on an `rtc.RTCPeerConnection` `RTCPeerConnection.onsignalingstatechange = errorHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onsignalingstatechange`
(ontrack this)
Property.
The rtc.RTCPeerConnection
property ontrack is an web.EventHandler
specifies a function to be called when the track event occurs,
that a track has been added to the rtc.RTCPeerConnection
.
RTCPeerConnection.ontrack = eventHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/ontrack
Property. The `rtc.RTCPeerConnection` property ontrack is an `web.EventHandler` specifies a function to be called when the track event occurs, that a track has been added to the `rtc.RTCPeerConnection`. `RTCPeerConnection.ontrack = eventHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/ontrack`
(peer-identity this)
Property.
The read-only rtc.RTCPeerConnection
property peerIdentity returns
JavaScript web.Promise
that resolves to an rtc.RTCIdentityAssertion
contains a dom.DOMString
identifying the remote peer.
var identity = rtcPeerConnection.peerIdentity;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/peerIdentity
Property. The read-only `rtc.RTCPeerConnection` property peerIdentity returns JavaScript `web.Promise` that resolves to an `rtc.RTCIdentityAssertion` contains a `dom.DOMString` identifying the remote peer. `var identity = rtcPeerConnection.peerIdentity;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/peerIdentity`
(pending-local-description this)
Property.
The read-only property RTCPeerConnection.pendingLocalDescription
an rtc.RTCSessionDescription
object describing a pending configuration
for the local end of the connection. This does not describe the
as it currently stands, but as it may exist in the near future.
rtc.RTCPeerConnection.currentLocalDescription
or rtc.RTCPeerConnection.localDescription
get the current state of the endpoint. For details on the difference,
Pending and current descriptions in WebRTC connectivity.
sessionDescription = RTCPeerConnection.pendingLocalDescription;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/pendingLocalDescription
Property. The read-only property RTCPeerConnection.pendingLocalDescription an `rtc.RTCSessionDescription` object describing a pending configuration for the local end of the connection. This does not describe the as it currently stands, but as it may exist in the near future. `rtc.RTCPeerConnection.currentLocalDescription` or `rtc.RTCPeerConnection.localDescription` get the current state of the endpoint. For details on the difference, Pending and current descriptions in WebRTC connectivity. `sessionDescription = RTCPeerConnection.pendingLocalDescription;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/pendingLocalDescription`
(pending-remote-description this)
Property.
The read-only property RTCPeerConnection.pendingRemoteDescription
an rtc.RTCSessionDescription
object describing a pending configuration
for the remote end of the connection. This does not describe
connection as it currently stands, but as it may exist in the
future. Use rtc.RTCPeerConnection.currentRemoteDescription
rtc.RTCPeerConnection.remoteDescription
to get the current
description for the remote endpoint. For details on the difference,
Pending and current descriptions in WebRTC connectivity.
sessionDescription = RTCPeerConnection.pendingRemoteDescription;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/pendingRemoteDescription
Property. The read-only property RTCPeerConnection.pendingRemoteDescription an `rtc.RTCSessionDescription` object describing a pending configuration for the remote end of the connection. This does not describe connection as it currently stands, but as it may exist in the future. Use `rtc.RTCPeerConnection.currentRemoteDescription` `rtc.RTCPeerConnection.remoteDescription` to get the current description for the remote endpoint. For details on the difference, Pending and current descriptions in WebRTC connectivity. `sessionDescription = RTCPeerConnection.pendingRemoteDescription;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/pendingRemoteDescription`
(remote-description this)
Property.
The read-only property RTCPeerConnection.remoteDescription returns
rtc.RTCSessionDescription
describing the session (which includes
and media information) for the remote end of the connection.
this hasn't been set yet, this is null.
`var sessionDescription = peerConnection.remoteDescription;
On a more fundamental level, the returned value is the value of rtc.RTCPeerConnection.pendingRemoteDescription
if that property isn't null; otherwise, the value of rtc.RTCPeerConnection.currentRemoteDescription
is returned. See Pending and current descriptions in WebRTC connectivity for details on this algorithm and why it's used.`
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/remoteDescription
Property. The read-only property RTCPeerConnection.remoteDescription returns `rtc.RTCSessionDescription` describing the session (which includes and media information) for the remote end of the connection. this hasn't been set yet, this is null. `var sessionDescription = peerConnection.remoteDescription; On a more fundamental level, the returned value is the value of `rtc.RTCPeerConnection.pendingRemoteDescription` if that property isn't null; otherwise, the value of `rtc.RTCPeerConnection.currentRemoteDescription` is returned. See Pending and current descriptions in WebRTC connectivity for details on this algorithm and why it's used.` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/remoteDescription`
(remove-stream this media-stream)
Method.
The RTCPeerConnection.removeStream() method removes a media.MediaStream
a local source of audio or video. If the negotiation already
a new one will be needed for the remote peer to be able to use
Because this method has been deprecated, you should instead use
if your target browser versions have implemented it.
RTCPeerConnection.removeStream(mediaStream);
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/removeStream
Method. The RTCPeerConnection.removeStream() method removes a `media.MediaStream` a local source of audio or video. If the negotiation already a new one will be needed for the remote peer to be able to use Because this method has been deprecated, you should instead use if your target browser versions have implemented it. `RTCPeerConnection.removeStream(mediaStream);` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/removeStream`
(remove-track this sender)
Method.
The RTCPeerConnection.removeTrack() method tells the local end
the connection to stop sending media from the specified track,
actually removing the corresponding rtc.RTCRtpSender
from the
of senders as reported by rtc.RTCPeerConnection.getSenders()
.
pc.removeTrack(sender);
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/removeTrack
Method. The RTCPeerConnection.removeTrack() method tells the local end the connection to stop sending media from the specified track, actually removing the corresponding `rtc.RTCRtpSender` from the of senders as reported by `rtc.RTCPeerConnection.getSenders()`. `pc.removeTrack(sender);` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/removeTrack`
(restart-ice this)
Method.
The WebRTC API's rtc.RTCPeerConnection
interface offers the
method to allow a web application to easily request that ICE
gathering be redone on both ends of the connection.
rtcPeerConnection.restartIce();
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/restartIce
Method. The WebRTC API's `rtc.RTCPeerConnection` interface offers the method to allow a web application to easily request that ICE gathering be redone on both ends of the connection. `rtcPeerConnection.restartIce();` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/restartIce`
(sctp this)
Property.
The read-only sctp property on the rtc.RTCPeerConnection
interface
an rtc.RTCSctpTransport
describing the SCTP transport over
SCTP data is being sent and received. If SCTP hasn't been negotiated,
value is null.
var sctp = RTCPeerConnection.sctp;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/sctp
Property. The read-only sctp property on the `rtc.RTCPeerConnection` interface an `rtc.RTCSctpTransport` describing the SCTP transport over SCTP data is being sent and received. If SCTP hasn't been negotiated, value is null. `var sctp = RTCPeerConnection.sctp;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/sctp`
(set-can-trickle-ice-candidates! this val)
Property.
The read-only rtc.RTCPeerConnection
property canTrickleIceCandidates
a web.Boolean
which indicates whether or not the remote peer
accept trickled ICE candidates.
var canTrickle = RTCPeerConnection.canTrickleIceCandidates;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/canTrickleIceCandidates
Property. The read-only `rtc.RTCPeerConnection` property canTrickleIceCandidates a `web.Boolean` which indicates whether or not the remote peer accept trickled ICE candidates. `var canTrickle = RTCPeerConnection.canTrickleIceCandidates;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/canTrickleIceCandidates`
(set-configuration this configuration)
Method.
The RTCPeerConnection.setConfiguration() method sets the current
of the rtc.RTCPeerConnection
based on the values included in
specified rtc.RTCConfiguration
object. This lets you change
ICE servers used by the connection and which transport policies
use.
RTCPeerConnection.setConfiguration(configuration);
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/setConfiguration
Method. The RTCPeerConnection.setConfiguration() method sets the current of the `rtc.RTCPeerConnection` based on the values included in specified `rtc.RTCConfiguration` object. This lets you change ICE servers used by the connection and which transport policies use. `RTCPeerConnection.setConfiguration(configuration);` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/setConfiguration`
(set-connection-state! this val)
Property.
The read-only connectionState property of the rtc.RTCPeerConnection
indicates the current state of the peer connection by returning
of the string values specified by the enum RTCPeerConnectionState.
var connectionState = RTCPeerConnection.connectionState;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/connectionState
Property. The read-only connectionState property of the `rtc.RTCPeerConnection` indicates the current state of the peer connection by returning of the string values specified by the enum RTCPeerConnectionState. `var connectionState = RTCPeerConnection.connectionState;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/connectionState`
(set-default-ice-servers! this val)
Property.
The read-only property RTCPeerConnection.defaultIceServers returns
array of objects based on the rtc.RTCIceServer
dictionary,
indicates what, if any, ICE servers the browser will use by default
none are provided to the rtc.RTCPeerConnection
in its rtc.RTCConfiguration
.
browsers are not required to provide any default ICE servers
all.
var defaultIceServers = RTCPeerConnection.defaultIceServers;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/defaultIceServers
Property. The read-only property RTCPeerConnection.defaultIceServers returns array of objects based on the `rtc.RTCIceServer` dictionary, indicates what, if any, ICE servers the browser will use by default none are provided to the `rtc.RTCPeerConnection` in its `rtc.RTCConfiguration`. browsers are not required to provide any default ICE servers all. `var defaultIceServers = RTCPeerConnection.defaultIceServers;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/defaultIceServers`
(set-identity-provider this & args)
Method.
The RTCPeerConnection.setIdentityProvider() method sets the Identity (IdP) to the triplet given in parameter: its name, the protocol to communicate with it (optional) and an optional username. The will be used only when an assertion is needed.
`pc.setIdentityProvider(domainname [, protocol] [, username]);
There is no return value for this method.`
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/setIdentityProvider
Method. The RTCPeerConnection.setIdentityProvider() method sets the Identity (IdP) to the triplet given in parameter: its name, the protocol to communicate with it (optional) and an optional username. The will be used only when an assertion is needed. `pc.setIdentityProvider(domainname [, protocol] [, username]); There is no return value for this method.` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/setIdentityProvider`
(set-local-description this & args)
Method.
The RTCPeerConnection.setLocalDescription() method changes the description associated with the connection. This description the properties of the local end of the connection, including media format.
`aPromise = RTCPeerConnection.setLocalDescription(sessionDescription);
pc.setLocalDescription(sessionDescription, successCallback, errorCallback);`
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/setLocalDescription
Method. The RTCPeerConnection.setLocalDescription() method changes the description associated with the connection. This description the properties of the local end of the connection, including media format. `aPromise = RTCPeerConnection.setLocalDescription(sessionDescription); pc.setLocalDescription(sessionDescription, successCallback, errorCallback);` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/setLocalDescription`
(set-onaddstream! this val)
Property.
The RTCPeerConnection.onaddstream event handler is a property
the code to execute when the addstream event, of type media.MediaStreamEvent
,
received by this rtc.RTCPeerConnection
. Such an event is sent
a media.MediaStream
is added to this connection by the remote
The event is sent immediately after the call web.setRemoteDescription()
doesn't wait for the result of the SDP negotiation.
rtcPeerConnection.onaddstream = eventHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onaddstream
Property. The RTCPeerConnection.onaddstream event handler is a property the code to execute when the addstream event, of type `media.MediaStreamEvent`, received by this `rtc.RTCPeerConnection`. Such an event is sent a `media.MediaStream` is added to this connection by the remote The event is sent immediately after the call `web.setRemoteDescription()` doesn't wait for the result of the SDP negotiation. `rtcPeerConnection.onaddstream = eventHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onaddstream`
(set-onconnectionstatechange! this val)
Property.
The RTCPeerConnection.onconnectionstatechange property specifies
web.EventHandler
which is called to handle the connectionstatechange
when it occurs on an instance of rtc.RTCPeerConnection
. This
whenever the aggregate state of the connection changes.
RTCPeerConnection.onconnectionstatechange = eventHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onconnectionstatechange
Property. The RTCPeerConnection.onconnectionstatechange property specifies `web.EventHandler` which is called to handle the connectionstatechange when it occurs on an instance of `rtc.RTCPeerConnection`. This whenever the aggregate state of the connection changes. `RTCPeerConnection.onconnectionstatechange = eventHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onconnectionstatechange`
(set-ondatachannel! this val)
Property.
The RTCPeerConnection.ondatachannel property is an web.EventHandler
specifies a function which is called when the datachannel event
on an rtc.RTCPeerConnection
. This event, of type rtc.RTCDataChannelEvent
,
sent when an rtc.RTCDataChannel
is added to the connection
the remote peer calling web.createDataChannel()
.
RTCPeerConnection.ondatachannel = function;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/ondatachannel
Property. The RTCPeerConnection.ondatachannel property is an `web.EventHandler` specifies a function which is called when the datachannel event on an `rtc.RTCPeerConnection`. This event, of type `rtc.RTCDataChannelEvent`, sent when an `rtc.RTCDataChannel` is added to the connection the remote peer calling `web.createDataChannel()`. `RTCPeerConnection.ondatachannel = function;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/ondatachannel`
(set-onicecandidate! this val)
Property.
The RTCPeerConnection property web.onicecandidate
property
an web.EventHandler
which specifies a function to be called
the icecandidate event occurs on an rtc.RTCPeerConnection
instance.
happens whenever the local ICE agent needs to deliver a message
the other peer through the signaling server.
rtcPeerConnection.onicecandidate = eventHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onicecandidate
Property. The RTCPeerConnection property `web.onicecandidate` property an `web.EventHandler` which specifies a function to be called the icecandidate event occurs on an `rtc.RTCPeerConnection` instance. happens whenever the local ICE agent needs to deliver a message the other peer through the signaling server. `rtcPeerConnection.onicecandidate = eventHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onicecandidate`
(set-oniceconnectionstatechange! this val)
Property.
The RTCPeerConnection.oniceconnectionstatechange property is
event handler which specifies a function to be called when the
event is fired on an rtc.RTCPeerConnection
instance. This happens
the state of the connection's ICE agent, as represented by the
property, changes.
RTCPeerConnection.oniceconnectionstatechange = eventHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/oniceconnectionstatechange
Property. The RTCPeerConnection.oniceconnectionstatechange property is event handler which specifies a function to be called when the event is fired on an `rtc.RTCPeerConnection` instance. This happens the state of the connection's ICE agent, as represented by the property, changes. `RTCPeerConnection.oniceconnectionstatechange = eventHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/oniceconnectionstatechange`
(set-onicegatheringstatechange! this val)
Property.
The RTCPeerConnection.onicegatheringstatechange property is an
which specifies a function to be called when the icegatheringstatechange
is sent to an rtc.RTCPeerConnection
instance. This happens
the ICE gathering state—that is, whether or not the ICE agent
actively gathering candidates—changes.
RTCPeerConnection.onicegatheringstatechange = eventHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onicegatheringstatechange
Property. The RTCPeerConnection.onicegatheringstatechange property is an which specifies a function to be called when the icegatheringstatechange is sent to an `rtc.RTCPeerConnection` instance. This happens the ICE gathering state—that is, whether or not the ICE agent actively gathering candidates—changes. `RTCPeerConnection.onicegatheringstatechange = eventHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onicegatheringstatechange`
(set-onidentityresult! this val)
Property.
The RTCPeerConnection.onidentityresult event handler is a property
the code to execute when the identityresult event, of type rtc.RTCIdentityEvent
,
received by this rtc.RTCPeerConnection
. Such an event is sent
an identity assertion is generated, via web.getIdentityAssertion()
during the creation of an offer or an answer.
peerconnection.onidentityresult = function;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onidentityresult
Property. The RTCPeerConnection.onidentityresult event handler is a property the code to execute when the identityresult event, of type `rtc.RTCIdentityEvent`, received by this `rtc.RTCPeerConnection`. Such an event is sent an identity assertion is generated, via `web.getIdentityAssertion()` during the creation of an offer or an answer. `peerconnection.onidentityresult = function;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onidentityresult`
(set-onidpassertionerror! this val)
Property.
The RTCPeerConnection.onidpassertionerror event handler is a
containing the code to execute whent the idpassertionerror event,
type rtc.RTCIdentityErrorEvent
, is received by this rtc.RTCPeerConnection
.
an event is sent when the associated identity provider (IdP)
an error while generating an identity assertion.
peerconnection.onidpassertionerror = function;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onidpassertionerror
Property. The RTCPeerConnection.onidpassertionerror event handler is a containing the code to execute whent the idpassertionerror event, type `rtc.RTCIdentityErrorEvent`, is received by this `rtc.RTCPeerConnection`. an event is sent when the associated identity provider (IdP) an error while generating an identity assertion. `peerconnection.onidpassertionerror = function;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onidpassertionerror`
(set-onidpvalidationerror! this val)
Property.
The RTCPeerConnection.onidpvalidationerror event handler is a
containing the code to execute whent the idpvalidationerror event,
type rtc.RTCIdentityErrorEvent
, is received by this rtc.RTCPeerConnection
.
an event is sent when the associated identity provider (IdP)
an error while validating an identity assertion.
peerconnection.onidpvalidationerror = function;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onidpvalidationerror
Property. The RTCPeerConnection.onidpvalidationerror event handler is a containing the code to execute whent the idpvalidationerror event, type `rtc.RTCIdentityErrorEvent`, is received by this `rtc.RTCPeerConnection`. an event is sent when the associated identity provider (IdP) an error while validating an identity assertion. `peerconnection.onidpvalidationerror = function;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onidpvalidationerror`
(set-onnegotiationneeded! this val)
Property.
The rtc.RTCPeerConnection
interface's onnegotiationneeded property
an web.EventListener
which specifies a function which is called
handle the negotiationneeded event when it occurs on an rtc.RTCPeerConnection
This event is fired when a change has occurred which requires
negotiation. This negotiation should be carried out as the offerer,
some session changes cannot be negotiated as the answerer.
RTCPeerConnection.onnegotiationneeded = eventHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onnegotiationneeded
Property. The `rtc.RTCPeerConnection` interface's onnegotiationneeded property an `web.EventListener` which specifies a function which is called handle the negotiationneeded event when it occurs on an `rtc.RTCPeerConnection` This event is fired when a change has occurred which requires negotiation. This negotiation should be carried out as the offerer, some session changes cannot be negotiated as the answerer. `RTCPeerConnection.onnegotiationneeded = eventHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onnegotiationneeded`
(set-onpeeridentity! this val)
Property.
The RTCPeerConnection.onpeeridentity event handler is a property
the code to execute whent the peeridentity event, of type web.Event
,
received by this rtc.RTCPeerConnection
. Such an event is sent
an identity assertion, received from a peer, has been successfully
peerconnection.onpeeridentity = function;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onpeeridentity
Property. The RTCPeerConnection.onpeeridentity event handler is a property the code to execute whent the peeridentity event, of type `web.Event`, received by this `rtc.RTCPeerConnection`. Such an event is sent an identity assertion, received from a peer, has been successfully `peerconnection.onpeeridentity = function;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onpeeridentity`
(set-onremovestream! this val)
Property.
The RTCPeerConnection.onremovestream event handler is a property
the code to execute when the removestream event, of type media.MediaStreamEvent
,
received by this rtc.RTCPeerConnection
. Such an event is sent
a media.MediaStream
is removed from this connection.
peerconnection.onremovestream = function;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onremovestream
Property. The RTCPeerConnection.onremovestream event handler is a property the code to execute when the removestream event, of type `media.MediaStreamEvent`, received by this `rtc.RTCPeerConnection`. Such an event is sent a `media.MediaStream` is removed from this connection. `peerconnection.onremovestream = function;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onremovestream`
(set-onsignalingstatechange! this val)
Property.
The onsignalingstatechange property of the rtc.RTCPeerConnection
is an web.EventHandler
which specifies a function to be called
the signalingstatechange event occurs on an rtc.RTCPeerConnection
RTCPeerConnection.onsignalingstatechange = errorHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onsignalingstatechange
Property. The onsignalingstatechange property of the `rtc.RTCPeerConnection` is an `web.EventHandler` which specifies a function to be called the signalingstatechange event occurs on an `rtc.RTCPeerConnection` `RTCPeerConnection.onsignalingstatechange = errorHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/onsignalingstatechange`
(set-ontrack! this val)
Property.
The rtc.RTCPeerConnection
property ontrack is an web.EventHandler
specifies a function to be called when the track event occurs,
that a track has been added to the rtc.RTCPeerConnection
.
RTCPeerConnection.ontrack = eventHandler;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/ontrack
Property. The `rtc.RTCPeerConnection` property ontrack is an `web.EventHandler` specifies a function to be called when the track event occurs, that a track has been added to the `rtc.RTCPeerConnection`. `RTCPeerConnection.ontrack = eventHandler;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/ontrack`
(set-remote-description this session-description)
Method.
The RTCPeerConnection.setRemoteDescription() method changes the description associated with the connection. This description the properties of the remote end of the connection, including media format.
aPromise = pc.setRemoteDescription(sessionDescription);
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/setRemoteDescription
Method. The RTCPeerConnection.setRemoteDescription() method changes the description associated with the connection. This description the properties of the remote end of the connection, including media format. `aPromise = pc.setRemoteDescription(sessionDescription);` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/setRemoteDescription`
(set-sctp! this val)
Property.
The read-only sctp property on the rtc.RTCPeerConnection
interface
an rtc.RTCSctpTransport
describing the SCTP transport over
SCTP data is being sent and received. If SCTP hasn't been negotiated,
value is null.
var sctp = RTCPeerConnection.sctp;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/sctp
Property. The read-only sctp property on the `rtc.RTCPeerConnection` interface an `rtc.RTCSctpTransport` describing the SCTP transport over SCTP data is being sent and received. If SCTP hasn't been negotiated, value is null. `var sctp = RTCPeerConnection.sctp;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/sctp`
(signaling-state this)
Property.
The read-only signalingState property on the rtc.RTCPeerConnection
returns one of the string values specified by the RTCSignalingState
these values describe the state of the signaling process on the
end of the connection while connecting or reconnecting to another
See Signaling in Lifetime of a WebRTC session for more details
the signaling process.
var state = RTCPeerConnection.signalingState;
See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/signalingState
Property. The read-only signalingState property on the `rtc.RTCPeerConnection` returns one of the string values specified by the RTCSignalingState these values describe the state of the signaling process on the end of the connection while connecting or reconnecting to another See Signaling in Lifetime of a WebRTC session for more details the signaling process. `var state = RTCPeerConnection.signalingState;` See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/signalingState`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close