Core-Telecom

Thư viện Core-Telecom giúp đơn giản hoá quy trình tích hợp ứng dụng gọi điện với nền tảng Android bằng cách cung cấp một tập hợp API mạnh mẽ và nhất quán

Nếu muốn khám phá các cách triển khai thực tế, bạn có thể tìm thấy các ứng dụng mẫu trên GitHub:

  • Ứng dụng mẫu đơn giản – Một ví dụ tối thiểu minh hoạ cách sử dụng API Core-Telecom. Phù hợp để nhanh chóng hiểu các khái niệm cơ bản.
  • Ứng dụng mẫu toàn diện (Do Nhóm Core-Telecom phát triển) – Một ứng dụng có nhiều tính năng hơn, giới thiệu các chức năng nâng cao của Telecom và các phương pháp hay nhất. Đây là một nguồn tài nguyên tuyệt vời để hiểu các tình huống tích hợp phức tạp.

Thiết lập Core-Telecom

Thêm phần phụ thuộc androidx.core:core-telecom vào tệp build.gradle của ứng dụng:

dependencies {
    implementation ("androidx.core:core-telecom:1.0.0")
}

Khai báo quyền MANAGE_OWN_CALLS trong AndroidManifest.xml:

<uses-permission android:name="android.permission.MANAGE_OWN_CALLS" />

Đăng ký ứng dụng của bạn

Đăng ký ứng dụng gọi điện của bạn với Android bằng CallsManager để bắt đầu thêm cuộc gọi vào hệ thống. Khi đăng ký, hãy chỉ định các tính năng của ứng dụng (ví dụ: hỗ trợ âm thanh, video):

val callsManager = CallsManager(context)

val capabilities: @CallsManager.Companion.Capability Int =
    (CallsManager.CAPABILITY_BASELINE or
          CallsManager.CAPABILITY_SUPPORTS_VIDEO_CALLING)

callsManager.registerAppWithTelecom(capabilities)

Quản lý cuộc gọi

Sử dụng API Core-Telecom để tạo và quản lý vòng đời cuộc gọi.

Tạo cuộc gọi

Đối tượng CallAttributesCompat xác định các thuộc tính của một cuộc gọi riêng biệt, có thể có các đặc điểm sau:

  • displayName: tên người gọi.
  • address: Địa chỉ cuộc gọi (ví dụ: số điện thoại, đường liên kết cuộc họp).
  • direction: Cuộc gọi đến hoặc cuộc gọi đi.
  • callType: Âm thanh hoặc video.
  • callCapabilities: Hỗ trợ chuyển và giữ máy.

Sau đây là ví dụ về cách tạo cuộc gọi đến:

fun createIncomingCallAttributes(
    callerName: String,
    callerNumber: String,
    isVideoCall: Boolean): CallAttributesCompat {
    val addressUri = Uri.parse("YourAppScheme:$callerNumber")

    // Define capabilities supported by your call.
    val callCapabilities = CallAttributesCompat.CallCapability(
        supportsSetInactive = CallAttributesCompat.SUPPORTS_SET_INACTIVE // Call can be made inactive (implies hold)
    )

    return CallAttributesCompat(
        displayName = callerName,
        address = addressUri,
        direction = CallAttributesCompat.DIRECTION_INCOMING,
        callType = if (isVideoCall) CallAttributesCompat.CALL_TYPE_VIDEO_CALL else CallAttributesCompat.CALL_TYPE_AUDIO_CALL,
        callCapabilitiesCompat = callCapabilities
    )
}

Thêm cuộc gọi

Sử dụng callsManager.addCall với CallAttributesCompat và lệnh gọi lại để thêm cuộc gọi mới vào hệ thống và quản lý các bản cập nhật nền tảng từ xa. callControlScope trong khối addCall chủ yếu cho phép ứng dụng của bạn chuyển đổi trạng thái cuộc gọi và nhận các bản cập nhật âm thanh:

