iOS集成

前提条件

开发前的环境要求如下表所示，详情请参见：使用限制。

您需要集成并启动服务端，具体操作，请参见服务端集成。

Demo运行指引

1. 下载Demo并解压。
   解压成功之后如下图所示：

   说明

   • Demo源码中没有集成iOS AliRTC SDK，需要手动进行集成。
   • 源码压缩文件内分为Server端、Android端、iOS端三个文件。
   • 若遇到GitHub代码库下载缓慢的问题，可通过安装加速插件等方式加速下载。
2. 下载SDK并解压。
3. 打开终端，定位到Podfile文件所在的目录，执行pod install命令。
   安装成功如下图所示。安装后生成的Pods文件夹已在iOS目录下。
4. 替换SDK。
   将步骤二解压的AliRTCSdk.framework文件，替换掉步骤三安装后生成的Pods/AliRTCSdk/AliRTCSdk.framework文件。
5. 修改配置文件。
   1. 打开解压后的Demo文件夹alibabacloud-AliRtcAudioLiveRoom-Demo-master，找到iOS/RTCCommon/⁨AppConfig.h⁩文件。
   2. 修改文件中的kBaseUrl变量，如：http://<服务器IP> :8080/，部署到正式环境上建议绑定域名并使用：http://<域名>/。

      示例

      假设本地IP为192.0.2.1，那么kBaseUrl="http://192.0.2.1:8080/"。本地IP查询，请参见查询IP地址。

      

      注意

      • 不要使用127.0.0.1的IP。
      • 手机和搭建服务器的电脑处在一个局域网中。
   3. 使用手机和电脑的浏览器验证。
      输入正确的URL（http://<服务器IP> :8080/chatroom）地址，即可在浏览器中打开并看到：Hello RTC! 。电脑端浏览器正确访问说明IP和端口号无误，手机端浏览器正确访问说明目前手机可以正常访问到服务器IP。
6. 导入Demo源码。

   打开Xcode，单击Open a project or file，双击打开iOS目录下的RTCSolution.xcworkspace文件。

   
7. 选择运行Target为RTCSolution，将一台IOS真机设备使用数据线与电脑链接，在Xcode中选择相应的真机设备，真机在设置中打开开发者模式。（暂不支持模拟器运行）
   
8. 修改Bundle Identifier。
   注意 Bundle Identifier改成为com.<公司名>.<项目名>，避免由于Bundle已被注册从而运行失败。

   General选项卡中修改Bundle Identifier。

   

   Sign & Capabilities选项卡中修改Bundle Identifier。

   
9. 在Sign & Capabilities选项卡，勾选Automatically manage signing，在下方选择自己的Team。
   1. 选择Team。
      
   2. 若以前没添加过账号，单击Add an Account添加。
      
   3. 完成账号添加。
      
   4. 在Team里选择新创建的账号即可，并且在完成签名后确保下方没有报错提示。
10. 单击build and run按钮编译。
    
11. 加入语音聊天室。
    1. 将2台或2台以上真机移动端设备（Android或iOS）装上Demo App。
    2. 将设备都连接到同一局域网下，保证可以连接到Server端。
    3. 在第一台真机上输入任意房间号和昵称，选择角色进入语聊房并等待他人加入。
    4. 在其余真机上输入相同房间号和任意昵称（可同名，不做限制），选择角色加入房间并进行聊天。

Demo源码解析

1. 项目结构说明

   Demo是以cocoapods本地库的方式集成到项目中的。

   为了方便把语聊房的代码移植到您的项目中，我们把代码封装为名称为RTCAudioLiveRoom的本地库当中。

   您只需在Podfile中指定RTCAudioLiveRoom.podspec的路径即可。

   #基础组件 :path 的路径为podfile 和 RTCCommon.podspec 的相对路径
   pod 'RTCCommon', :path => 'RTCCommon/'
    
   #基础UI组件 :path 的路径为podfile 和 RTCCommonView.podspec 的相对路径 
   pod 'RTCCommonView', :path => 'RTCCommonView/'
    
   #语聊房 :path 的路径为podfile 和 RTCAudioLiveRoom.podspec 的相对路径
   pod 'RTCAudioLiveRoom', :path => 'RTCAudioLiveRoom/'

   
