matrix-sdk-android/org.matrix.android.sdk.api.session.call/MxCall

MxCall

interface MxCall : MxCallDetail

Define both an incoming call and on outgoing call.

Types

Link copied to clipboard
object Companion
Link copied to clipboard
interface StateListener

Functions

Link copied to clipboard
abstract fun accept(sdpString: String)

Pick Up the incoming call. It has no effect on outgoing call.

Link copied to clipboard
abstract fun addListener(listener: MxCall.StateListener)
Link copied to clipboard
abstract fun hangUp(reason: EndCallReason? = null)

End the call.

Link copied to clipboard
abstract fun negotiate(sdpString: String, type: SdpType)

SDP negotiation for media pause, hold/resume, ICE restarts and voice/video call up/downgrading.

Link copied to clipboard
abstract fun offerSdp(sdpString: String)

Start a call. Send offer SDP to the other participant.

Link copied to clipboard
abstract fun reject()

Reject an incoming call.

Link copied to clipboard
abstract fun removeListener(listener: MxCall.StateListener)
Link copied to clipboard
abstract fun selectAnswer()

This has to be sent by the caller's client once it has chosen an answer.

Link copied to clipboard
abstract fun sendLocalCallCandidates(candidates: List<CallCandidate>)

Send Call candidate to the other participant.

Link copied to clipboard
abstract fun sendLocalIceCandidateRemovals(candidates: List<CallCandidate>)

Send removed ICE candidates to the other participant.

Link copied to clipboard
abstract suspend fun transfer(targetUserId: String, targetRoomId: String?, createCallId: String?, awaitCallId: String?)

Send a m.call.replaces event to initiate call transfer. See org.matrix.android.sdk.api.session.room.model.call.CallReplacesContent for documentation about the parameters

Properties

Link copied to clipboard
abstract val callId: String
Link copied to clipboard
Link copied to clipboard
abstract val isOutgoing: Boolean
Link copied to clipboard
abstract val isVideoCall: Boolean
Link copied to clipboard
abstract val opponentPartyId: Optional<String>?
Link copied to clipboard
abstract val opponentUserId: String
Link copied to clipboard
abstract val opponentVersion: Int
Link copied to clipboard
abstract val ourPartyId: String
Link copied to clipboard
abstract val roomId: String
Link copied to clipboard
abstract var state: CallState