复用 IM 账号

更新时间: 2022/10/27 03:26:25

本文介绍如何在会议组件中开启 IM 复用功能,帮助您在应用中同时集成并使用 NEMeetingKit 和 IM SDK。

背景介绍

IM SDK 是网易云信提供的 IM 即时通讯 SDK,网易会议组件 NEMeetingKit 在底层实现上,依赖了 IM SDK 提供的 IM 长连接通道,用来完成会议中的会控操作。而为了能够建立起长连接通道,需要使用 IM 账号完成 IM SDK 的登录。因此,在 NEMeetingKit 中,一个会议账号都会对应唯一一个 IM 账号。

当用户调用 NEMeetingKit 登录接口传入会议账号进行登录时,NEMeetingKit 内部会查询并获取到该会议账号唯一绑定的 IM 账号,并自动登录 IM SDK 以建立起长连接通道。此时,如果上层业务同时也集成了 IM SDK,并已经进行了 IM SDK 登录操作,那么由于 IM SDK 同时只允许登入一个账号,因此会造成此次 NEMeetingKit 登录失败。

因此,若您需要在应用中同时集成 NEMeetingKit 和 IM SDK,您需要开启 NEMeetingKit 的 IM 复用功能

创建会议账号

  1. 准备工作。

    • 若您已集成 IM SDK,需要再同时集成 NEMeetingKit,则需要在指定应用下开通 NERoom 房间组件,操作步骤请参考开通 NERoom 房间组件

    • 若您已集成 NEMeetingKit,需要再同时集成 IM SDK,则不需要额外配置,当前的 NEMeeting App Key 可以直接作为 IM App Key 使用,用于完成 IM SDK 的登录。

  2. 创建一个与 IM 账号绑定的会议账号

    在登录 IM SDK 前,需要先完成 IM 账号的注册,其中每个 IM 账号对应唯一的 imAccid 和 imToken。

    假设当前已有一个 IM 账号,其中 imAccid 和 imToken 值分别为 "myAccid" 和 "myToken"。若现在需要复用该 IM 账号,则需要调用 创建会议账号 的服务端接口创建一个与该 IM 账号绑定的会议账号,请求时需要在请求参数中将 imAccid 和 imToken 分别设置为该 IM 账号的 imAccid 和 imToken,即 "myAccid" 和 "myToken" 。

    至此您就创建了一个与该 IM 账号绑定的会议账号。同时该服务端接口返回会议账号的 userUuid 和 userToken,可用来登录 NEMeetingKit。

复用 IM 账号

上一步完成后,则可以在客户端上开启 IM 复用功能,具体步骤如下:

  1. 初始化 IM SDK 与 NEMeetingKit。

    1. Application 中初始化 IM SDK。

    开启 IM 复用功能后,NEMeetingKit 不会自动初始化 IM SDK,上层业务需要负责完成 IM SDK 的初始化工作。

    1. 初始化 NEMeetingKit,此时需要设置 NEMeetingKitConfig#reuseIM 字段为 true 表明开启 IM 复用功能。

    示例代码如下:

    public class MyMeetingApplication extends Application {
        
        @Override
        public void onCreate() {
        super.onCreate();
    
        //1. 初始化 IM SDK (仅在复用开启时由上层业务完成初始化)
        SDKOptions sdkOptions = SDKOptions.DEFAULT;
        // 具体参数由应用层根据实际情况传入
        //...
        //...
        NIMClient.config(this, null, sdkOptions);
        if (ProcessUtils.isMainProcess(context)) {
        NIMClient.initSDK();
        }
        
        //2. 初始化 NEMeetingKit
        NEMeetingKitConfig config = new NEMeetingKitConfig();
        config.appKey = context.getString(R.string.appkey);
        config.appName = context.getString(R.string.app_name);
        // 打开 IM 复用开关
        config.reuseIM = true;
        // 其他初始化参数根据实际情况传入
        // ...
        // ...
        NEMeetingKit.getInstance().initialize(this, config, callback);
        }
    }
    
  2. 登录 IM SDK。

    开启复用功能时,应用层需要确保已先使用与该会议账号绑定的 IM 账号登录 IM SDK。登录时机由业务决定,只需要确保在进行 NEMeetingKit 登录前完成 IM 登录即可。

    请通过 IM 账号的 imAccid 和 imToken 完成登录,示例代码如下:

    NIMClient.getService(AuthService.class).login(new LoginInfo(imAccid, imToken, imAppKey));
    
  3. 登录 NEMeetingKit。

    使用对应的会议账号登录 NEMeetingKit,请通过创建会议账号时返回的 userUuid(对应 accountId) 和 userToken(对应 accountToken) 完成登录,示例代码如下:

    //以使用账号 ID 和 Token 登录为例
    NEMeetingKit.getInstance().login(accountId, accountToken, callback);
    

    您可以通过此接口回调中返回的错误码判断是否登录成功;若登录成功则说明 IM 复用功能启用成功,否则启用失败。

相关参考

复用 IM 前后 NEMeetingKit 的行为差异

启用或关闭 IM 复用功能时,NEMeetingKit 的行为表现存在不一致的情况,具体请参考如下表格。

IM 复用功能状态
初始化
登录
是否支持匿名入会
关闭 NEMeetingKit 会自动初始化 IM SDK 会获取会议账号对应的 IM 账号自动登录 IM SDK 支持
启用 NEMeetingKit 不会自动初始化 IM SDK,由应用层负责初始化 不会自动登录 IM SDK,会判断会议账号与当前已登录的 IM 账号是否是绑定关系,以决定 NEMeetingKit 是否登录成功 不支持

错误码

错误码 说明 解决办法
112001 IM 复用不支持匿名入会 选择其他方法入会或者关闭 IM 复用功能
100004 开启了 IM 复用,请先登录 IM 确保 IM SDK 已经登录后再登录 NEMeetingKit
100005 开启了 IM 复用,IM 账号不匹配 重新创建会议账号,并传入对应需绑定 IM 账号的 imAccid与 imToken
此文档是否对你有帮助?
有帮助
去反馈
  • 背景介绍
  • 创建会议账号
  • 复用 IM 账号
  • 相关参考
  • 复用 IM 前后 NEMeetingKit 的行为差异
  • 错误码