1.介绍
Audiobus是一个独立应用,也是一个API可以让其它开发者将该功能 内嵌到自己的应用里。Audiobus允许在各个应用之间传输实时的音频流,可以让你好像在使用自己工作室里的设备那样来用各个iOS应用,该Audiobus SDK提供了所有你需要让你的应用程序兼容Audiobus。它的设计是非常容易使用:根据您的应用程序,你花几个小时就能将Audiobus运行的很好。
SDK包含以下内容:
- Audiobus静态库和头文件
- 一个有很多可以直接运行例子的Xcode项目
- README文件
2.将Audiobus SDK添加到你的项目中
Audiobus以静态库的形式发布,包含着相关的头文件。
使用CocoaPods:
1.将"pod 'Audiobus'"添加到Podfile文件中,如果你没有这个文件,在项目的顶级文件夹中,创建一个名为 "Podfile" 的文件,里面的内容如下:
pod 'Audiobus'
2.在终端的包含Podfile文件的目录下,键入:
pod install
之后需要更新时键入 pod update
手动导入:
将libAudiobus.a和相关的头文件拖进你的项目。确保你的项目target被选中。 注明一点这将会更改你的app的 "Header Search Paths" 和 "Library Search Paths" 设置。
添加下列框架:
- AVFoundation
- CoreGraphics
- Accelerate
- AudioToolbox
- QuartzCore
- Security
注明一点,由于技术原因Audiobus SDK仅支持iOS 8.0及以上。
3. 启用后台音频和跨应用音频
如果你还没有这样做的话,你必须启用后台音频和跨应用音频输入您的应用程序。
要启用这些:
- 选中你项目的"TARGETS" 。
- 选中 "Capabilities"标签。
- 在"Background Modes"一栏下勾选上"Audio and AirPlay"。
- 打开"Inter-App Audio"一栏的开关,这一操作将会让Xcode去更新你的 "Certificates, Identifiers & Profiles", 并创建或更新Entitlements文件。
管理你应用程序的生命周期
如果你有一个运行的、活跃的音频系统,您的应用程序将只在后台继续 。 这意味着,如果你停止你的音频系统,而你的应用程序在后台或移动到后台,您的应用程序将停止运行,并会不响应Audiobus。
首先,一旦您的应用程序是通过Audiobus连接,你必须确保你有一个运行和活跃的音频会话,无论您的应用程序出在什么状态。你可以通过下面两种方式实现:
- 只要你的音频系统在运行中,确保只初始化 Audiobus controller (Step 7) 一次。
- 注册 ABConnectionsChangedNotification通知 (或者 ABAudiobusController的connected属性的观者者),如果Audiobus controller 已连接,开启你的audio引擎。
如果没有正确地执行上两步操作,在Audiobus连接完成之前你的app将在后台暂停 , 它无法与Audiobus工作。
其次,当app在某些情形下进入后台时,你可能需要暂停应用程序(通过停止音频系统)。例如,你可能有一个“后台运行”的设置,用户可以禁用,或者你可以一直暂停您的应用程序如果应用程序是空闲的。
这很好 - 事实上,我们建议您在默认情况下这样做,以避免用户在不知情的情况下让他们的设备超载。
如果你的Audiobus controller的 connected property设置为YES,你在任何情况下也不能暂停你的app,因为这会让Audiobus停止和你app之间的工作。
我们强烈建议在使用Audiobus时采用下面这些后台策略。
- 当你的app进入后台时,(a)如果当前没有和别的app音频或Audiobus连接,你应该通过设置 ABAudiobusController的connected 属性去停止你的audio引擎。
(b)如果你不是活动中的Audiobus会话的一部分(前提是你的app已经使用了Audiobus并且Audiobus一直处在运行状态),可以设置memberOfActiveAudiobusSession属性。例如:
-(void)applicationDidEnterBackground:(NSNotification *)notification {
if ( !_audiobusController.connected && !_audiobusController.memberOfActiveAudiobusSession ) {
// Fade out and stop the audio engine, suspending the app, if we're not connected, and we're not part of an active Audiobus session
[ABAudioUnitFader fadeOutAudioUnit:_audioEngine.audioUnit
completionBlock:^{
[_audioEngine stop];
}];
}
}
- 如果你的app已经与正在运行的Audiobus连接,当app进入后台时它应该继续保持活跃。当与Audiobus断开连接或者Audiobus停止,app也应该暂停。通过观察下面两个属性,一旦两者都变为NO,就可以停止你的audio引擎:
static void * kAudiobusConnectedOrActiveMemberChanged = &kAudiobusConnectedOrActiveMemberChanged;
// Watch the connected and memberOfActiveAudiobusSession properties
[_audiobusController addObserver:self
forKeyPath:@"connected"
options:0
context:kAudiobusConnectedOrActiveMemberChanged];
[_audiobusController addObserver:self
forKeyPath:@"memberOfActiveAudiobusSession"
options:0
context:kAudiobusConnectedOrActiveMemberChanged];
-(void)observeValueForKeyPath:(NSString *)keyPath
ofObject:(id)object
change:(NSDictionary *)change
context:(void *)context {
if ( context == kAudiobusConnectedOrActiveMemberChanged ) {
if ( [UIApplication sharedApplication].applicationState == UIApplicationStateBackground
&& !_audiobusController.connected
&& !_audiobusController.memberOfActiveAudiobusSession ) {
// Audiobus session is finished. Time to sleep.
[_audioEngine stop];
}
} else {
[super observeValueForKeyPath:keyPath ofObject:object change:change context:context];
}
}
- 当你的引用从后台激活,开启audio引擎
-(void)applicationWillEnterForeground:(NSNotification *)notification {
if ( !_audioEngine.running ) {
// Start the audio system if it wasn't running
[_audioEngine start];
}
}
需要注意的是,在开发期间如果你没有在Audiobus中注册你的app(setp5),Audiobus只能在它运行时看到你的app,因此,我们强烈建议在开始测试之前注册你的应用程序。
4.设置Launch URL
Audiobus 需要一个URL(像YourApp-1.0.audiobus://这样)用来启动和切换你的app,同时用这个URL判断系统是否已经安装过你的app。
这个URL scheme需要以“.audiobus”结尾,为了保证使用Audiobus的这个app URLs是独一无二的。你的app不同的版本对应的这个URL也应该是唯一的,这样当你添加Audiobus新功能时,可以区分app的版本,这点是非常重要的。
下面看看如何给你的app添加新的URL scheme。
- 在Xcode中选中你"TARGETS" 下的项目。
- 选中"info"标签。
- 在底部打开“URL types”分组。
- 如果你第一次创建URL type,点击“加号”。然后输入URL的唯一标识符(一般是你公司域名的倒置)。
- 如果已经存在一个定义你app的URL scheme,在最后一个scheme后面添加一个逗号和空格(“, ”),再输入新的scheme(提示:逗号后面的空格很重要)。
6 .输入新的Audiobus URL scheme,注意不要包含"://" 字符。
5.注册你的应用并生成API key
Audiobus有一张注册表,其中列举了已经安装的的能够与Audiobus兼容的app。这会让Audiobus发现那些在后台的app。用户能够根据这张注册表知道哪些软件支持Audiobus。
在Audiobus app registration page注册你的app并获取API key。
你需要提供app的详细信息,通过拷贝一份一边以德info.plist文件,Audiobus会用该文件填充所需的字段,直到你的app上线前你都可以修改这些信息。
重要的提示:你必须提供已编译版本的info.plist文件,而不是你项目文件的那个。你可以在编译你的应用程序后,打开项目文件“Products”目录,在你的xx.app上点击鼠标右键,右击"Show in Finder",然后在你的app bundle上点击右键选中"Show Package Contents",在文件夹里找到info.plist文件。
在你注册你的应用之后,我们会简略地检查你的应用程序,在审核通过后,我们将会发邮件通知你,邮件中会包含你的Audiobus API key,我们会把你的app加在Audiobus注册表中。
你可以通过访问https://developer.audiob.us/apps 查看你的API key。在app详情页的顶部就是。
API key 是一个你使用Audiobus SDK时提供的字符串。每个app的版本都有一个独特的API key,它和bundle name、启动URL绑定。为了提供自动纠错功能,在SDK初始化时和无网络情况下会去检查这个key。
重要的提示:你注册了应用后它并不会出现在我们官网的“Apps”列表里,而是包含在一个XML文件里,这个文件能够告诉下载Audiobus的用户他们安装的哪些app支持Audiobus。
这并不会让你的app出现在Audiobus的app列表中,因为你选择了一个新的、独一无二的URL,但会从XML文件中读取到。
Audiobus app从我们的服务器每30分钟下载并更新一次注册表,所以一旦我们批准你的申请,我们建议您重新安装Audiobus迫使它立即更新,这样你可以开始工作。
重要的提示:为了使您的应用程序出现在Audiobus网站或在应用程序兼容的应用程序目录中,这样可以给Audiobus用户购买您的应用程序的能力,你需要让你的应用程序被激活。只有当你的应用程序的Audiobus兼容版本上线App Store,才能这样做,以免混淆用户。
当你在此基础上进一步开发你的app时,我们建议您注册应用程序的新版本以便于与Audiobus的新功能兼容,如添加新的端口或执行功能的保存状态。这将允许Audiobus在你的新版本中投放新功能的广告,提高你的销售,您的应用程序会出现在我们的兼容的应用程序列表里。您可以通过点击“添加版本”在您的应用程序页面上注册新版本。
6.开启混合音频和其他app链接
当你在iOS上使用音频时,你用到的audio session分类有以下两个,AVAudioSessionCategoryPlayAndRecord或者AVAudioSessionCategoryPlayback。
默认情况下,当你的程序一开始运行音频流时,如果有其他程序正在运行音频流,上面的两个分类会导致iOS系统中断其他音频流,迫使别的app暂停运行。
若果你正在使用PlayAndRecord或者MediaPlayback,为了使用Audiobus你需要重写默认的分类,告诉iOS允许其他app同时输出音频流。
要做到这一点,你需要设置AVAudioSessionCategoryOptionMixWithOthers标记,如下:
NSString *category = AVAudioSessionCategoryPlayAndRecord;
AVAudioSessionCategoryOptions options = AVAudioSessionCategoryOptionMixWithOthers;
NSError *error = nil;
if ( ![[AVAudioSession sharedInstance] setCategory:category withOptions:options error:&error] ) {
NSLog(@"Couldn't set audio session category: %@", error);
}
7.实例化Audiobus控制器
接下来,你需要创建一个strong类型的Audiobus控制器属性。
第一,导入Audiobus头文件:
#import "[Audiobus.h](https://developer.audiob.us/doc/_audiobus_8h.html)"
第二,在类扩展里声明属性:
@interface MyAppDelegate ()
@property (strong, nonatomic) [ABAudiobusController](https://developer.audiob.us/doc/interface_a_b_audiobus_controller.html) *audiobusController;
@end
现在,你可以创建Audiobus控制器的实例,但有三个需要注意的地方:
第一:在你初始化Audiobus的同时需要启动你的音频系统,否则你需要监听 ABConnectionsChangedNotification通知,等接收到该通知的时候再启动音频系统。这是因为一旦你的app连接到Audiobus,你的app需要有一个正在运行并被激活的音频系统,否则在Audiobus和你的app链接完成之前,由于资源竞争会让app进入后台时暂停。
第二:你必须在主线程初始化Audiobus控制器,否则会引发断言。
第三:不要在初始化Audiobus控制器后阻塞主线程。
重要的提示:尽可能早的在app一启动的时候就初始化ABAudiobusController,并且让它的生命周期和app同步。如果你释放并重新创建一个新的ABAudiobusController实例,你会看到一些奇怪的现象,比如你的app和Audiobus连接失败。
创建ABAudiobusController实例,将你在第五步注册的APIkey传入:
self.audiobusController = [[[ABAudiobusController](https://developer.audiob.us/doc/interface_a_b_audiobus_controller.html) alloc] initWithApiKey:@"YOUR-API-KEY"];
初始化完毕后,Audiobus会在你的app上显示连接面板。
默认的连接面板会出现在屏幕的右边。你可以通过下面的方法设置它的位置:
self.audiobusController.connectionPanelPosition = [ABConnectionPanelPositionLeft](https://developer.audiob.us/doc/_a_b_common_8h.html#a1595aa3959ac313aa3520aac85c447a9a3aab79666dca20f905d1cd109a91c0ae);
8.创建端口
现在。你已经准备好创建Audiobus的端口了。
你可以创建很多你喜欢的端口。例如,多轨录音机可以提供每声道输出,我们很乐意为用户提供端口,为了达到最大的灵活性,例如per-track路由这种。来看一个使用多重端口的例子。
注意你应该在应用程序启动时创建所有的端口,不管你是否打算直接使用它们,否则会看到一些奇怪的现象。如果你不使用它们,就让它们保持沉默状态(或静止,不调用接收/发送函数)。