5分钟快速集成UCloud实时音视频服务URTC-iOS端

摘要：通过集成，可以从零开始，快速搭建出实时音视频通信平台，可以应用于语音和视频社交在线教育和培训远程医疗在线会议直播等多种业务场景。使用服务之前，首先需要注册账号并且完成实名认证。确定后，自动生成。通过集成，可以快速实现实时音视频通话。

通过集成URTC SDK，可以从零开始，快速搭建出实时音视频通信平台，可以应用于语音和视频社交、在线教育和培训、远程医疗、在线会议、直播等多种业务场景。

集成URTC SDK之前，需要在UCLOUD官网控制台创建URTC应用。

1． 登录UCLOUD控制台

在UCLOUD官网，【登录控制台】。

使用URTC服务之前，首先需要注册账号 并且完成 实名认证 。

2．创建URTC应用

每个账号最大支持创建5个URTC应用，需要创建更多URTC应用，请联系客户经理增加配额。

可以通过2种方法：控制台、API创建URTC应用。

2.1 控制台创建URTC应用

• 在控制台，【全部产品】-【视频服务】-【实时音视频】，找到【我的应用】

• 点击创建应用，输入应用名称，确定后保存。

• 确定后，自动生成AppID、AppKey。

• 绑定AppID及AppKey到您的应用中即可开始使用。

2.2 API创建URTC应用

通过 创建URTC 应用的API，也可以创建URTC应用。具体调用API的方法，请查看API文档。
通过集成SDK，可以快速实现实时音视频通话。

3. 下载资源

• 可以下载 Demo、SDK、API文档
  现在下载

4. 开发语言以及系统要求

• 支持语言：objective-c、swift;
• Apple设备：iPhone最低支持iPhone5；
• 系统版本：最低支持iOS 9.0；
• CPU架构：支持真机架构arm64，不支持模拟器i386、 x86架构；
• 其他：不支持bitcode。

5. 开发环境

• Xcode 9.0及以上版本；
• Apple开发证书或个人账号；

6. 搭建开发环境

6.1 得到动态库

下载SDK,得到的UCloudRtcSdk_ios.framework为动态库；

6.2 创建新的工程

使用XCode创建一个新的工程UCloudRtcSdk-ios-demo；

6.3 加入动态库带工程中

将已下载的动态库UCloudRtcSdk_ios.framework加入到UCloudRtcSdk-ios-demo工程中Embedded Binaries；

6.4 打开Xcode

打开Xcode，选择：项目TARGET ->General->Deployment Target，设置8.0或以上版本；

6.5 使用动态库不需要添加其他库依赖

6.6 关闭Bitcode（目前SDK版本不支持Bitcode）

6.7 编辑info.plist，申请摄像头、麦克风权限

Privacy - Camera Usage Description
Privacy - Microphone Usage Description

6.8 打开后台音频权限

为保障APP退入手机后台之后，通话可以保持不中断，建议开启后台音频权限，SDK默认进入后台之后继续推送音频流。

6.9 集成成功

按照上述步骤完成UCloudRtcSdk-ios-demo的前期SDK集成准备之后，请使用Xcode连接iPhone真机，在真机调试环境下，执行编译Commond + B，提示Build Success，表示SDK集成成功。

7. 初始化

建议在初始化 App 的同时，初始化 SDK。

7.1 导入 SDK 头文件

import UCloudRtcSdk_ios

7.2 设置 userId 和 roomId，获取AppID;

UCloudRtcEngine *engine = [[UCloudRtcEngine alloc] initWithUserId:userId  appId:appId roomId:roomId appKey:appKey token:token]];

UCloudRtcEngine *engine = UCloudRtcEngine.init(userId:userId, appId: appId, roomId:roomId , appKey: appKey, token:token)

务必要设置代理对象，并实现代理回调方法，设置代理对象失败，会导致 App 收不到相关回调。

engine.delegate = self;

self.engine?.delegate = self

7.3 配置参数

使用之前需要对SDK进行相关设置，如果不设置，系统将会采用默认值。
初始化完成后，即可调用 SDK 相关接口，实现对应功能。

    self.engine.isAutoPublish = YES;//加入房间后将自动发布本地音视频 默认为YES
    self.engine.isAutoSubscribe = YES;//加入房间后将自动订阅远端音视频 默认为YES
    self.engine.isOnlyAudio = NO;//将启用纯音频模式 默认为NO
    self.engine.isDebug = NO;//是否开启日志
    self.engine.videoProfile = UCloudRtcEngine_VideoProfile_360P_1;//设置视频分辨率
    self.engine.streamProfile = UCloudRtcEngine_StreamProfileAll;//设置流权限

    self.engine?.isAutoPublish = ture;//加入房间后将自动发布本地音视频 默认为ture
    self.engine?.isAutoSubscribe = ture;//加入房间后将自动订阅远端音视频 默认为ture
    self.engine?.isOnlyAudio = false;//将启用纯音频模式 默认为false
    self.engine?.isDebug = false;//是否开启日志
    self.engine?.videoProfile = ._VideoProfile_360P_1;//设置视频分辨率
    self.engine?.streamProfile = .streamProfileAll;//设置流权限

