跳到主要内容

安装 CallLib SDK

您可以使用 NPM 安装 CallLib 与其依赖的 IMLib 与 RTCLib,或者使用 CDN 方式安装。

实时音视频通话业务依赖即时通讯业务(IMLib)提供的信令通道,同时 CallLib 依赖 RTCLib 提供音视频基础能力,因此基于 CallLib 开发应用需要使用以下几个库:

  • 即时通讯基础能力库 IMLib。推荐使用 IMLib 5.X。
  • 实时音视频基础能力库 RTCLib 5.X 版本。
  • 实时音视频通话能力库 CallLib 5.X 版本。

从 NPM 安装

您需要安装三个 NPM 模块。

如果是新集成融云 SDK 的客户,可略过以下步骤 1、2、3,直接在项目文件夹中打开终端窗口,运行以下命令安装全部模块:

npm install @rongcloud/engine@latest @rongcloud/imlib-next --save
npm install @rongcloud/plugin-rtc --save
npm install @rongcloud/plugin-call --save

步骤 1:安装 IMLib

兼容 IMLib 2.X、4.X、5.X 版本。IM 业务可与其他版本与平台的 IMLib SDK 互通。

新集成客户推荐使用 IMLib 5.X。如需要选用 IMLib 2.X 或 4.X 版本,推荐使用对应的 Adapter SDK。

  • 安装 5.X 版本 IMLib(推荐)

    # 安装 RongIMLib v5
    npm install @rongcloud/engine@latest @rongcloud/imlib-next@latest --save
  • 安装 IMLib 4.X 版本 Adapter SDK

    # @rongcloud/imlib-v4 已停止维护,推荐用 RongIMLib-v4-Adapter
    # 旧版 imlib-v4 要求版本 ≧ 4.5 +
    # npm install @rongcloud/imlib-v4 --save
    #
    # 安装 RongIMLib-v4-Adapter
    npm install @rongcloud/engine@latest @rongcloud/imlib-v4-adapter --save
  • 安装 IMLib 2.X 版本 Adapter SDK

    # @rongcloud/imlib-v2 已停止维护,推荐用 RongIMLib-v2-Adapter
    # 旧版 imlib-v2 要求版本 ≧ 2.10 +
    # npm install @rongcloud/imlib-v2 --save
    #
    # 安装 RongIMLib-v2-Adapter
    npm install @rongcloud/engine@latest @rongcloud/imlib-v2-adapter@latest -S

注意

已集成 RongIMLib v3 的客户,必须将 RongIMLib v3 升级到 IMLib 4.X 版本 Adapter SDK 及以上版本。

步骤 2:安装 RTCLib

需要安装 RTCLib 5.2.0 或 5.2.0 以上版本

# 安装 RTCLib
npm install @rongcloud/plugin-rtc --save

步骤 3:安装 CallLib

# 安装 CallLib
npm install @rongcloud/plugin-call --save

步骤 4:导入模块

全部下载安装完成后,即可在代码中导入 IMLib、RTCLib 与 CallLib 库。

  1. 导入 IMLib 库。请根据您安装的 IMLib 版本导入。

    //导入 IMLib 5.X
    import * as RongIMLib from "@rongcloud/imlib-next";

    //或,导入 @rongcloud/imlib-v4-adapter
    import { IMClient, init } from "@rongcloud/imlib-v4-adapter";

    //或,导入 @rongcloud/imlib-v2-adapter
    import { RongIMClient, IMClient } from "@rongcloud/imlib-v2";
  2. 导入 RTCLib 和 CallLib 库。

    // 导入 RTCLib、CallLib
    import { installer as rtcInstaller, RCRTCClient, RCTrack, RCFrameRate, RCResolution } from "@rongcloud/plugin-rtc";

    import { installer as callInstaller, RCCallClient, RCCallSession, RCCallErrorCode, ISessionListener, IEndSummary, ISenderInfo, IMuteUser, IInvitedUsers, RCCallLanguage, RCCallEndReason, RCCallMediaType, IOfflineRecord, RCCallSessionState } from "@rongcloud/plugin-call";

从 CDN 安装

CallLib 与其依赖的 IMLib、RTCLib 均支持使用 CDN 文件导入项目。

  1. 安装 IMLib(推荐新集成客户使用 IMLib 5.X)。

    //安装 RongIMLib 5.X(推荐)
    <script src="https://cdn.ronghub.com/RongIMLib-5.9.5.prod.js"></script>

    //或,安装 RongIMLib-v4-Adapter
    <script src="https://cdn.ronghub.com/RongIMLib-v4-Adapter-5.9.5.prod.js"></script>

    //或,安装 RongIMLib-v2-Adapter
    <script src="https://cdn.ronghub.com/RongIMLib-v2-Adapter-5.9.5.prod.js"></script>
  2. 安装 RTCLib 和 CallLib。

    // RTCLib v5
    <script src="https://cdn.ronghub.com/RCRTC-5.7.1.prod.js"></script>
    // RongCallLib
    <script src="https://cdn.ronghub.com/RCCall-5.2.9.prod.js"></script>
  3. 全部安装完成后,即可在代码中使用 IMLib、RTCLib 与 CallLib 库。各个库的全局变量定义如下:

    • IMLib 全局变量: RongIMLib
    • RTCLib 全局变量: RCRTC
    • CallLib 全局变量: RCCall

    初始化客户端时您会用到以上全局变量。在实现音视频通话文档中亦有说明。