platform_telecom_api_service_telecom/com.tomtom.ivi.platform.telecom.api.service.telecom/TelecomService

TelecomService

Service responsible for making and receiving calls.

Note that most actions on calls do not return an error state. The reason for this is the current call states is already reflected through the currentCalls property, which should be reflected by the UI directly. Any error handling would only make this complex and error prone. However the service implementation is encouraged to log any reason why an action might be ignored as a warning.

Types

Companion

object Companion

Properties

currentCalls

abstract val currentCalls: MirrorableMap<CallId, Call>

Map of all calls in any state where the key is a unique identifier referring to a call and where the value is the data structure containing details about the Call.

isMuted

abstract val isMuted: Boolean

The microphone muted state.

Functions

answerCall

abstract suspend fun answerCall(callId: CallId)

Answers the call with the specified callId. The call should be in the ringing state.

endCall

abstract suspend fun endCall(callId: CallId)

Ends the call with the specified callId.

initiateCall

abstract suspend fun initiateCall(phoneUri: PhoneUri): Boolean

Initiates a call with the specified uri.

playDtmfTone

abstract suspend fun playDtmfTone(callId: CallId, dtmfTone: DtmfTone)

Instructs the call with specified callId to play a DTMF tone. The tone will be played for a fixed amount of time before being stopped. Any other currently playing DTMF tone in the specified call is immediately stopped.

rejectCall

abstract suspend fun rejectCall(callId: CallId)

Rejects the call with the specified callId. The call should be in the ringing state.

setCallOnHold

abstract suspend fun setCallOnHold(callId: CallId, onHold: Boolean)

Instructs the call with the specified callId to go on hold or go back to the active connected state.

setMuted

abstract suspend fun setMuted(muted: Boolean)

Mutes or unmutes the microphone.