try {
    callsManager.addCall(
        INCOMING_CALL_ATTRIBUTES,
        onAnswerCall, // Watch needs to know if it can answer the call.
        onSetCallDisconnected,
        onSetCallActive,
        onSetCallInactive
    ) {
        // The call was successfully added once this scope runs.
        callControlScope = this
    }
}
catch(addCallException: Exception){
   // Handle the addCall failure.
}

Trả lời cuộc gọi

Trả lời cuộc gọi đến trong CallControlScope:

when (val result = answer(CallAttributesCompat.CALL_TYPE_AUDIO_CALL)) {
    is CallControlResult.Success -> { /* Call answered */ }
    is CallControlResult.Error -> { /* Handle error */ }
}

Từ chối cuộc gọi

Từ chối cuộc gọi bằng disconnect() với DisconnectCause.REJECTED trong CallControlScope:

disconnect(DisconnectCause(DisconnectCause.REJECTED))

Kích hoạt cuộc gọi đi

Đặt cuộc gọi đi ở trạng thái hoạt động sau khi bên từ xa trả lời:

when (val result = setActive()) {
    is CallControlResult.Success -> { /* Call active */ }
    is CallControlResult.Error -> { /* Handle error */ }
}

Giữ cuộc gọi

Sử dụng setInactive() để giữ cuộc gọi:

when (val result = setInactive()) {
    is CallControlResult.Success -> { /* Call on hold */ }
    is CallControlResult.Error -> { /* Handle error */ }
}

Kết thúc cuộc gọi

Kết thúc cuộc gọi bằng disconnect() với DisconnectCause:

disconnect(DisconnectCause(DisconnectCause.LOCAL))

Quản lý điểm cuối âm thanh của cuộc gọi

Quan sát và quản lý các điểm cuối âm thanh bằng currentCallEndpoint, availableEndpointsisMuted Flow trong CallControlScope. Không sử dụng API AudioManager#setCommunicationDevice hoặc AudioManager#startBluetoothSco để quản lý các tuyến âm thanh khi sử dụng Telecom; việc này sẽ gây ra các vấn đề về âm thanh trong cuộc gọi của bạn.

fun observeAudioStateChanges(callControlScope: CallControlScope) {
    with(callControlScope) {
        launch { currentCallEndpoint.collect { /* Update UI */ } }
        launch { availableEndpoints.collect { /* Update UI */ } }
        launch { isMuted.collect { /* Handle mute state */ } }
    }
}

Thay đổi thiết bị âm thanh đang hoạt động bằng requestEndpointChange():

coroutineScope.launch {
     callControlScope.requestEndpointChange(callEndpoint)
}

Hỗ trợ trên nền trước

Thư viện này sử dụng ConnectionService (API Android 13 cấp độ API 33 trở xuống) hoặc foregroundtypes (API Android 14 cấp độ API 34 trở lên) để hỗ trợ trên nền trước.

Trong các yêu cầu về nền trước, ứng dụng phải đăng thông báo để người dùng biết rằng ứng dụng đang chạy ở nền trước.

Để đảm bảo ứng dụng của bạn được ưu tiên thực thi ở nền trước, hãy tạo thông báo sau khi bạn thêm cuộc gọi vào nền tảng. Mức độ ưu tiên ở nền trước sẽ bị xoá khi ứng dụng của bạn kết thúc cuộc gọi hoặc thông báo của bạn không còn hợp lệ.

Tìm hiểu thêm về các dịch vụ trên nền trước.

Hỗ trợ nền tảng từ xa

Các thiết bị từ xa (đồng hồ thông minh, tai nghe Bluetooth, Android Auto) có thể quản lý cuộc gọi mà không cần tương tác trực tiếp với điện thoại. Ứng dụng của bạn phải triển khai các lambda gọi lại (onAnswerCall, onSetCallDisconnected, onSetCallActive, onSetCallInactive) được cung cấp cho CallsManager.addCall để xử lý các hành động do các thiết bị này khởi tạo.

Khi một hành động từ xa xảy ra, lambda tương ứng sẽ được gọi.

Việc hoàn tất thành công lambda cho biết rằng lệnh đã được xử lý. Nếu không tuân theo được lệnh, lambda sẽ gửi một ngoại lệ.

