Flutter集成Voximplant呼叫功能插件flutter_callkit_voximplant的使用

flutter_callkit_voximplant

Flutter SDK用于在iOS上将CallKit集成到Flutter应用程序中。

支持iOS >= 10。

我们写了一篇文章介绍这个插件 - “我们如何使Flutter与CallKit Call Directory协同工作”。 文章提供 英文 和 俄文 版本。

安装

1. 在pubspec.yaml文件中添加flutter_callkit_voximplant依赖。
2. 在<project root>/ios/Runner/Info.plist文件中添加以下条目，以确保CallKit正常工作：

   <key>UIBackgroundModes</key>
   <array>
     <string>voip</string>
   </array>
   

使用方法

SDK的API尽可能地接近iOS的CallKit框架。可以参考官方文档获取更多信息。以下是主要的不同点：

• 使用FlutterCallkitPlugin.sharedInstance.reportNewIncomingCallWithUUID:来报告通过VoIP推送通知接收到的新来电。
• 使用FlutterCallkitPlugin.sharedInstance.hasCallWithUUID:来检查CallKit是否已经有了给定UUID的通话。
• 使用FCXPlugin.didDisplayIncomingCall处理用reportNewIncomingCallWithUUID报告的来电。
• 使用FCXPlugin.logLevel调整日志级别。
• 使用FCXPlugin.processPushCompletion执行从推送接收的完成块（仅限iOS 11及以上）。
• FCXCallController和FCXProvider只能是单例模式。

注意：传递给FCXProvider的UUID将被CallKit转换为大写。

初始化

import 'package:flutter_callkit_voximplant/flutter_callkit_voximplant.dart';

// 初始化主插件类:
FCXPlugin _plugin = FCXPlugin();
// 初始化主CallKit类:
FCXProvider _provider = FCXProvider();
FCXCallController _callController = FCXCallController();

try {
  await _callController.configure();
  await _provider.configure(FCXProviderConfiguration('ExampleLocalizedName'));
} catch (_) {
  // 处理异常
}

拨打出站电话

Future<void> makeCall(String contactName, String uuid) async {
  FCXHandle handle = FCXHandle(FCXHandleType.Generic, contactName);
  FCXStartCallAction action = FCXStartCallAction(uuid, handle);
  await _callController.requestTransactionWithAction(action);
}

_provider.performStartCallAction = (startCallAction) async {
  // 配置音频会话
  await startCallAction.fulfill();
};

接收来电

Future<void> handleIncomingCall(String contactName, String uuid) async {
  FCXCallUpdate callUpdate = FCXCallUpdate(localizedCallerName: contactName);
  await _provider.reportNewIncomingCall(uuid, callUpdate);
}

_provider.performAnswerCallAction = (answerCallAction) async {
  // 配置音频会话
  await answerCallAction.fulfill();
};

处理推送通知

由于iOS 13对PushKit VoIP的限制，推送处理必须通过原生iOS代码进行。flutter_callkit_voximplant提供了内置的reportNewIncomingCallWithUUID:callUpdate:providerConfiguration:pushProcessingCompletion:方法来正确处理推送通知。

Swift示例

import Flutter
import flutter_callkit_voximplant
import PushKit
import CallKit

class AppDelegate: FlutterAppDelegate, PKPushRegistryDelegate {
    func pushRegistry(_ registry: PKPushRegistry,
                      didReceiveIncomingPushWith payload: PKPushPayload,
                      for type: PKPushType) {
        processPush(with: payload.dictionaryPayload, and: nil)
    }

    func pushRegistry(_ registry: PKPushRegistry,
                      didReceiveIncomingPushWith payload: PKPushPayload,
                      for type: PKPushType,
                      completion: @escaping () -> Void) {
        processPush(with: payload.dictionaryPayload, and: completion)
    }

    private func processPush(with payload: Dictionary<AnyHashable, Any>,
                             and completion: (() -> Void)?) {
        guard let uuidString = payload["UUID"] as? String,
            let uuid = UUID(uuidString: uuidString),
            let localizedName = payload["identifier"] as? String else {
                return
        }
        
        let callUpdate = CXCallUpdate()
        callUpdate.localizedCallerName = localizedName
        
        let configuration = CXProviderConfiguration(localizedName: "ExampleLocalizedName")
        
        FlutterCallkitPlugin.sharedInstance.reportNewIncomingCall(
            with: uuid,
            callUpdate: callUpdate,
            providerConfiguration: configuration,
            pushProcessingCompletion: completion
        )
    }
}

Objective-C 示例

#import <Flutter/Flutter.h>
#import <FlutterCallkitPlugin.h>
#import <PushKit/PushKit.h>
#import <CallKit/CallKit.h>

@interface AppDelegate : FlutterAppDelegate<PKPushRegistryDelegate>

@end

@implementation AppDelegate

- (void)pushRegistry:(PKPushRegistry *)registry
didReceiveIncomingPushWithPayload:(PKPushPayload *)payload
                          forType:(PKPushType)type {
    [self processPushWithPayload:payload.dictionaryPayload 
            andCompletionHandler:nil];
}

- (void)pushRegistry:(PKPushRegistry *)registry
didReceiveIncomingPushWithPayload:(PKPushPayload *)payload
                          forType:(PKPushType)type
            withCompletionHandler:(void (^)(void))completion {
    [self processPushWithPayload:payload.dictionaryPayload
            andCompletionHandler:completion];
}

-(void)processPushWithPayload:(NSDictionary *)payload
         andCompletionHandler:(dispatch_block_t)completion {
    NSUUID *UUID = [[NSUUID alloc] initWithUUIDString:payload[@"UUID"]];
    NSString *localizedName = payload[@"identifier"];
    
    CXCallUpdate *callUpdate = [CXCallUpdate new];
    callUpdate.localizedCallerName = localizedName;
    
    CXProviderConfiguration *configuration =
        [[CXProviderConfiguration alloc]
              initWithLocalizedName:@"ExampleLocalizedName"];
              
    [FlutterCallkitPlugin.sharedInstance reportNewIncomingCallWithUUID:UUID
                                                            callUpdate:callUpdate
                                                 providerConfiguration:configuration
                                              pushProcessingCompletion:completion];
}
@end

Call Blocking and Identification

应用程序可以通过创建Call Directory应用扩展来识别和阻止来电者。更多详细信息请参阅官方文档。

参考资料

• iOS CallKit Framework Documentation by Apple: Apple开发者文档

示例项目

查看完整的示例项目以了解如何实现上述功能，请访问GitHub仓库中的示例项目。

希望这些信息可以帮助您成功集成flutter_callkit_voximplant到您的Flutter项目中。如果您有任何问题或需要进一步的帮助，请随时提问！