实现视频通话

本文档为您展示通过 SDK 实现视频通过（访客侧）的相关步骤，帮助您在远程银行和视频客服的场景下实现智能排队、屏幕共享、全景录像、访客管理的相关能力。

1. 前提条件

请确认您已完成以下操作：

• 已获取 App Key。

AppKey 作为同个环境的分域依据，同一个域的终端才能实现互通，AppKey 由 Juphoon 视频平台提供。

TIP

请扫描下方二维码联系 Juphoon 市场售前工程师获取 AppKey。

• 集成 SDK（iOS）。

  TIP

  如需集成指导，请扫描上方二维码联系 Juphoon 市场售前工程师获取相关咨询。

2. 快速跑通Sample

1. 在 Juphoon RTC SDK 文档中心**，iOS 平台**下载体验 JCCSample 示例项目。

访问下载地址 (opens new window)，示例如下：

2. 下载完成后，安装 Juphoon_Rtc_Sample_for_iOS_R22C03_CallCenter 目录下的 JCCSample.ipa。

3. 打开应用程序后，设置合适的 Appkey，即可体验 Sample 的功能。

4. 操作步骤：

   a. 确认 AppKey 的正确性，输入账号，密码，服务器地址等信息；

   b. 点击登录按钮，待 登录 按钮变为 "登出" 时表示已经成功登录；

   c. 点击访客的右上角 进入 按钮，选择访客即可体验访客相关的功能。

   d. 进行访客相关的业务功能，填写正确的呼叫号码，可选择进行业务组号呼叫或者点对点座席呼叫。呼叫成功，并且座席接听，界面上就会有本地和远端视频画面的出现。

3. 实现视频通话

初始化 SDK

注：我们所有的方法都建议在主线程调用，否则可能会出现异常无法正常使用，回调接口也都在主线程上报。

初始化 JRTCSDK 需要创建 JRTCClient (opens new window)，JRTCMediaDevice (opens new window)，JRTCGuest (opens new window)的实例。

JRTCClient (opens new window)	登录模块	负责视频平台的登录登出，只有登录到视频平台才可以使用视频相关的业务
JRTCMediaDevice (opens new window)	媒体模块	负责本地的媒体设备操作，视频画面渲染等功能
JRTCGuest (opens new window)	访客模块	负责访客的视频业务的处理，比如发起呼叫，控制音视频流等

AppKey 作为同个环境的分域依据，同一个域的终端才能实现互通，AppKey 由 Juphoon RTC 平台提供。

在使用业务接口前，需对 Juphoon RTC SDK 进行初始化操作。

注：Guest 访客模块和Agent座席模块只支持初始化一个，否则会出现接收不到呼叫，接收不到邀请等现象影响正常的业务流程。

初始化参数详见 JRTCClientInitParam (opens new window) 。

示例代码：

@interface JCManager () <JRTCClientCallback, JRTCMediaDeviceCallback, JRTCGuestCallback>

- (void)initSDK {
	// 创建初始化参数
    JRTCClientInitParam *param = [[JRTCClientInitParam alloc] init];
    // 设置appkey
    param.appKey = @"AppKey"; 
    // 设置接入服务器地址
    param.server = @"Server"; 
    // 设置应用名
    param.appName = @"AppName";
    // 创建 JRTCClient 对象
    _client = [JRTCClient create:self initParam:param];
    // 创建 JRTCMediaDevice 对象
    _mediaDevice = [JRTCMediaDevice create:_client callback:self];
    // 创建 JRTCGuest 对象
    _guest = [JRTCGuest create:_client mediaDevice:_mediaDevice callback:self]; 
}

@end

然后根据需求实现 callback 的接口即可。

登录

SDK 初始化之后，即可进行登录的集成，登录接口调用流程如下所示：

登录到 Juphoon 视频平台主要调用的是 JRTCClient 的登录接口 login (opens new window) ：

