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

Package-level declarations

Types

AndroidDtmfSender

class AndroidDtmfSender(nativeSender: DtmfSender) : WebRtc.DtmfSender

AndroidRtpParameters

class AndroidRtpParameters(nativeRtpParameters: RtpParameters) : WebRtc.RtpParameters

AndroidRtpSender

class AndroidRtpSender(nativeSender: RtpSender) : WebRtc.RtpSender

AndroidWebRtc

object AndroidWebRtc : WebRtcClientEngineFactory<AndroidWebRtcEngineConfig>

AndroidWebRtcDataChannel

class AndroidWebRtcDataChannel(nativeChannel: DataChannel, channelInit: DataChannel.Init?, coroutineScope: CoroutineScope, receiveOptions: DataChannelReceiveOptions) : WebRtcDataChannel

WebRtc data channel implementation for the Android platform.

AndroidWebRtcEngine

class AndroidWebRtcEngine(val config: AndroidWebRtcEngineConfig, mediaTrackFactory: MediaTrackFactory = config.mediaTrackFactory ?: AndroidMediaDevices(config.context ?: error("Context is required for AndroidWebRtcEngine"))) : WebRtcEngineBase, MediaTrackFactory

AndroidWebRtcEngineConfig

class AndroidWebRtcEngineConfig : WebRtcConfig

AndroidWebRtcPeerConnection

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

DataChannelEvent

sealed interface DataChannelEvent

Events that can be emitted by a WebRTC data channel.

DataChannelReceiveOptions

class DataChannelReceiveOptions

Configuration options for creating a Channel. This class is used to configure the incoming messages channel in WebRtcDataChannel.

DefaultExceptionHandler

class DefaultExceptionHandler(name: String) : CoroutineExceptionHandler

Default coroutine exception handler that logs all errors except of CancellationException.

JsAudioTrack

class JsAudioTrack(nativeTrack: MediaStreamTrack) : JsMediaTrack, WebRtcMedia.AudioTrack

JsDtmfSender

class JsDtmfSender(nativeSender: RTCDTMFSender) : WebRtc.DtmfSender

Wrapper for RTCRtpSender.

JsMediaTrack

abstract class JsMediaTrack(nativeTrack: MediaStreamTrack) : WebRtcMedia.Track

Wrapper for MediaStreamTrack.

JsPeerConnectionConfig

interface JsPeerConnectionConfig

JsRtpParameters

class JsRtpParameters(nativeRtpParameters: RTCRtpSendParameters) : WebRtc.RtpParameters

Wrapper for RTCRtpSendParameters.

JsRtpSender

class JsRtpSender(nativeSender: RTCRtpSender) : WebRtc.RtpSender

Wrapper for RTCRtpSender.

JsVideoTrack

class JsVideoTrack(nativeTrack: MediaStreamTrack) : JsMediaTrack, WebRtcMedia.VideoTrack

JsWebRtc

object JsWebRtc : WebRtcClientEngineFactory<JsWebRtcEngineConfig>

Common WebRtc Engine factory interface for JS and WasmJS targets.

JsWebRtcDataChannel

class JsWebRtcDataChannel(channel: RTCDataChannel, coroutineScope: CoroutineScope, receiveOptions: DataChannelReceiveOptions) : WebRtcDataChannel

WebRtc data channel implementation for the JavaScript platform.

JsWebRtcEngine

class JsWebRtcEngine(config: JsWebRtcEngineConfig, mediaTrackFactory: MediaTrackFactory = config.mediaTrackFactory ?: NavigatorMediaDevices) : WebRtcEngineBase, MediaTrackFactory

JsWebRtcEngineConfig

class JsWebRtcEngineConfig : WebRtcConfig

JsWebRtcPeerConnection

class JsWebRtcPeerConnection(connection: RTCPeerConnection, coroutineContext: CoroutineContext, config: WebRtcConnectionConfig) : WebRtcPeerConnection

WebRtc peer connection implementation for JavaScript platform.

MediaTrackFactory

interface MediaTrackFactory

Factory interface for creating audio and video media tracks.

NavigatorMediaDevices

