@xylink/xy-rtc-sdk
v4.0.1
Published
XYLink RTC SDK(小鱼易连WebRTC SDK)
Downloads
74
Readme
XYLINK WEBRTC SDK
介绍
XYLink Web SDK 是小鱼易连音视频通讯解决方案的 Web 端 SDK,它是通过 HTML 网页加载的 JavaScript 库,采用 WebRTC 技术,开发者可以使用 XYLink Web SDK 提供的方法快速实现多人音视频通话服务。
安装
# 通过 Yarn 安装
$ yarn add @xylink/xy-rtc-sdk -S
# 通过 Npm 安装
$ npm install @xylink/xy-rtc-sdk -S
示例
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);
详细集成流程参考详细 API 文档完成音视频通话。
开源示例项目
我们在 GitHub 上提供了开源的示例项目供你参考:
- Vue 版本:https://github.com/xylink-com/xylink-rtc-vue-demo
- React 版本:https://github.com/xylink-com/xylink-rtc-demo
如果你是第一次集成 XY RTC SDK 产品,你可以使用我们基于 SDK 实现的产品进行体验:小鱼 Web 会议。 我们会将 SDK 的最新功能在小鱼 Web 会议上进行集成展示出来,方便作为一种参考方式。
版本更新内容
具体可查看发版说明文档。