/**
 * 登录 Juphoon RTC 平台，只有登录成功后才能进行平台上的各种业务
 * 登录结果通过 {@link JRTCClientCallback.onLogin:reason: onLogin} 回调通知
 *
 * @param userId 用户ID
 * @param password 密码，不能为空
 * @return 接口调用结果
 * - true: 接口调用成功
 * - false: 接口调用异常
 * @warning 目前只支持免鉴权模式，服务器不校验账号密码，免鉴权模式下当账号不存在时会自动去创建该账号
 * @warning 用户名为英文数字和'+' '-' '_' '.'，长度不要超过64字符，'-' '_' '.'不能作为第一个字符
 */
- (bool)login:(NSString* _Nonnull)userId password:(NSString* _Nonnull)password;

/**
 * 登录 Juphoon RTC 平台，只有登录成功后才能进行平台上的各种业务
 * 登录结果通过 {@link JRTCClientCallback.onLogin:reason: onLogin} 回调通知
 *
 * @param userId 用户ID
 * @param password 密码，不能为空
 * @param loginParam      登录参数，一般不需要设置，如需设置请询问客服，传 nil 则按默认值，详见 @ref JRTCClientLoginParam
 * @return 接口调用结果
 * - true: 接口调用成功
 * - false: 接口调用异常
 * @warning 目前只支持免鉴权模式，服务器不校验账号密码，免鉴权模式下当账号不存在时会自动去创建该账号
 * @warning 用户名为英文数字和'+' '-' '_' '.'，长度不要超过64字符，'-' '_' '.'不能作为第一个字符
 */
- (bool)login:(NSString* _Nonnull)userId password:(NSString* _Nonnull)password loginParam:(JRTCClientLoginParam* _Nullable)loginParam;

/**
 * 重登录，该接口在如果有其他同类型终端登录着则会登录失败，一般用于记住了账号后重启自动登录逻辑
 * @param password 密码，不能为空
 * @return 接口调用结果
 * - true: 接口调用成功
 * - false: 接口调用异常
 */
- (bool)relogin:(NSString* _Nonnull)userId password:(NSString* _Nonnull)password;

JRTCClientLoginParam (opens new window) 参数介绍

accelerateKey	加速云KEY
accelerateKeySecret	加速云KEY密钥
accountEntry	账户分录参数，如果支持国密S3则需要设置 certificate 参数，否则可以不设置 certificate 参数
certificate	S3 国密证书 Base64 编码内容
autoCreateAccount	是否自动创建账号（免鉴权使用），默认true
deviceId	设备id
token	token
tokenType	token 校验类型
tokenExtraParam	token 校验拓展参数
logFilter	日志过滤标签（用于日志管理平台过滤终端日志使用）
terminalType	终端登录类型，支持多终端登录，默认所有终端相同会导致互踢
optimizeDataRouter	是否开启数据路由优化，默认true

登录的结果将会通过 JRTCClientCallback (opens new window) 中的 onLogin (opens new window) 接口上报。

/**
 * 登录结果回调
 * @param result true 表示登录成功，false 表示登录失败
 * @param reason 当 result 为 false 时该值有效
 */
- (void)onLogin:(bool)result reason:(ReasonCode)reason;

示例代码：

// 创建登录配置参数
JRTCClientLoginParam *loginParam = [[JRTCClientLoginParam alloc] init];
// 登录
[_client login:@"6666" password:@"123456" loginParam:loginParam];

// 登录结果回调
- (void)onLogin:(bool)result reason:(ReasonCode)reason {
 	if (result) {
     	// 登录成功   
    } else {
    	// 登录失败，具体原因查询 reason 错误码
    }
}

获取业务号列表

在发起呼叫前，可以先调用 queryAllGroups (opens new window) 接口获取业务号、业务描述等详细信息；业务号一般由业务管理人员在业务管理平台上配置业务，然后将业务号给开发人员，或者也可以通过该接口查询到所有的业务号列表进行业务。

