搜索插件、代码仓与 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

所属分类

源码仓库

使用此插件的项目

暂无相关数据。