ktor-client-webrtc/io.ktor.client.webrtc/WebRtcClient

WebRtcClient

class WebRtcClient(engine: WebRtcEngine) : WebRtcEngine(source)

A multiplatform asynchronous WebRtc client for establishing peer-to-peer connections, managing media tracks.

This client provides a high-level API for WebRTC communication, delegating actual implementation to platform-specific engines. It supports creating peer connections, managing media tracks, and handling WebRTC signaling.

Constructors

WebRtcClient

constructor(engine: WebRtcEngine)

Properties

config

open override val config: WebRtcConfig

Functions

expect open override fun close()

createAudioTrack

open suspend override fun createAudioTrack(constraints: WebRtcMedia.AudioTrackConstraints): WebRtcMedia.AudioTrack

open suspend override fun createAudioTrack(constraints: WebRtcMedia.AudioTrackConstraints.() -> Unit): WebRtcMedia.AudioTrack

createPeerConnection

open suspend override fun createPeerConnection(config: WebRtcConnectionConfig): WebRtcPeerConnection

Creates a new peer connection with the configured settings.

open suspend override fun createPeerConnection(config: WebRtcConnectionConfig.() -> Unit): WebRtcPeerConnection

Creates a new peer connection with the configured settings. If no configuration is provided, the default configuration from WebRtcConfig.defaultConnectionConfig will be used.

createVideoTrack

open suspend override fun createVideoTrack(constraints: WebRtcMedia.VideoTrackConstraints): WebRtcMedia.VideoTrack

open suspend override fun createVideoTrack(constraints: WebRtcMedia.VideoTrackConstraints.() -> Unit): WebRtcMedia.VideoTrack