voice-sdk/com.eght.voice.sdk.model/VoiceCall

VoiceCall

data class VoiceCall : Serializable

Wrapper class for RTCCall that contains all mid-call features.

Parameters

call

Object containing all call information.

Types

Link copied to clipboard
enum Direction : Enum<VoiceCall.Direction>

Call direction

Properties

Link copied to clipboard
val avatarUrl: String

Read-only property for the callee's avatar url type String

Link copied to clipboard
val callQuality: CallConnectionQuality

Read-only property to know call quality.

Link copied to clipboard
val callStartTime: Long

Read-only property for the time the call started type Long.

Link copied to clipboard
val callState: VoiceCallStatus

Read-only property to know call state.

Link copied to clipboard
val contactId: String?

Read-only property for the callee's id from the contact object in RTCCall.

Link copied to clipboard
val direction: VoiceCall.Direction

Read-only property to know call direction.

Link copied to clipboard
val displayName: String?

Read-only property for the callee's name.

Link copied to clipboard
val isDisconnected: Boolean

Read-only property to know if call is in disconnected state.

Link copied to clipboard
val isFailed: Boolean

Read-only property to know if call is in failed state.

Link copied to clipboard
val isIncoming: Boolean

Read-only property for the call's incoming state. True if the state is incoming, False otherwise.

Link copied to clipboard
val isMuted: Boolean

Read-only property for the call's audio state. True if it states is incoming, False otherwise.

Link copied to clipboard
val isOngoing: Boolean

Read-only property to know if call is in ongoing state.

Link copied to clipboard
val isOutgoing: Boolean

Read-only property to know if call is in outgoing state.

Link copied to clipboard
val isPeerOnHold: Boolean

Read-only property for the call's peer on hold state. True if peer is on hold , False otherwise.

Link copied to clipboard
val phoneNumber: String?

Read-only property for the callee's phone number.

Link copied to clipboard
val uuid: UUID

Read-only property for the call's unique identifier.

Functions

Link copied to clipboard
fun accept(): CallActionCompletionStatus

Accepts an incoming call. Accepting second call will put ongoing call on hold.

Link copied to clipboard
fun endAndAccept()

Accepts incoming call and end Ongoing call.

Link copied to clipboard
fun hangup(): CallActionCompletionStatus

Hangs up current active call.

Link copied to clipboard
fun hold(): CallActionCompletionStatus

Puts current call on hold.

Link copied to clipboard
fun mute()

Mutes user during a call.

Link copied to clipboard
fun reject(): CallActionCompletionStatus

Rejects or denies an incoming call.

Link copied to clipboard
fun resume(): CallActionCompletionStatus

Resumes call that was on hold.

Link copied to clipboard
fun unmute()

Un-mutes user during a call.