Việc triển khai đúng cách sẽ đảm bảo khả năng kiểm soát cuộc gọi liền mạch trên nhiều thiết bị. Kiểm thử kỹ lưỡng với nhiều nền tảng từ xa.

Phần mở rộng về cuộc gọi

Ngoài việc quản lý trạng thái cuộc gọi và tuyến âm thanh của cuộc gọi, thư viện này còn hỗ trợ các phần mở rộng về cuộc gọi. Đây là các tính năng không bắt buộc mà ứng dụng của bạn có thể triển khai để có trải nghiệm gọi điện phong phú hơn trên các nền tảng từ xa, chẳng hạn như Android Auto. Các tính năng này bao gồm phòng họp, tắt tiếng cuộc gọi và các biểu tượng cuộc gọi bổ sung. Khi ứng dụng của bạn triển khai một phần mở rộng, thông tin mà ứng dụng cung cấp sẽ được đồng bộ hoá với tất cả các thiết bị được kết nối cũng hỗ trợ hiển thị các phần mở rộng này trong giao diện người dùng. Điều này có nghĩa là người dùng cũng có thể sử dụng các tính năng này trên các thiết bị từ xa.

Tạo cuộc gọi có phần mở rộng

Khi tạo cuộc gọi, thay vì sử dụng CallManager#addCall để tạo cuộc gọi, bạn có thể sử dụng CallManager#addCallWithExtensions. Phương thức này cho phép ứng dụng truy cập vào một phạm vi khác có tên là ExtensionInitializationScope. Phạm vi này cho phép ứng dụng khởi chạy tập hợp các phần mở rộng không bắt buộc mà ứng dụng hỗ trợ. Ngoài ra, phạm vi này cung cấp một phương thức bổ sung là onCall. Phương thức này cung cấp CallControlScope cho ứng dụng sau khi quá trình trao đổi và khởi chạy tính năng mở rộng hoàn tất.

scope.launch {
    mCallsManager.addCallWithExtensions(
        attributes,
        onAnswer,
        onDisconnect,
        onSetActive,
        onSetInactive
    ) {
        // Initialize extension-specific code...

        // After the call has been initialized, perform in-call actions
        onCall {
            // Example: process call state updates
            callStateFlow.onEach { newState ->
                // handle call state updates and notify telecom
            }.launchIn(this)

            // Use initialized extensions...
        }
    }
}

Hỗ trợ người tham gia cuộc gọi

Nếu ứng dụng của bạn hỗ trợ người tham gia cuộc gọi cho cuộc họp hoặc cuộc gọi nhóm, hãy sử dụng addParticipantExtension để khai báo hỗ trợ cho phần mở rộng này và sử dụng các API liên quan để cập nhật các nền tảng từ xa khi người tham gia thay đổi.

mCallsManager.addCallWithExtensions(...) {
        // Initialize extensions...

        // Notifies Jetpack that this app supports the participant
        // extension and provides the initial participants state in the call.
        val participantExtension = addParticipantExtension(
            initialParticipants,
            initialActiveParticipant
        )

        // After the call has been initialized, perform in-call control actions
        onCall {
            // other in-call control and extension actions...

            // Example: update remote surfaces when the call participants change
            participantsFlow.onEach { newParticipants ->
                participantExtension.updateParticipants(newParticipants)
            }.launchIn(this)
        }
    }

Ngoài việc thông báo cho các nền tảng từ xa về những người tham gia cuộc gọi, bạn cũng có thể cập nhật người tham gia đang hoạt động bằng ParticipantExtension#updateActiveParticipant.

Ngoài ra, còn có tính năng hỗ trợ các hành động không bắt buộc liên quan đến người tham gia cuộc gọi. Ứng dụng có thể sử dụng ParticipantExtension#addRaiseHandSupport để hỗ trợ khái niệm người tham gia giơ tay trong cuộc gọi và xem những người tham gia khác cũng giơ tay.