/**
 * 获取业务号列表
 *
 * @return 接口调用结果
 * - true: 接口调用成功，查询结果通过 {@link JRTCGuestCallback.onGetAllGroups:result: onGetAllGroups} 回调上报
 * - false: 接口调用异常
 */
- (bool)queryAllGroups;

获取结果通过实现 JRTCGuestCallback (opens new window) 中的 onGetAllGroups (opens new window) 接口获取。

/**
 * 获取业务号列表结果回调
 *
 * 访客调用 {@link JRTCGuest.queryAllGroups queryAllGroups} 接口获取业务号列表，会收到此回调。
 * @param groups 座席业务实体对象列表，获取失败时为 nil
 * @param result 获取结果，true 表示获取成功，false 表示获取失败
 */
- (void)onGetAllGroups:(NSArray <JRTCCallCenterGroupItem *> *)groups result:(bool)result;

示例代码：

// 获取业务号列表
[_guest queryAllGroups];

// 获取业务号列表回调
- (void)onGetAllGroups:(NSArray <JRTCCallCenterGroupItem *> *)groups result:(bool)result {
    if (result == true) {
        // 查询成功
    }
    else {
     	// 查询失败   
    }
}

发起呼叫

在登录成功之后，访客就可以通过发起呼叫的接口来呼叫自己要做的业务；也可以发起呼叫的同时，设置呼叫参数；JRTCCallCenterCallParam (opens new window) 包含了很多呼叫参数，比如随路参数、SVC 等。

访客有两个呼叫方法，分别为 call (opens new window) 和 oneToOneCall (opens new window) 如下：

/**
 * 呼叫指定业务
 *
 * @param number 业务号，如10087，一般由业务管理人员在业务管理平台上配置业务，然后将业务号给开发人员
 * @param callParam 呼叫参数设置，可以设置通话分辨率、全局宽高比等参数，此参数可传 nil 则使用默认配置，详见 @ref JRTCCallCenterCallParam
 * @return 接口调用结果
 * - true: 接口调用成功，通话状态会通过 {@link JRTCGuestCallback.onCallStateChanged:incomingType:inviter:termReason: onCallStateChanged} 回调上报
 * - false: 接口调用异常
 */
- (bool)call:(NSString *)number callParams:(JRTCCallCenterCallParam *)callParam;

/**
 * 呼叫指定座席
 *
 * @param number 座席 ID，如agent1，一般由业务管理人员在业务管理平台上配置座席ID，然后将座席id给开发人员
 * @param callParam 呼叫参数设置，可以设置通话分辨率、全局宽高比等参数，此参数可传 nil 则使用默认配置，详见 @ref JRTCCallCenterCallParam
 * @return 接口调用结果
 * - true: 接口调用成功，通话状态会通过 {@link JRTCGuestCallback.onCallStateChanged:incomingType:inviter:termReason: onCallStateChanged} 回调上报
 * - false: 接口调用异常
 */
- (bool)oneToOneCall:(NSString *)number callParams:(JRTCCallCenterCallParam *)callParam;

示例代码：

// 创建呼叫参数
JRTCCallCenterCallParam *param = [[JRTCCallCenterCallParam alloc] init];
param.extraInfo = @"extraInfo";      //呼叫随路参数
param.autoRecord = false;            //不开启自动录制
[_guest call:@"10086" callParams:param]; //呼叫指定业务
[_guest oneToOneCall:@"agent1" callParams:param]; //点对点呼叫

通话状态改变通知

当访客发起呼叫、通话建立或者通话结束，都会通过 JRTCGuestCallback (opens new window) 的 onCallStateChanged (opens new window) 事件进行上报。

