小鱼易连-简介

小鱼易连简介

概述

1. 官网：https://www.xylink.com/
2. 官方文档：https://openapi.xylink.com/
3. 公司简介：小鱼易连是中国云视频领域的头部企业，专注于提供高安全、超融合、全连接的云视频解决方案，服务于政务、教育、金融、医疗、企业等多元化行业。
4. 终端支持：终端 SDK 覆盖 Android、iOS、Windows、macOS、Web、小程序、Electron，并支持跨平台互通，保证用户在不同设备上获得一致的体验。

系统架构

小鱼易连开发平台分为终端 SDK 和服务端 API，实现完整的音视频通话场景需要同时进行服务端和终端的集成开发。系统集成架构如下图所示：

1. 伙伴应用（partner app）：你的应用，通过集成终端 SDK 向用户提供音视频服务。
2. 伙伴服务器（partner server）：你的服务器，除了与你的应用进行交互，还可以通过访问服务端 API 实现音视频相关功能。
3. 终端 SDK（xylink sdk）：通过终端 SDK 可实现呼叫、设备管理、布局设置等操作。
4. 服务端 API（xylink cloud sdk）：通过服务端 API 可进行会议控制管理、创建会议室等操作。
5. 云平台（xylink backend）：音视频云服务平台，提供终端 SDK 及服务端 API 的后台服务。

小鱼易连开发平台的音视频通话是在云会议室进行的，在进行音视频呼叫之前，你可以通过服务端 API 创建云会议室，云会议室为虚拟的会议号码。 服务端 API 基于 REST API 提供服务，建议你通过你的服务端访问小鱼易连开发平台服务端 API，便于后期维护控制。

Web端SDK

1. 官方文档：Web端SDK
2. 初始化：在基于小鱼易连 Web SDK 实现多人音视频通话功能时，首先需要初始化 Web SDK。初始化完成后，你可以通过XYRTCClient实例实现用户登录及会议呼叫操作。
3. 登录：使用SDK进行呼叫之前，你需要首先进行注册/登录。在小鱼易连云视讯平台每个用户有唯一的账号标识。
4. 参会：参会者通过呼入同一个会议室进行音视频通话，对于有密码的会议室需同时输入会议室密码进入会议。

前端集成小鱼易连

WebRTC检测

在集成小鱼易连到自己的Web项目之前，需要检测浏览器是否支持WebRTC。你可以在浏览器中打开 XYLink SDK Detect 能力测试页面，检测浏览器是否支持 WebRTC 能力。

Demo下载

为了在Web项目中快速集成小鱼易连，你可以下载官方提供的Demo，参见官网：小鱼易连Demo，这里以Vue项目的Demo为例。

下载

1. 下载地址：xylink-rtc-vue-demo
2. 下载完成后，使用VS Code打开项目。

配置登录参数

在运行小鱼易连的Demo之前，需要在src/utils/config.js中配置第三方登录所需的：

1. extId：企业ID（必填项，为nil时sdk内部会抛出异常）
2. clientId：客户端id，在管理平台生成
3. clientSecret：客户端秘钥，在管理平台生成
4. SERVER：server地址，不设置则默认为 cloud.xylink.com

在示例的Demo中给出了测试的相关参数，本地测试的话，可以直接使用这些默认的配置参数。

安装依赖

npm install

运行Demo

npm run start

项目启动成功后，通过 http://localhost:8080/ 进行访问

登录入会

1. 获取会议号

   • 运行项目后，需要获取一个会议号才能加入会议。如果没有会议号测试，你可以下载 小鱼客户端/App，注册后即可获取个人的云会议室号码进行呼叫测试。

   • 在实际开发中，你可以通过调用服务端的API来获取会议号。

在上图中可以查看自己的会议号，提供的会议号最多容纳3人参会，你可以在设置中对参会的服务进行升级。

2. 其他登录参数

   • 使用上面的会议号、入会密码，即可进入会议。

   • 这里的第三方用户ID、会议中显示的名称，可以随便填写。

服务端API

1. 官方文档：小鱼易连服务端
2. jar包和源码下载：jar包和源码下载
3. 服务端 API 基于小鱼易连云平台能力，提供会议室管理、录制、直播、会议控制、会议统计等一系列以音视频业务为基础的后台服务。
4. 小鱼易连提供RESTFUL API，可以在任何支持http请求的平台调用API，如：Java、C#、Delphi等。只要按照云服务API的要求计算签名，完成请求交互，即可集成小鱼公开服务能力。
5. 小鱼易连会对每个请求的API的企业身份、公共参数、签名进行验证，故每个API请求都需要包括企业身份（enterpriseId）、clientid、clientSecret。