Live

interface Live

Live media-session lifecycle and scoped server WebSockets. Default methods preserve custom-client source compatibility.

Inheritors

Functions

Link copied to clipboard
open suspend fun acceptLiveSession(id: String, session: LiveSessionConfig, requestOptions: RequestOptions? = null)

Accepts an incoming SIP call. Audio formats are negotiated by SIP; client data-channel settings do not apply.

Link copied to clipboard
open suspend fun <T> attachLiveSession(id: String, secure: Boolean = true, requestOptions: RequestOptions? = null, block: suspend LiveConnection.() -> T): T

Attaches a trusted sideband to an existing session without sending session.start or replaying earlier events.

Link copied to clipboard
open suspend fun createLiveSession(request: LiveSessionRequest, requestOptions: RequestOptions? = null): LiveSessionResult

Creates a WebRTC session or places a real SIP call. Automatic retries are disabled for SIP; manually retrying an uncertain result can create duplicate calls.

Link copied to clipboard
open suspend fun downloadLiveRecording(id: String, requestOptions: RequestOptions? = null): ByteArray

Downloads recording content for a session started with storage enabled.

Link copied to clipboard
open suspend fun <T> forkLiveConnection(id: String, session: LiveSessionOverrides = LiveSessionOverrides(), secure: Boolean = true, requestOptions: RequestOptions? = null, block: suspend LiveConnection.() -> T): T

Starts a primary WebSocket from stored conversation state; omitted overrides inherit the stored configuration.

Link copied to clipboard
open suspend fun forkLiveSession(id: String, request: LiveSessionForkRequest, requestOptions: RequestOptions? = null): LiveSessionResult

Forks stored conversation state into a new WebRTC session.

Link copied to clipboard
open suspend fun hangupLiveSession(id: String, requestOptions: RequestOptions? = null)

Ends a SIP call.

Link copied to clipboard
open suspend fun <T> liveSession(session: LiveSessionConfig, secure: Boolean = true, requestOptions: RequestOptions? = null, block: suspend LiveConnection.() -> T): T

Opens a primary WebSocket and sends session.start. secure=false is intended only for trusted local test servers.

Link copied to clipboard
open suspend fun referLiveSession(id: String, targetUri: String, requestOptions: RequestOptions? = null)

Transfers a SIP call to a nonblank tel: or sip: target URI.

Link copied to clipboard
open suspend fun rejectLiveSession(id: String, statusCode: Int, requestOptions: RequestOptions? = null)

Rejects an incoming SIP call with a required SIP status from 300 to 699.