/**
 * 通话状态改变回调
 *
 * @param type 访客通话状态改变类型，即以下情况会收到此回调：
 * - @ref GuestCallStateChangeTypeCalling 访客呼叫成功
 * - @ref GuestCallStateChangeTypeWaiting 访客呼叫成功后等待座席接听
 * - @ref GuestCallStateChangeTypeIncoming 作为第三方访客收到通话邀请
 * - @ref GuestCallStateChangeTypeTalking 通话接通（第三方访客）或被接通（主访客）
 * - @ref GuestCallStateChangeTypeTermed 通话挂断或被挂断
 * @param incomingType 来电类型，当 type == {@link GuestCallStateChangeTypeIncoming} 时有效
 * @param inviter 邀请成员对象，当 type == {@link GuestCallStateChangeTypeIncoming} 时有效
 * @param reason 挂断原因，只在 type 为 @ref GuestCallStateChangeTypeTermed 时需要关注，详见 @ref CallTermReason
 */
- (void)onCallStateChanged:(GuestCallStateChangeType)type incomingType:(CallIncomingType)incomingType inviter:(nullable JRTCInviter *)inviter termReason:(CallTermReason)reason;

访客通话状态改变详见 GuestCallStateChangeType (opens new window) 。

通话结束原因详见 CallTermReason (opens new window) 。

示例代码：

- (void)onCallStateChanged:(GuestCallStateChangeType)type incomingType:(CallIncomingType)incomingType inviter:(nullable JRTCInviter *)inviter termReason:(CallTermReason)reason {
    switch (type) {
        case GuestCallStateChangeTypeCalling:
            //发起呼叫
            break;
        case GuestCallStateChangeTypeWaiting:
            //发起方等待接听
            break;
        case GuestCallStateChangeTypeTalking:
            //通话建立
            break;
        case GuestCallStateChangeTypeTermed:
            //通话结束
            if (reason == CallTermReasonJoinLicenceLimit) {
                //结束原因会场人数到达上限
            }
            break;
        case GuestCallStateChangeTypeIncoming:
            //来电
            switch (incomingType) {
                case CallIncomingTypeCall:
                    //普通来电
                break;
                case CallIncomingTypeInvite:
                    //三方邀请来电
                break;
                case CallIncomingTypeForward:
                    //转接来电（座席场景）
                break;
                case CallIncomingTypeDirectCall:
                    //直呼来电
                break;
            }
            break;
            
    }
}

创建本地视频画面

初始化成功后，可以创建本地的视频画面，创建本地视频画面的时机没有具体要求，在通话前通话中皆可。

1. 通过调用 JRTCMediaDevice (opens new window) 的 startCameraVideo (opens new window)方法获取本地的视频对象。
2. 在界面画布上渲染本地视频对象画面。

/**
 * 开始本端视频渲染
 *
 * 获取本端视频预览对象 JRTCMediaDeviceVideoCanvas ，通过此对象能获得视图用于UI显示
 * @note
 * 调用此方法时需要保证默认摄像头不为空，即 @ref defaultCamera 不为空，否则将直接返回 nil
 * @param renderType 渲染模式:
 * - @ref JRTCMediaDeviceRenderFullScreen : 铺满窗口，会有裁剪
 * - @ref JRTCMediaDeviceRenderFullContent : 全图像显示，会有黑边
 * - @ref JRTCMediaDeviceRenderFullAuto : 自适应
 * @return
 * - JRTCMediaDeviceVideoCanvas 对象: 开始自身视频渲染成功
 * - nil: 开始自身视频渲染失败
 */
- (JRTCMediaDeviceVideoCanvas* __nullable)startCameraVideo:(JRTCMediaDeviceRender)renderType;

/**
 * 开始自身视频渲染
 *
 * 获取本端视频预览对象 JRTCMediaDeviceVideoCanvas ，通过此对象能获得视图用于UI显示
 * @note
 * 调用此方法时需要保证默认摄像头不为空，即 @ref defaultCamera 不为空，否则将直接返回 nil
 * @param type 渲染模式:
 * - @ref JRTCMediaDeviceRenderFullScreen : 铺满窗口，会有裁剪
 * - @ref JRTCMediaDeviceRenderFullContent : 全图像显示，会有黑边
 * - @ref JRTCMediaDeviceRenderFullAuto : 自适应
 * @param view 渲染视图控件
 * @return
 * - JRTCMediaDeviceVideoCanvas 对象: 开始自身视频渲染成功
 * - nil: 开始自身视频渲染失败
 */
