iOS实现自定义铃声(从VoIP到NSE)

一、背景

2018年,受通信监管要求,苹果国区AppStore不允许app支持CallKit。
2019年,随着iOS 13正式开放, Xcode11随之发布,苹果已不再允许将PushKit应用在非VoIP语音通话的场景上,开发者必须在接入CallKit的情况下才能使用PushKit。也就是说,通过 Xcode 11 编译的 iOS 13 系统 App,如果使用 PushKit 则必须依赖苹果 CallKit 才能正常接收VoIP推送。
结论:使用VoIP功能则无法在中国区App Store上架。

二、技术方案

VoIP

以微聊音视频铃声播放为例,在之前的方案中,微聊音视频消息会使用VoIP Push Notification,客户端在被唤醒之后将获得30s的后台运行时间,在这30s内,微聊被唤醒调起音视频页面,并播放定制铃声音频。

Notification Service Extension

新的方案是主要是利用了苹果在iOS10中推出的Notification Service Extension(以下简称NSE),当apns的payload上带上"mutable-content"的值为1时,就会进入NSE的代码中。与Voip方案最大的不同之处是,NSE不能唤醒主应用,也不能访问主应用的文件空间,只能在Extension进程中处理相应的逻辑。在NSE中,开发者可以更改通知的内容,利用离线合成或者从后台下载的方式,生成需要播报的内容,通过自定义通知铃声的方式,达到语音播报提醒的目的。NSE方案也是苹果在WWDC2019的Session707上推荐的解决方式。


消息推送流程
UNNotificationSound

在NSE中,可以通过给UNNotificationContent中的Sound属性赋值来达到在通知弹出时播放一段自定义音频的目的。

// The sound file to be played for the notification. The sound must be in the Library/Sounds folder of the app's data container or the Library/Sounds folder of an app group data container. If the file is not found in a container, the system will look in the app's bundle.
文档中明确描述了音频文件的存储路径,以及读取的优先级:

1.主应用中的Library/Sounds文件夹中
2.AppGroups共享目录中的Library/Sounds文件夹中
3.main bundle中

自定义铃声支持的声音格式包括,aiff、wav以及caf格式,铃声的长度必须小于30s,否则系统会播放默认的铃声。
锁屏情况下,铃声可以持续30s(与NES强制结束时间一致)在亮屏情况下铃声只能持续5s,是系统行为限制。
而且由于是通知铃声,声音是默认跟静音开关的。

AppGroups

由于我们是在NSE中自定义铃声,所以1和3这两个文件路径我们是无法访问的。只能将合成好或者下载到语音音频文件存储到AppGroups下的Library/Sounds文件夹中,需要在Capablities中打开这个AppGroups的能力,即可通过NSFileManager的containerURLForSecurityApplicationGroupIdentifier:方法访问AppGroups的根目录。

示例代码:
    NSFileManager *fileManager = [NSFileManager defaultManager];
    NSURL *containerUrl = [fileManager containerURLForSecurityApplicationGroupIdentifier:@"group.com.wchat.share"];
    
    NSString *newPath = [containerUrl.path stringByAppendingPathComponent:@"Library/Sounds"];
    // 清理本地缓存,删除sounds文件夹(可选)
    [fileManager removeItemAtPath:newPath error:nil];
    
    if (![fileManager fileExistsAtPath:newPath]) {
        [fileManager createDirectoryAtPath:newPath withIntermediateDirectories:NO attributes:nil error:nil];
    }
    NSURL *localURL = [NSURL fileURLWithPath:[newPath stringByAppendingPathComponent:[NSString stringWithFormat:@"/%@.%@", identifier, fileType]]];
    [fileManager moveItemAtURL:temporaryFileLocation toURL:localURL error:&error];

    //设置播发音频 文件名sname.sfileType
    self.bestAttemptContent.sound = [UNNotificationSound soundNamed:[NSString stringWithFormat:@"%@.%@", sname, sfileType]];

三、开发过程中遇到的问题

消息播放队列

NSE方案有个问题是:当客户端短时间内收到多条播报通知时,后面的通知会顶掉前面的通知,导致前面的通知播报不完整。所以需要增加一个消息队列,将所有需要播报的通知都添加到队列中,当前面的消息播放完毕后,再播放后面的消息。

多线程问题

要注意的是,NSE的代码逻辑并不是在主App工程中执行的。一方面避免了开发者在NSE由于代码设计失误导致前台的其他应用界面卡住的问题,另一方面是主工程此时已被挂起或者已被kill掉,NSE本质是push部分而不是调起主App。
所以我们在处理上面提到的消息播放队列,以及涉及到文件读写的逻辑上,需要给相应的代码逻辑加锁,否则会出现多线程问题。

四、NSE扩展

iOS Notification Service Extension 共享空间数据互通测试

五、相关资料

Advances in App Background Execution - 2019
UNNotificationServiceExtension

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,384评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,845评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,148评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,640评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,731评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,712评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,703评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,473评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,915评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,227评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,384评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,063评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,706评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,302评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,531评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,321评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,248评论 2 352

推荐阅读更多精彩内容