matrix-sdk-android/org.matrix.android.sdk.api.session.room.model.call/CallInviteContent

CallInviteContent

@JsonClass(generateAdapter = true)
data class CallInviteContent(    @Json(name = "call_id") val callId: String?,     @Json(name = "party_id") val partyId: String? = null,     @Json(name = "offer") val offer: CallInviteContent.Offer?,     @Json(name = "version") val version: String?,     @Json(name = "lifetime") val lifetime: Int?,     @Json(name = "invitee") val invitee: String? = null,     @Json(name = "capabilities") val capabilities: CallCapabilities? = null) : CallSignalingContent
Content copied to clipboard

This event is sent by the caller when they wish to establish a call.

Constructors

Link copied to clipboard
fun CallInviteContent(    @Json(name = "call_id") callId: String?,     @Json(name = "party_id") partyId: String? = null,     @Json(name = "offer") offer: CallInviteContent.Offer?,     @Json(name = "version") version: String?,     @Json(name = "lifetime") lifetime: Int?,     @Json(name = "invitee") invitee: String? = null,     @Json(name = "capabilities") capabilities: CallCapabilities? = null)
Content copied to clipboard

Types

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class Offer(@Json(name = "type") val type: SdpType? = SdpType.OFFER, @Json(name = "sdp") val sdp: String?)
Content copied to clipboard

Functions

Link copied to clipboard
fun isVideo(): Boolean
Content copied to clipboard

Properties

Link copied to clipboard
open override val callId: String?
Content copied to clipboard

Required. A unique identifier for the call.

Link copied to clipboard
val capabilities: CallCapabilities? = null
Content copied to clipboard

Capability advertisement.

Link copied to clipboard
val invitee: String? = null
Content copied to clipboard

The field should be added for all invites where the target is a specific user.

Link copied to clipboard
val lifetime: Int?
Content copied to clipboard

Required. The time in milliseconds that the invite is valid for. Once the invite age exceeds this value, clients should discard it. They should also no longer show the call as awaiting an answer in the UI.

Link copied to clipboard
val offer: CallInviteContent.Offer?
Content copied to clipboard

Required. The session description object

Link copied to clipboard
open override val partyId: String? = null
Content copied to clipboard

Required. ID to let user identify remote echo of their own events

Link copied to clipboard
open override val version: String?
Content copied to clipboard

Required. The version of the VoIP specification this message adheres to.