mCallsManager.addCallWithExtensions(...) {
        // Initialize extensions...

        // Notifies Jetpack that this app supports the participant
        // extension and provides the initial list of participants in the call.
        val participantExtension = addParticipantExtension(initialParticipants)
        // Notifies Jetpack that this app supports the notion of participants
        // being able to raise and lower their hands.
        val raiseHandState = participantExtension.addRaiseHandSupport(
                initialRaisedHands
            ) { onHandRaisedStateChanged ->
                // handle this user's raised hand state changed updates from
                // remote surfaces.
            }

        // After the call has been initialized, perform in-call control actions
        onCall {
            // other in-call control and extension actions...

            // Example: update remote surfaces when the call participants change
            participantsFlow.onEach { newParticipants ->
                participantExtension.updateParticipants(newParticipants)
            }.launchIn(this)
            // notify remote surfaces of which of the participants have their
            // hands raised
            raisedHandsFlow.onEach { newRaisedHands ->
                raiseHandState.updateRaisedHands(newRaisedHands)
            }.launchIn(this)
        }
    }

Hỗ trợ tắt tiếng cuộc gọi

Tính năng tắt tiếng cuộc gọi cho phép người dùng yêu cầu ứng dụng tắt tiếng âm thanh đi của cuộc gọi mà không cần tắt tiếng micrô của thiết bị theo cách thủ công. Tính năng này được quản lý theo từng cuộc gọi, vì vậy, Jetpack xử lý sự phức tạp của việc quản lý trạng thái tắt tiếng toàn cầu của các cuộc gọi di động đang diễn ra trong khi cuộc gọi VOIP đang hoạt động. Điều này giúp giảm lỗi khi tắt tiếng âm thanh đi trong các tình huống có nhiều cuộc gọi, đồng thời cho phép các tính năng hữu ích như chỉ báo "bạn đang nói" khi người dùng đang nói mà không nhận ra rằng tính năng tắt tiếng cuộc gọi đang bật.

mCallsManager.addCallWithExtensions(...) {
        // Initialize extensions...

        // Add support for locally silencing the call's outgoing audio and
        // register a handler for when the user changes the call silence state
        // from a remote surface.
        val callSilenceExtension = addLocalCallSilenceExtension(
            initialCallSilenceState = false
        ) { newCallSilenceStateRequest ->
            // handle the user's request to enable/disable call silence from
            // a remote surface
        }

        // After the call has been initialized, perform in-call control actions
        onCall {
            // other in-call control and extension actions...

            // When the call's call silence state changes, update remote
            // surfaces of the new state.
            callSilenceState.onEach { isSilenced ->
                callSilenceExtension.updateIsLocallySilenced(isSilenced)
            }.launchIn(this)
        }
    }

Hỗ trợ biểu tượng cuộc gọi

Biểu tượng cuộc gọi cho phép ứng dụng chỉ định một biểu tượng tuỳ chỉnh đại diện cho cuộc gọi sẽ hiển thị trên các nền tảng từ xa trong cuộc gọi. Bạn cũng có thể cập nhật biểu tượng này trong suốt thời gian diễn ra cuộc gọi.

mCallsManager.addCallWithExtensions(...) {
        // Initialize extensions...

        // Add support for a custom call icon to be displayed during the
        // lifetime of the call.
        val callIconExtension = addCallIconExtension(
            initialCallIconUri = initialUri
        )

        // After the call has been initialized, perform in-call control actions
        onCall {
            // other in-call control and extension actions...

            // When the call's icon changes, update remote surfaces by providing
            // the new URI.
            callIconUri.onEach { newIconUri ->
                callIconExtension.updateCallIconUri(newIconUri)
            }.launchIn(this)
        }
    }

Thêm vào nhật ký cuộc gọi của hệ thống

Bạn có thể thêm các cuộc gọi VoIP của ứng dụng vào nhật ký cuộc gọi của hệ thống để các cuộc gọi này xuất hiện trong trình quay số của hệ thống và người dùng có thể gọi lại từ đó. Để biết thông tin chi tiết, hãy xem bài viết Nhật ký cuộc gọi hợp nhất.