CallControlScope

interface CallControlScope : CoroutineScope

DSL interface to provide and receive updates about a call session. The CallControlScope should be used to provide updates (via the CallControlScope suspend functions) and receive updates (via the lambda functions) about the call. The CallControlScope will run for the duration of the call. To see an example implementation of the CallControlScope, please refer to the sample app on github.

Example usage:

// initiate a call and control via the CallControlScope
mCallsManager.addCall(
    callAttributes,
    onAnswerLambda,
    onDisconnectLambda,
    onSetActiveLambda,
    onSetInActiveLambda
    ) {
    // This block represents the CallControlScope. Once Telecom has added the call to the
    // system, your application can start changing the call state (via setActive(), etc.),
    // collect the flows.


      // Your application should gate ALL CallControlScope suspend functions with UI logic or
      // logic that signals the call state is ready to be changed
      launch {
             when (val res = setActive() ) {

               is CallControlResult.Success -> {
                 // Telecom can place the active
                 // update your call state and handle UI
               }

               is CallControlResult.Error -> {
                 // Telecom cannot set your VoIP call active. Maybe there is an ongoing
                 // active call that cannot be held. Check the failure code to determine the
                 // recommended next action
                 handleErrorCode( res.errorCode )
               }
              }
            }
       }

      // Collect updates
      launch {
         currentCallEndpoint.collect { // access the new [CallEndpoint] here }
      }

      launch {
         availableEndpoints.collect { // access the available [CallEndpoint]s here }
      }

      launch {
         isMuted.collect { // access to the mute state }
      }
  }

Note: Each Flow must be wrapped in an individual launch block or the Flow will not be collected.

Summary

suspend fun answer(callType: Int): CallControlResult

suspend fun disconnect(disconnectCause: DisconnectCause): CallControlResult

fun getCallId(): ParcelUuid

suspend fun requestEndpointChange(endpoint: CallEndpointCompat): CallControlResult

suspend fun setActive(): CallControlResult

suspend fun setInactive(): CallControlResult

val availableEndpoints: Flow<List<CallEndpointCompat>>

val currentCallEndpoint: Flow<CallEndpointCompat>

val isMuted: Flow<Boolean>