- (JRTCMediaDeviceVideoCanvas* __nullable)startCameraVideo:(JRTCMediaDeviceRender)type view:(JCView* __nonnull)view;

JRTCMediaDeviceRender (opens new window) 决定了视频的渲染模式：

• FullScreen 为填充模式：即将画面内容居中等比缩放以充满整个显示区域，超出显示区域的部分将会被裁剪掉，此模式下画面可能不完整；
• FullContent 为适应模式：即按画面长边进行缩放以适应显示区域，短边部分会被填充为黑色，此模式下图像完整但可能留有黑边。

示例代码：

// 创建本端视图渲染对象
JRTCMediaDeviceVideoCanvas *canvas = [_mediaDevice startCameraVideo:JRTCMediaDeviceRenderFullContent];
// 设置视图位置与尺寸
canvas.videoView.frame = CGRectMake(0, 0, 100, 100);
// 将渲染视图添加到界面上
[self.view addSubview:canvas.videoView];

创建远端视频画面

当通话建立后，除了本地的视频画面，还有通话成员的远端视频画面，如果通话成员有视频流的上传，访客端可以获取到其他成员的视频流并进行渲染。

访客可在收到以下回调时进行界面处理：

• 收到 onCallStateChanged (opens new window) 回调且通话状态改为 GuestCallStateChangeTypeTalking (opens new window) 时，表示座席加入了通话。
• 收到 onMemberJoin (opens new window) 回调时，表示有其他成员加入通话。
• 收到 onMemberUpdate (opens new window) 回调时，表示通话中用户的通话状态变化。例如，可通过 changeParam.video (opens new window) 属性判断用户视频流状态是否发送改变；当 JRTCRoomParticipant.video (opens new window) 的值为 true ，表示远端用户已上传视频流，本端通过订阅远端视频流，获取远端视图渲染对象。

调用 startVideo (opens new window) 接口在界面画布上渲染远端视频对象画面。

渲染其他用户视图画面的方法法与渲染摄像头画面的用法基本一致，需关注 JRTCMediaDeviceRender (opens new window) 渲染模式。

示例代码：

// 创建其他端视图渲染对象
JRTCMediaDeviceVideoCanvas *canvas = [_mediaDevice startVideo:@"视频流ID" renderType:JRTCMediaDeviceRenderFullContent];
// 设置视图位置与尺寸
canvas.videoView.frame = CGRectMake(0, 0, 100, 100);
// 将渲染视图添加到界面上
[self.view addSubview:canvas.videoView];

结束通话

访客可以在呼叫等待或者通话中调用 term (opens new window) 接口主动取消或者结束通话。

/**
 * 结束通话
 * @note
 * - 主访客调用此接口会结束通话，通话中所有成员都会离开，此通通话销毁，所有成员会收到 {@link JRTCAgentCallback.onCallStateChanged:incomingType:inviter:reason: onCallStateChanged} 或 {@link JRTCGuestCallback.onCallStateChanged:incomingType:inviter:termReason: onCallStateChanged} 通话结束回调。
 * - 第三方访客调用此接口仅自身离开通话，通话中其他成员会收到该成员离开的回调 {@link JRTCGuestCallback.onMemberLeave: onMemberLeave} 或 {@link JRTCAgentCallback.onMemberLeave: onMemberLeave} 回调，通话继续进行。
 * @return 接口调用结果
 * - true: 接口调用成功，会收到 {@link JRTCGuestCallback.onCallStateChanged:incomingType:inviter:termReason: onCallStateChanged} 回调
 * - false: 接口调用异常
 */
- (bool)term;

