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

MxCall

interface MxCall : MxCallDetail
Content copied to clipboard

Define both an incoming call and on outgoing call.

Types

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

Functions

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

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

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

End the call.

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

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

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

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

Link copied to clipboard
abstract fun reject()
Content copied to clipboard

Reject an incoming call.

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

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>)
Content copied to clipboard

Send Call candidate to the other participant.

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

Send removed ICE candidates to the other participant.

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

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
Content copied to clipboard
Link copied to clipboard
abstract val capabilities: CallCapabilities?
Content copied to clipboard
Link copied to clipboard
abstract val isOutgoing: Boolean
Content copied to clipboard
Link copied to clipboard
abstract val isVideoCall: Boolean
Content copied to clipboard
Link copied to clipboard
abstract val opponentPartyId: Optional<String>?
Content copied to clipboard
Link copied to clipboard
abstract val opponentUserId: String
Content copied to clipboard
Link copied to clipboard
abstract val opponentVersion: Int
Content copied to clipboard
Link copied to clipboard
abstract val ourPartyId: String
Content copied to clipboard
Link copied to clipboard
abstract val roomId: String
Content copied to clipboard
Link copied to clipboard
abstract var state: CallState
Content copied to clipboard