2. 接口与回调

   接口

   API	描述
   sharedInstance	获取单例对象
   destroySharedInstance	销毁实例对象
   login	加入频道
   logout	退出频道
   enterSeat	上麦
   leavelSeat	下麦
   renotifySeatsInfo	重新通过回调通知座位信息
   muteLocalMic	静音/取消静音
   muteAllRemoteAudioPlaying	关闭/开启远端声音
   startAudioAccompanyWithFile	播放背景音乐
   stopAudioAccompany	停止播放背景音乐
   setAudioAccompanyVolume	设置伴奏音量
   playEffectSoundtWithSoundId	播放音效
   stopAudioEffectWithSoundId	停止播放音效
   setAudioEffectPlayoutVolumeWithSoundId	设置音效的音量
   enableEarBack	设置耳返
   setAudioEffectReverbMode	设置混响模式
   setAudioEffectVoiceChangerMode	设置音效混响模式

   事件回调

   API	描述
   onEnterSeat	远端用户上麦通知
   onLeaveSeat	远端用户下线通知
   onRoomDestory	房间被销毁通知
   onSeatVolumeChanged	音量变化通知
   onSeatMutedChanged	静音/取消静音变化通知

   接口示例

   • 获取单例对象

     // 单例模式 初始化RTCAudioliveRoom
     RTCAudioliveRoom *manager = [RTCAudioliveRoom sharedInstance];
     //设置代理对象
     manager.delegate = vc

   • 销毁实例对象

     [self.manager destroySharedInstance];

   • 加入频道

     /// 加入频道
     /// @param channelId   频道名称
     /// @param name    任意用于显示的用户名称。不是User ID
     /// @param role   角色
     /// @param handler   回调
     
      [self.manager login:@"频道名称"
                        name:@"用户昵称"
                        role:@"角色"
                    complete:^(AliRtcAuthInfo * _Nonnull authInfo, NSInteger errorCode) {
             if (authInfo)
             {
                 //加入房间成功
                 // ....
                 return;
             }
             //加入房间失败
         }];

   • 退出频道

     [self.manager logout];

   • 上麦

     [self.manager enterSeat];

   • 下麦

     [self.manager leavelSeat];

   • 重新通过回调通知座位信息

     [self.manager renotifySeatsInfo];

   • 静音/取消静音

     //静音
     [self.manager muteLocalMic:YES];
     
     //取消静音
     [self.manager muteLocalMic:NO];

   • 关闭/开启远端声音

     //关闭远端声音
     [self.manager muteAllRemoteAudioPlaying:YES];
     
     //开启远端声音
     [self.manager muteAllRemoteAudioPlaying:NO];

   • 播放背景音乐

     /// 播放背景音乐
     /// @param filePath 文件路径
     /// @param publish 是否推送远端
     
     [self.manager startAudioAccompanyWithFile:@"文件url" publish:YES];

   • 停止播放背景音乐

     [self.manager stopAudioAccompany];

   • 设置伴奏音量

     /// 设置背景音乐音量
     /// @param volume 音量 0~100
     
     [self.manager setAudioAccompanyVolume:100];

   • 播放音效

     /// 播放音效
     /// @param soundId 音效id
     /// @param filePath 资源路径
     /// @param publish 是否推送远端
     
     [self.manager playEffectSoundtWithSoundId:111
                                   filePath:@"文件url"
                                   publish:YES];

   • 停止播放音效

     [self.manager stopAudioEffectWithSoundId:111];

   • 设置音效的音量

     [self.manager setAudioEffectPlayoutVolumeWithSoundId:111 volume:100];

   • 设置耳返

     //开启耳返
     [self.manager enableEarBack:YES]; 
     //关闭耳返
     [self.manager enableEarBack:NO];

   • 设置混响模式

     [self.manager setAudioEffectReverbMode:AliRtcAudioEffectReverb_Off];

   • 设置音效混响模式

     [self.manager setAudioEffectVoiceChangerMode:AliRtcAudioEffectvVoiceChanger_OFF];

   回调示例

   • 远端用户上麦通知

     /// 远端用户上麦通知
     /// @param seat 麦序
     - (void)onEnterSeat:(SeatInfo *)seat;

   • 远端用户下线通知

     /// 远端用户下线通知
     /// @param seat 麦序
     - (void)onLeaveSeat:(SeatInfo *)seat;

   • 房间被销毁通知

     /// 房间被销毁通知
     - (void)onRoomDestory;

   • 音量变化通知

     /// 音量变化通知
     /// @param seatIndex 麦序
     /// @param isSpeaking 是否在说话
     - (void)onSeatVolumeChanged:(NSInteger)seatIndex isSpeaking:(BOOL)isSpeaking;

   • 静音/取消静音变化通知

     /// 静音/取消静音变化通知
     /// @param seatIndex 麦序
     /// @param mute 是否静音
     - (void)onSeatMutedChanged:(NSInteger)seatIndex mute:(BOOL)mute;