ktor-client-webrtc/io.ktor.client.webrtc/AndroidWebRtcPeerConnection

AndroidWebRtcPeerConnection

class AndroidWebRtcPeerConnection(coroutineContext: CoroutineContext, config: WebRtcConnectionConfig) : WebRtcPeerConnection(source)

Constructors

constructor(coroutineContext: CoroutineContext, config: WebRtcConnectionConfig)

Properties

dataChannelEvents

open override val dataChannelEvents: SharedFlow<DataChannelEvent>

Flow of newly added connection dataChannels, as a result of the remote peer calling WebRtcPeerConnection.createDataChannel.

iceCandidates

open override val iceCandidates: SharedFlow<WebRtc.IceCandidate>

Flow of ICE candidates generated by this peer connection.

iceConnectionState

open override val iceConnectionState: StateFlow<WebRtc.IceConnectionState>

Flow of ICE connection state changes.

iceGatheringState

open override val iceGatheringState: StateFlow<WebRtc.IceGatheringState>

Flow of ICE gathering state changes.

localDescription

open override val localDescription: WebRtc.SessionDescription?

The local session description for this connection.

negotiationNeeded

open override val negotiationNeeded: SharedFlow<Unit>

Sets a callback to be invoked when negotiation (offer-answer exchange, etc.) is needed for this connection.

remoteDescription

open override val remoteDescription: WebRtc.SessionDescription?

The remote session description for this connection.

signalingState

open override val signalingState: StateFlow<WebRtc.SignalingState>

Flow of signaling state changes.

state

open override val state: StateFlow<WebRtc.ConnectionState>

Flow of connection state changes.

stats

open override val stats: StateFlow<List<WebRtc.Stats>>

Flow of connection statistics.

trackEvents

open override val trackEvents: SharedFlow<TrackEvent>

Flow of events on a media track (e.g., add, remove).

Functions

addIceCandidate

open suspend override fun addIceCandidate(candidate: WebRtc.IceCandidate)

Adds a remote ICE candidate to this connection.

addTrack

open suspend override fun addTrack(track: WebRtcMedia.Track): WebRtc.RtpSender

Adds a media track to this connection.

awaitIceGatheringComplete

suspend fun awaitIceGatheringComplete()

open override fun close()

createAnswer

open suspend override fun createAnswer(): WebRtc.SessionDescription

Creates an SDP answer in response to a received offer.

createDataChannel

open suspend override fun createDataChannel(label: String, options: WebRtcDataChannelOptions.() -> Unit): WebRtcDataChannel

createOffer

open suspend override fun createOffer(): WebRtc.SessionDescription

Creates an SDP offer for establishing a connection.

getNative

fun WebRtcPeerConnection.getNative(): RTCPeerConnection

Returns implementation of the peer connection that is used under the hood. Use it with caution.

getStatistics

open suspend override fun getStatistics(): List<WebRtc.Stats>

Returns data providing statistics about the overall connection.

initialize

fun initialize(block: (PeerConnection.Observer) -> PeerConnection?): AndroidWebRtcPeerConnection

removeTrack

open suspend override fun removeTrack(sender: WebRtc.RtpSender)

Removes a track from this connection using its RTP sender.

open suspend override fun removeTrack(track: WebRtcMedia.Track)

Removes a track from this connection.

restartIce

open override fun restartIce()

Restarts ICE negotiation for this connection. Should emit negotiationNeeded event. The next offer will be created with iceRestart option.

setLocalDescription

open suspend override fun setLocalDescription(description: WebRtc.SessionDescription)

Sets the local session description.

setRemoteDescription

open suspend override fun setRemoteDescription(description: WebRtc.SessionDescription)

Sets the remote session description.