object NavigatorMediaDevices : MediaTrackFactory

MediaTrackFactory based on browser Navigator MediaDevices.

TrackEvent

sealed interface TrackEvent

Represents events related to media tracks in a WebRTC peer connection.

WebRtc

object WebRtc

An object containing WebRtc protocol entities and abstractions. Provides the core types and interfaces needed for WebRtc peer-to-peer communication.

WebRtcClient

@ExperimentalKtorApi

class WebRtcClient(engine: WebRtcEngine) : WebRtcEngine

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

WebRtcClientEngineFactory

fun interface WebRtcClientEngineFactory<out T : WebRtcConfig>

Client engine factory interface, used in engine implementations.

WebRtcConfig

open class WebRtcConfig

Configuration for the WebRtc client.

WebRtcConnectionConfig

open class WebRtcConnectionConfig

Configuration for WebRtc connections.

WebRtcConnectionEvents

interface WebRtcConnectionEvents

Interface providing access to various events and state changes in a WebRTC peer connection.

WebRtcConnectionEventsEmitter

class WebRtcConnectionEventsEmitter(config: WebRtcConnectionConfig) : WebRtcConnectionEvents

Internal implementation of WebRtcConnectionEvents that emits events to flows.

WebRtcDataChannel

abstract class WebRtcDataChannel : WebRtc.DataChannel

Abstract class representing a network channel which can be used for bidirectional peer-to-peer transfers of arbitrary data. Every data channel is associated with an WebRtcPeerConnection.

WebRtcDataChannelOptions

class WebRtcDataChannelOptions

Configuration options for creating a WebRTC data channel.

WebRtcEngine

interface WebRtcEngine : AutoCloseable, MediaTrackFactory

Core engine interface for WebRtc functionality.

WebRtcEngineBase

abstract class WebRtcEngineBase(engineName: String, configuration: WebRtcConfig) : WebRtcEngine

Base implementation of the WebRtcEngine interface.

WebRtcEngineClosedException

class WebRtcEngineClosedException : CancellationException

Exception used as a cancellation cause when WebRtcEngine coroutine context is closed.

WebRtcMedia

object WebRtcMedia

An object containing Media Capture abstractions. Media Capturing is platform- and implementation-specific, so here we encapsulate only the essential parts for the WebRtc communication. The links describe the standard browser API, though some platforms could have different behaviors.

WebRtcPeerConnection

abstract class WebRtcPeerConnection : Closeable, WebRtcConnectionEvents

Abstract class representing a peer-to-peer connection.

Functions

getNative

fun WebRtc.DtmfSender.getNative(): DtmfSender

Returns implementation of the dtmf sender that is used under the hood. Use it with caution.

fun WebRtc.RtpParameters.getNative(): RtpParameters

Returns implementation of the rtp parameters that is used under the hood. Use it with caution.

fun WebRtc.RtpSender.getNative(): RtpSender

Returns implementation of the rtp sender that is used under the hood. Use it with caution.

fun WebRtcDataChannel.getNative(): DataChannel

Returns implementation of the data channel that is used under the hood. Use it with caution.

fun WebRtc.DtmfSender.getNative(): RTCDTMFSender

Returns implementation of the dtmf sender that is used under the hood. Use it with caution.

fun WebRtc.RtpParameters.getNative(): RTCRtpSendParameters

Returns implementation of the rtp parameters that is used under the hood. Use it with caution.

fun WebRtc.RtpSender.getNative(): RTCRtpSender

Returns implementation of the rtp sender that is used under the hood. Use it with caution.

fun WebRtcDataChannel.getNative(): RTCDataChannel

Returns implementation of the data channel that is used under the hood. Use it with caution.

fun WebRtcMedia.Track.getNative(): MediaStreamTrack

Returns implementation of the native media stream track used under the hood. Use it with caution.

fun WebRtcPeerConnection.getNative(): RTCPeerConnection

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

WebRtcClient

@ExperimentalKtorApi

fun <T : WebRtcConfig> WebRtcClient(factory: WebRtcClientEngineFactory<T>, block: T.() -> Unit = {}): WebRtcClient

Creates a WebRtcClient with a specified engine.