kotlin-browser/web.rtc/RTCPeerConnection

RTCPeerConnection

open external class RTCPeerConnection(configuration: RTCConfiguration = definedExternally) : EventTarget(source)

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.

Constructors

RTCPeerConnection

constructor(configuration: RTCConfiguration = definedExternally)

Types

object Companion

Properties

canTrickleIceCandidates

val canTrickleIceCandidates: Boolean?

connectionState

val connectionState: RTCPeerConnectionState

connectionStateChangeEvent

val connectionStateChangeEvent: EventInstance<Event, RTCPeerConnection, RTCPeerConnection>

currentLocalDescription

val currentLocalDescription: RTCSessionDescription?

currentRemoteDescription

val currentRemoteDescription: RTCSessionDescription?

dataChannelEvent

val dataChannelEvent: EventInstance<RTCDataChannelEvent, RTCPeerConnection, RTCPeerConnection>

iceCandidateErrorEvent

val iceCandidateErrorEvent: EventInstance<RTCPeerConnectionIceErrorEvent, RTCPeerConnection, RTCPeerConnection>

iceCandidateEvent

val iceCandidateEvent: EventInstance<RTCPeerConnectionIceEvent, RTCPeerConnection, RTCPeerConnection>

iceConnectionState

val iceConnectionState: RTCIceConnectionState

iceConnectionStateChangeEvent

val iceConnectionStateChangeEvent: EventInstance<Event, RTCPeerConnection, RTCPeerConnection>

iceGatheringState

val iceGatheringState: RTCIceGatheringState

iceGatheringStateChangeEvent

val iceGatheringStateChangeEvent: EventInstance<Event, RTCPeerConnection, RTCPeerConnection>

localDescription

val localDescription: RTCSessionDescription?

negotiationNeededEvent

val negotiationNeededEvent: EventInstance<Event, RTCPeerConnection, RTCPeerConnection>

onconnectionstatechange

var onconnectionstatechange: EventHandler<Event, RTCPeerConnection, RTCPeerConnection>?

var ondatachannel: EventHandler<RTCDataChannelEvent, RTCPeerConnection, RTCPeerConnection>?

var onicecandidate: EventHandler<RTCPeerConnectionIceEvent, RTCPeerConnection, RTCPeerConnection>?

onicecandidateerror

var onicecandidateerror: EventHandler<RTCPeerConnectionIceErrorEvent, RTCPeerConnection, RTCPeerConnection>?

oniceconnectionstatechange

var oniceconnectionstatechange: EventHandler<Event, RTCPeerConnection, RTCPeerConnection>?

onicegatheringstatechange

var onicegatheringstatechange: EventHandler<Event, RTCPeerConnection, RTCPeerConnection>?

onnegotiationneeded

var onnegotiationneeded: EventHandler<Event, RTCPeerConnection, RTCPeerConnection>?

onsignalingstatechange

var onsignalingstatechange: EventHandler<Event, RTCPeerConnection, RTCPeerConnection>?

var ontrack: EventHandler<RTCTrackEvent, RTCPeerConnection, RTCPeerConnection>?

pendingLocalDescription

val pendingLocalDescription: RTCSessionDescription?

pendingRemoteDescription

val pendingRemoteDescription: RTCSessionDescription?

remoteDescription

val remoteDescription: RTCSessionDescription?

val sctp: RTCSctpTransport?

val signalingState: RTCSignalingState

signalingStateChangeEvent

val signalingStateChangeEvent: EventInstance<Event, RTCPeerConnection, RTCPeerConnection>

val trackEvent: EventInstance<RTCTrackEvent, RTCPeerConnection, RTCPeerConnection>

Functions

addIceCandidate

suspend fun addIceCandidate(candidate: RTCIceCandidateInit? = definedExternally)

addIceCandidateAsync

fun addIceCandidateAsync(candidate: RTCIceCandidateInit? = definedExternally): Promise<Void>

fun addTrack(track: MediaStreamTrack, vararg streams: MediaStream): RTCRtpSender

fun addTransceiver(trackOrKind: String, init: RTCRtpTransceiverInit = definedExternally): RTCRtpTransceiver

fun addTransceiver(trackOrKind: MediaStreamTrack, init: RTCRtpTransceiverInit = definedExternally): RTCRtpTransceiver

fun close()

suspend fun createAnswer(options: RTCAnswerOptions = definedExternally): RTCSessionDescriptionInit

createAnswerAsync

fun createAnswerAsync(options: RTCAnswerOptions = definedExternally): Promise<RTCSessionDescriptionInit>

createDataChannel

fun createDataChannel(label: String, dataChannelDict: RTCDataChannelInit = definedExternally): RTCDataChannel

suspend fun createOffer(options: RTCOfferOptions = definedExternally): RTCSessionDescriptionInit

createOfferAsync

fun createOfferAsync(options: RTCOfferOptions = definedExternally): Promise<RTCSessionDescriptionInit>

fun dispatchEvent(event: Event): Boolean

getConfiguration

fun getConfiguration(): RTCConfiguration

fun getReceivers(): ReadonlyArray<RTCRtpReceiver>

fun getSenders(): ReadonlyArray<RTCRtpSender>

suspend fun getStats(selector: MediaStreamTrack? = definedExternally): RTCStatsReport

fun getStatsAsync(selector: MediaStreamTrack? = definedExternally): Promise<RTCStatsReport>

getTransceivers

fun getTransceivers(): ReadonlyArray<RTCRtpTransceiver>

fun removeTrack(sender: RTCRtpSender)

fun restartIce()

setConfiguration

fun setConfiguration(configuration: RTCConfiguration = definedExternally)

setLocalDescription

suspend fun setLocalDescription(description: RTCLocalSessionDescriptionInit = definedExternally)

setLocalDescriptionAsync

fun setLocalDescriptionAsync(description: RTCLocalSessionDescriptionInit = definedExternally): Promise<Void>

setRemoteDescription

suspend fun setRemoteDescription(description: RTCSessionDescriptionInit)

setRemoteDescriptionAsync

fun setRemoteDescriptionAsync(description: RTCSessionDescriptionInit): Promise<Void>