WebRTC

Module: w3c.WebRTC Support: Experimental

Enum RTCIceCredentialType

ValueDescription
password
token

Dictionary RTCIceServer

4 members: 4 undocumented

Properties

⚪ urls
→ (string or sequence)
⚪ username
→ string
⚪ credential
→ string
⚪ credentialType
→ RTCIceCredentialType

---

Enum RTCIceTransportPolicy

ValueDescription
relay
all

Enum RTCBundlePolicy

ValueDescription
balanced
max-compat
max-bundle

Dictionary RTCConfiguration

6 members: 6 undocumented

Properties

⚪ iceServers
→ sequence
⚪ iceTransportPolicy
→ RTCIceTransportPolicy
⚪ bundlePolicy
→ RTCBundlePolicy
⚪ peerIdentity
→ string?
⚪ certificates
→ sequence
⚪ iceCandidatePoolSize
→ u8

---

Dictionary RTCOfferAnswerOptions

---

Dictionary RTCAnswerOptions

Extends: RTCOfferAnswerOptions

---

Dictionary RTCOfferOptions

Extends: RTCOfferAnswerOptions

3 members: 3 undocumented

Properties

⚪ offerToReceiveVideo
→ boolean
⚪ offerToReceiveAudio
→ boolean
⚪ iceRestart
→ boolean

---

Enum RTCSdpType

ValueDescription
offer
pranswer
answer
rollback

Dictionary RTCSessionDescriptionInit

2 members: 2 undocumented

Properties

⚪ type
→ RTCSdpType
⚪ sdp
→ string

---

Dictionary RTCLocalSessionDescriptionInit

2 members: 2 undocumented

Properties

⚪ type
→ RTCSdpType
⚪ sdp
→ string

---

Interface RTCSessionDescription

Docs: w3c Docs

4 members: 4 undocumented

Constructors

⚪ constructor(descriptionInitDict)
RTCSessionDescriptionInit

Methods

⚪ toJSON()
→ object

Properties

⚪ type
→ RTCSdpType
⚪ sdp
→ string

---

Dictionary RTCIceCandidateInit

4 members: 4 undocumented

Properties

⚪ candidate
→ string
⚪ sdpMid
→ string?
⚪ sdpMLineIndex
→ u16?
⚪ usernameFragment
→ string?

---

Enum RTCIceCandidateType

ValueDescription
host
srflx
prflx
relay

Enum RTCIceProtocol

ValueDescription
udp
tcp

Enum RTCIceTcpCandidateType

ValueDescription
active
passive
so

Enum RTCIceComponent

ValueDescription
rtp
rtcp

Interface RTCIceCandidate

Docs: w3c Docs

16 members: 16 undocumented

Constructors

⚪ constructor(candidateInitDict)
RTCIceCandidateInit

Methods

⚪ toJSON()
→ object

Properties

⚪ candidate
→ string
⚪ sdpMid
→ string?
⚪ sdpMLineIndex
→ u16?
⚪ foundation
→ string?
⚪ component
→ RTCIceComponent?
⚪ priority
→ u32?
⚪ address
→ string?
⚪ protocol
→ RTCIceProtocol?
⚪ port
→ u16?
⚪ type
→ RTCIceCandidateType?
⚪ tcpType
→ RTCIceTcpCandidateType?
⚪ relatedAddress
→ string?
⚪ relatedPort
→ u16?
⚪ usernameFragment
→ string?

---

Dictionary RTCCertificateExpiration

1 members: 1 undocumented

Properties

⚪ expires
→ u64

---

Dictionary RTCDtlsFingerprint

2 members: 2 undocumented

Properties

⚪ algorithm
→ string
⚪ value
→ string

---

Interface RTCCertificate

2 members: 2 undocumented

Methods

⚪ getFingerprints()
→ sequence

Properties

⚪ expires
→ EpochTimeStamp

---

Enum RTCSignalingState

ValueDescription
stable
have-local-offer
have-remote-offer
have-local-pranswer
have-remote-pranswer
closed

Enum RTCIceGatheringState

ValueDescription
new
gathering
complete

Enum RTCIceConnectionState

ValueDescription
new
checking
connected
completed
failed
disconnected
closed

Enum RTCPeerConnectionState

ValueDescription
closed
failed
disconnected
new
connecting
connected

Interface RTCPeerConnection

Extends: w3c.EventTarget Docs: w3c Docs

32 members: 32 undocumented

Constructors

⚪ constructor(configuration)
RTCConfiguration

Static Methods

⚪ generateCertificate(keygenAlgorithm)
→ Promise

Methods

⚪ createOffer(options)
→ Promise
⚪ createAnswer(options)
→ Promise
⚪ setLocalDescription(description)
→ Promise
⚪ setRemoteDescription(description)
→ Promise
⚪ addIceCandidate(candidate)
→ Promise
⚪ getConfiguration()
→ RTCConfiguration
⚪ setConfiguration(configuration)
RTCConfiguration
⚪ restartIce()
Not documented
⚪ close()
Not documented
⚪ createDataChannel(label, dataChannelDict)
→ RTCDataChannel
⚪ getStats(selector)
→ Promise

Properties