8. 实现音视频通话

8.1 加入房间

[self.engine joinRoomWithcompletionHandler:^(NSData *data, NSUrlResponse *response, NSError error) {
    }];

self.engine?.joinRoomWithcompletionHandler({(data, response, error) -> Void in})

8.2 发布本地流

1）自动发布模式下，joinRoom成功后，即可发布本地流，无需再次调用publish接口；
2）手动发布模式下，joinRoom成功后，可通过下述接口发布本地流；

[self.engine publish];

self.engine?.publish()

3）发布过程中可以监听以下事件获取发布状态，根据状态调用渲染或其他接口即可。

        - (void)uCloudRtcEngine:(UCloudRtcEngine *)manager didChangePublishState:(UCloudRtcEnginePublishState)publishState {
            switch (publishState) {
                        case UCloudRtcEnginePublishStateUnPublish:
                            self.isConnected = NO;
                        break;
                        case UCloudRtcEnginePublishStatePublishing: {
                            [self.bottomButton setTitle:@"正在发布..." forState:UIControlStateNormal];
                        }
                        break;
                        case UCloudRtcEnginePublishStatePublishSucceed:{
                            self.isConnected = YES;
                            [self.view makeToast:@"发布成功" duration:1.5 position:CSToastPositionCenter];
                            [self.bottomButton setTitle:@"发布成功" forState:UIControlStateNormal];
                        }
                        break;
                        case UCloudRtcEnginePublishStateRepublishing: {
                            [self.bottomButton setTitle:@"正在重新发布..." forState:UIControlStateNormal];
                        }
                        break;
                        case UCloudRtcEnginePublishStatePublishFailed: {
                        self.isConnected = NO;
                            [self.bottomButton setTitle:@"开始发布" forState:UIControlStateNormal];
                        }
                        break;
                        case UCloudRtcEnginePublishStatePublishStoped: {
                        self.isConnected = NO;
                            [self.view makeToast:@"发布已停止" duration:1.5 position:CSToastPositionCenter];
                            [self.bottomButton setTitle:@"开始发布" forState:UIControlStateNormal];
                        }
                        break;
                        default:
                        break;
                    }                               
                }

        func uCloudRtcEngine(_ manager: UCloudRtcEngine, didChange publishState: UCloudRtcEnginePublishState) {
            switch publishState {
                case .unPublish:
                    self.isConnected = false
                case .publishing:
                    CBToast.showToastAction(message: "正在发布...")
                case .publishSucceed:
                    CBToast.showToastAction(message: "发布成功")
                    self.isConnected = true;
                    self.bottomButton?.setTitle("发布成功", for: .normal)
                case .republishing:
                    self.bottomButton?.setTitle("正在重新发布...", for: .normal)
                case .publishFailed:
                    self.isConnected = false;
                    CBToast.showToastAction(message: "开始发布")
                case .publishStoped:
                    self.isConnected = false;
                    CBToast.showToastAction(message: "发布已停止")
                    self.bottomButton?.setTitle("开始发布", for: .normal)
                default:
                break
            }
        }

8.3 取消发布本地流

[self.engine unPublish];

self.engine?.unPublish()

8.4 订阅远端流

1）自动订阅模式下，joinRoom成功后，即可订阅远程流，无需再次调用subscribeMethod接口；
2）手动订阅模式下，joinRoom成功后，可通过下述接口订阅远程流；

[self.engine subscribeMethod:remoteStream];

self.engine?.subscribeMethod(remoteStream)

3）订阅成功，在回调事件中调用渲染接口即可。

        -(void)uCloudRtcEngine:(UCloudRtcEngine *)channel didSubscribe:(UCloudRtcStream *)stream{
            [self reloadVideos];
        }

        func uCloudRtcEngine(_ channel: UCloudRtcEngine, didSubscribe stream: UCloudRtcStream) {
            self.reloadVideos()
        }
}

8.5 取消订阅远端流

[self.engine unSubscribeMethod:remoteStream];

self.engine?.unSubscribeMethod(remoteStream)

8.6 离开房间

[self.engine leaveRoom];   
    

self.engine?.leaveRoom()

8.7 编译、运行，开始体验吧！