搜尋套件、儲存庫與 APP 分類

套件詳情v0.1.0

flutter_ios_voip_kit

使用 CallKit 和 PushKit 的 Flutter iOS 應用程式實現一對一視訊通話。

AndroidiOS
近 30 天下載
47
喜歡數
53
Pub 分數
130

安裝套件

flutter pub add flutter_ios_voip_kit

套件介紹

根據套件公開資料產生的選型評估,僅供參考。

一個 Flutter 套件,可在 iOS 上使用 CallKit 與 PushKit 實現一對一視訊通話,無縫整合系統原生撥號介面。它支援來電通知、背景處理,並提供類似原生的通話體驗。此套件專為 iOS 設計,利用平台特定 API 以確保可靠的即時通訊。雖然其設定支援 Android,但核心功能著重於 iOS。需正確設定 VoIP 推送憑證與後端推播通知支援。

適用情境

  • 即時視頻通話應用
  • iOS 原生通話體驗
  • 背景呼叫處理
  • 基於推送的呼叫發起
  • 與 CallKit UI 集成

主要特色

  • CallKit 結合
  • PushKit 支援
  • 背景呼叫功能
  • 原生 iOS 呼叫介面
  • VoIP推送通知處理

適合對象

  • 專注於iOS的視頻通話應用
  • 需要系統級呼叫整合的應用程式
  • 開發遠端醫療或訊息傳遞平台的開發者
  • 需要背景呼叫持久性的專案

使用建議

  • 需要 iOS 專有的設定
  • 需要 VoIP 推送證書設定
  • 需要後端推送通知服務
  • 有限的 Android 功能
  • 與 Apple 開發者門戶的複雜初始設定

原始 README

以下為關聯原始碼儲存庫的 README 原文快照,最新內容請造訪原始碼儲存庫。

flutter_ios_voip_kit

One-to-one video call using CallKit and PushKit with flutter iOS app.

Motivation

We need to use CallKit to handle incoming VoIP notifications from iOS 13. Check the WWDC2019 video for more information. So instead of using CallKit and PushKit separately, there is a growing need to use them together. However, there are still few VoIP notification samples on the net that use CallKit and PushKit (especially for Flutter). I decided to create a flutter plugin with the minimum required functions. You can use this plugin, but the actual purpose is to help you create a VoIPKit tailored to your service.

Requirement

  • iOS only, not support Android.
  • iOS 10 or above.
  • one-to-one call only, not support group call.
  • need to a server for pushing VoIP notification with APNs.
  • to actually make a video or call, you need to link to a service such as WebRTC(ex: Agora, SkyWay, Amazon Kinesis Video Streams).

Usage

1. install
  • Add flutter_ios_voip_kit as a dependency in your pubspec.yaml file.
2. setting Capability in Xcode
  1. Select Background Modes > Voice over IP and Remote notifications is ON.
  2. Select Push Notifications.
  3. Changed ios/Runner/Info.plist after selected Capability.
<key>UIBackgroundModes</key>
<array>
    <string>remote-notification</string>
    <string>voip</string>
</array>
2. edit Info.plist
  • Edit ios/Runner/Info.plist as below.
<key>FIVKIconName</key>
<string>AppIcon-VoIPKit</string>
<key>FIVKLocalizedName</key>
<string>VoIP-Kit</string>
<key>FIVKSupportVideo</key>
<true/>
<key>FIVKSkipRecallScreen</key>
<true/>
3. add New Image set for CallKit
  • Add an icon(.png or .pdf) ios/Runner/Assets.xcassets/AppIcon-VoIPKit to use on the screen when a call comes in while locked iPhone.
4. create VoIP Services Certificate
Create .p12 from .cer with KeyChainAccess
openssl pkcs12 -in voip_services.p12 -out voip_services.pem -nodes -clcerts

If you're running OpenSSL version 3 or later, please note that you may need to include the "-legacy" option.

openssl pkcs12 -legacy -in voip_services.p12 -out voip_services.pem -nodes -clcerts
5. request VoIP notification APNs from your server
  • See Apple document.
  • https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns
  • Add data(payload) like a below.
{
    "aps": {
        "alert": {
          "uuid": <Version 4 UUID (e.g.: https://www.uuidgenerator.net/version4) >,
          "incoming_caller_id": <your service user id>,
          "incoming_caller_name": <your service user name>,
        }
    }
}
  • You can use curl to test VoIP notifications as follows.
curl -v \
-d '{"aps":{"alert":{"uuid":"982cf533-7b1b-4cf6-a6e0-004aab68c503","incoming_caller_id":"0123456789","incoming_caller_name":"Tester"}}}' \
-H "apns-push-type: voip" \
-H "apns-expiration: 0" \
-H "apns-priority: 0" \
-H "apns-topic: <your app’s bundle ID>.voip" \
--http2 \
--cert ./voip_services.pem \
https://api.sandbox.push.apple.com/3/device/<VoIP device Token for your iPhone>

Try out example app

Select call role 🤙 Caller page 🔔 Callee page
🔔 Callee(incoming call) 🔔 Callee(locked) 🔔 Callee(locked) 🔔 Callee(recall)
🔔 Callee(unanswered local notification) 🔔 Callee(unanswered local notification)

Q&A

Does CallKit have a call and outgoing call screen?
  • No. CallKit support incoming call screen only. You need to make your own a call and outgoing call screens.
Can I use remote push device token instead of VoIP device token?
  • No. Since the specifications of VoIP token and push token are different, it is necessary to manage them separately in your database.
Can't get VoIP token on iOS13
  • Please uninstall the app, restart the terminal and reinstall the app. You can get it after a while.
Don't receive VoIP notifications
  • Please check the following items.
    1. Is the VoIP device token correct?
    2. Did you set your app’s bundle ID with .voip to apns-topic?
    3. Did you set voip to apns-push-type?
    4. Is the APNs endpoint(Development or Production) correct?
    5. For iOS13, VoIP notifications may not be received if call kit call fails many times. Please uninstall the app, restart the terminal and reinstall the app.
No icon is displayed on the incoming call screen when locked
  • The icon image should be a square with side length of 40 points. The color is ignored. Please design with the difference of alpha.
  • If created in PDF, checked Preserve Vector Data for Resizing and change Single Scale for Scales.
create icon (e.g.: sketch) Xcode Image Set

Reference

  • https://developer.apple.com/documentation/callkit
  • https://developer.apple.com/documentation/pushkit
  • https://developer.apple.com/documentation/callkit/making_and_receiving_voip_calls_with_callkit

所屬分類

原始碼儲存庫

使用此套件的專案

暫無相關資料。