主动和被动的挂断事件与来电、接通一样，都通过 onCallStateChanged (opens new window) 接口上报。其中 CallTermReason (opens new window) 可以用来判断挂断原因，如：主动挂断、对端挂断等，详细可参考 API 文档。

示例代码：

// 访客主动结束通话
[_guest term];

// 通话状态改变回调
- (void)onCallStateChanged:(GuestCallStateChangeType)type incomingType:(CallIncomingType)incomingType inviter:(JRTCInviter *)inviter termReason:(CallTermReason)reason {
    if (type == GuestCallStateChangeTypeTermed) {
     	// 通话结束，结束原因查看 reason
    }
}

销毁本地和远端画面

当不再需要查看视频画面，包括通话其他成员离开，或者通话结束，需要调用 JRTCMediaDevice (opens new window) 对象的 stopVideo (opens new window) 方法来释放渲染资源；该方法需传入要释放的 JRTCMediaDeviceVideoCanvas (opens new window) 对象；必须进行这步操作，不然会造成渲染内存不释放。

/**
 * 停止视频渲染
 * @param canvas JRTCMediaDeviceVideoCanvas 对象，由 {@link startVideo:renderType: startVideo} 或 {@link startCameraVideo: startCameraVideo} 接口返回
 */
- (void)stopVideo:(JRTCMediaDeviceVideoCanvas* __nonnull)canvas;

示例代码：

// 通话结束
- (void)onCallStateChanged:(GuestCallStateChangeType)type incomingType:(CallIncomingType)incomingType inviter:(JRTCInviter *)inviter termReason:(CallTermReason)reason {
	if (type == GusetCallStateChangeTypeTermed) {
        [_mediaDevice stopVideo:_localCanvas];
		[_mediaDevice stopVideo:_remoteCanvas];
    }
}

// 成员离开
- (void)onMemberLeave:(JRTCRoomParticipant *)participant {
     // 停止该成员画面渲染
     [_mediaDevice stopVideo:_remoteCanvas];
 }

登出

访客结束通话后，可以做登出操作，与平台断开一切连接；登出接口调用流程如下所示：

访客可以登出视频平台，与平台断开一切连接。

/**
 * 登出 Juphoon RTC 平台，登出后不能进行平台上的各种业务
 *
 * 登出结果通过 {@link JRTCClientCallback.onLogout: onLogout} 回调通知
 * @return 接口调用结果
 * - true: 接口调用成功
 * - false: 接口调用异常
 */
- (bool)logout;

登出结果通过 JRTCClientCallback (opens new window) 中的 onLogout (opens new window) 接口上报。

/**
 * 登出回调

 * @param reason 登出原因
 */
- (void)onLogout:(ReasonCode)reason;

示例代码：

// 调用登出接口
[_client logout];

// 监听登出结果回调
- (void)onLogout:(ReasonCode)reason {
 	// 登出完成   
}

登录状态变化通知

登录状态通过 JRTCClientCallback (opens new window) 中的 onClientStateChanged (opens new window) 接口上报：

/**
 * 登录状态变化通知
 *
 * @param state 当前状态值
 * @param oldState 之前状态值
 */
- (void)onClientStateChanged:(JRTCClientState)state oldState:(JRTCClientState)oldState;

登录状态详见 JRTCClientState (opens new window) 。

示例代码：

//登录状态改变通知
- (void)onClientStateChanged:(JRTCClientState)state oldState:(JRTCClientState)oldState; {
    //state 当前状态
    //oldState 之前状态
}

销毁 SDK

每个模块都有对应的销毁接口。如不需再使用 SDK 的相关功能，可以强制释放 SDK 的资源。

注：该方法为同步调用，调用此方法后，你将无法再使用该模块的其它方法和回调。 我们不建议在 JRTCSDK 的所有回调方法中调用此方法销毁对象，否则可能出现崩溃现象。

+ (void)destroy;

示例代码：

[JRTCGuest destroy];
[JRTCMediaDevice destroy];
[JRTCClient destroy];