# XYLINK WEBRTC SDK

## 介绍

XYLink Web SDK 是小鱼易连音视频通讯解决方案的 Web 端 SDK，它是通过 HTML 网页加载的 JavaScript 库，采用 WebRTC 技术，开发者可以使用 XYLink Web SDK 提供的方法快速实现高质量、高品质、高性能的多人音视频通话服务。

## 在线体验

- [小鱼易连 Web 会议](https://meet.xylink.com)

## 开发文档

- [产品介绍](https://openapi.xylink.com/common/meeting/doc/description?platform=web)
- [视频通话](https://openapi.xylink.com/common/meeting/doc/video_call?platform=web)
- [API 参考](https://openapi.xylink.com/common/meeting/api/description?platform=web)

## 安装

```bash
$ npm install @xylink/xy-rtc-sdk -S
```

## 示例

```js
import XYRTC from '@xylink/xy-rtc-sdk';

// 创建Client和Stream模块
const XYClient = XYRTC.createClient({
  clientId: 'xxx',
  clientSecret: 'xxx',
  extId: 'xxx'
});

// 监听事件
XYClient.on('call-status', () => {});
// 其他事件...

// 登录
await XYClient.loginExternalAccount({...});

// 呼叫会议
await XYClient.makeCall({ confNumber: '', displayName: '' });

// 创建Video和Audio流
const videoAudioTrack = await XYClient.createVideoAudioTrack({});

await videoAudioTrack.capture();

// 推送流
XYClient.publish(videoAudioTrack);
```

详细集成流程参考[视频通话](https://openapi.xylink.com/common/meeting/doc/video_call?platform=web)文档；

## 开源示例项目

我们在 GitHub 上提供了开源的示例项目供你参考：

- Vue 版本：https://github.com/xylink-com/xylink-rtc-vue-demo
- React 版本：https://github.com/xylink-com/xylink-rtc-demo

如果你是第一次集成小鱼易连 RTC SDK 产品，你可以使用我们基于 Web SDK 实现的产品进行体验：[小鱼易连 Web 会议](https://meet.xylink.com)。 我们会将 SDK 的最新功能在小鱼 Web 会议上进行集成展示出来，方便作为一种参考方式。

同时我们也提供基于小鱼易连 Web SDK 的 [MeetingKit UI](https://openapi.xylink.com/common/meetingkit/doc/description?platform=web)库，一套基于视频通话场景开发的产品，它提供与小鱼 Web 会议及客户端相同的 UI 组件，仅需 5 个步骤的集成代码开发，即可构建 Web 视频通话应用，帮助开发者节省 95% 的开发时间。

## 版本更新内容

具体可查看[发版说明文档](https://openapi.xylink.com/common/meeting/doc/version?platform=web)。