⚪ localDescription
→ RTCSessionDescription?
⚪ currentLocalDescription
→ RTCSessionDescription?
⚪ pendingLocalDescription
→ RTCSessionDescription?
⚪ remoteDescription
→ RTCSessionDescription?
⚪ currentRemoteDescription
→ RTCSessionDescription?
⚪ pendingRemoteDescription
→ RTCSessionDescription?
⚪ signalingState
→ RTCSignalingState
⚪ iceGatheringState
→ RTCIceGatheringState
⚪ iceConnectionState
→ RTCIceConnectionState
⚪ connectionState
→ RTCPeerConnectionState
⚪ canTrickleIceCandidates
→ boolean?
⚪ onnegotiationneeded
→ EventHandler
⚪ onicecandidate
→ EventHandler
⚪ onicecandidateerror
→ EventHandler
⚪ onsignalingstatechange
→ EventHandler
⚪ oniceconnectionstatechange
→ EventHandler
⚪ onicegatheringstatechange
→ EventHandler
⚪ onconnectionstatechange
→ EventHandler
⚪ ondatachannel
→ EventHandler

---

Enum RTCDataChannelState

ValueDescription
connecting
open
closing
closed

Dictionary RTCDataChannelInit

6 members: 6 undocumented

Properties

⚪ ordered
→ boolean
⚪ maxPacketLifeTime
→ u16
⚪ maxRetransmits
→ u16
⚪ protocol
→ string
⚪ negotiated
→ boolean
⚪ id
→ u16

---

Interface RTCDataChannel

Extends: w3c.EventTarget

22 members: 22 undocumented

Methods

⚪ send(data)
string
⚪ send(data)
Blob
⚪ send(data)
BufferSource
⚪ send(data)
BufferSource
⚪ close()
Not documented

Properties

⚪ label
→ string
⚪ ordered
→ boolean
⚪ maxPacketLifeTime
→ u16?
⚪ maxRetransmits
→ u16?
⚪ protocol
→ string
⚪ negotiated
→ boolean
⚪ id
→ u16?
⚪ readyState
→ RTCDataChannelState
⚪ bufferedAmount
→ u32
⚪ bufferedAmountLowThreshold
→ u32
⚪ onopen
→ EventHandler
⚪ onbufferedamountlow
→ EventHandler
⚪ onerror
→ EventHandler
⚪ onclosing
→ EventHandler
⚪ onclose
→ EventHandler
⚪ onmessage
→ EventHandler
⚪ binaryType
→ BinaryType

---

Dictionary RTCPeerConnectionIceEventInit

Extends: w3c.EventInit

2 members: 2 undocumented

Properties

⚪ candidate
→ RTCIceCandidate?
⚪ url
→ string?

---

Interface RTCPeerConnectionIceEvent

Extends: w3c.Event

3 members: 3 undocumented

Constructors

⚪ constructor(type, eventInitDict)
string, RTCPeerConnectionIceEventInit

Properties

⚪ candidate
→ RTCIceCandidate?
⚪ url
→ string?

---

Dictionary RTCPeerConnectionIceErrorEventInit

Extends: w3c.EventInit

5 members: 5 undocumented

Properties

⚪ address
→ string?
⚪ port
→ u16?
⚪ url
→ string
⚪ errorCode
→ u16
⚪ errorText
→ string

---

Interface RTCPeerConnectionIceErrorEvent

Extends: w3c.Event

6 members: 6 undocumented

Constructors

⚪ constructor(type, eventInitDict)
string, RTCPeerConnectionIceErrorEventInit

Properties

⚪ address
→ string?
⚪ port
→ u16?
⚪ url
→ string
⚪ errorCode
→ u16
⚪ errorText
→ string

---

Dictionary RTCDataChannelEventInit

Extends: w3c.EventInit

1 members: 1 undocumented

Properties

⚪ channel
→ RTCDataChannel

---

Interface RTCDataChannelEvent

Extends: w3c.Event

2 members: 2 undocumented

Constructors

⚪ constructor(type, eventInitDict)
string, RTCDataChannelEventInit

Properties

⚪ channel
→ RTCDataChannel

---

Enum RTCErrorDetailType

ValueDescription
data-channel-failure
dtls-failure
fingerprint-failure
sctp-failure
sdp-syntax-error
hardware-encoder-not-available
hardware-encoder-error

Dictionary RTCErrorInit

5 members: 5 undocumented

Properties

⚪ errorDetail
→ RTCErrorDetailType
⚪ sdpLineNumber
→ i32
⚪ sctpCauseCode
→ i32
⚪ receivedAlert
→ u32
⚪ sentAlert
→ u32

---

Interface RTCError

Extends: w3c.DOMException

6 members: 6 undocumented

Constructors

⚪ constructor(init, message)
RTCErrorInit, string

Properties

⚪ errorDetail
→ RTCErrorDetailType
⚪ sdpLineNumber
→ i32?
⚪ sctpCauseCode
→ i32?
⚪ receivedAlert
→ u32?
⚪ sentAlert
→ u32?

---

Dictionary RTCErrorEventInit

Extends: w3c.EventInit

1 members: 1 undocumented

Properties

⚪ error
→ RTCError

---

Interface RTCErrorEvent

Extends: w3c.Event

2 members: 2 undocumented

Constructors

⚪ constructor(type, eventInitDict)
string, RTCErrorEventInit

Properties

⚪ error
→ RTCError

---

Interface RTCStatsReport

---