快速集成
-
安装SDK库
# 通过yarn安装 $ yarn add @ylink-sdk/wechat-miniprogram # 通过npm安装 $ npm install @ylink-sdk/wechat-miniprogram
提示:在通过npm/yarn安装/升级完成SDK库之后,需要执行构建npm操作,在工具菜单栏中执行:工具->构建 npm
升级库
# 通过yarn安装 $ yarn upgrade @ylink-sdk/wechat-miniprogram # 通过npm安装 $ npm update @ylink-sdk/wechat-miniprogram
-
加入入会功能,在需入会的js文件中引用sdk的方法
import ylink from '@ylink-sdk/wechat-miniprogram/lib.js'; Page({ data: { meeting: { meetingNum: '', displayName: '', pwd: '', }, ... }, ... onJoinMeeting() { ylink.join({ meetingNum: this.data.meeting.meetingNum, pwd: this.data.meeting.pwd, displayName: this.data.meeting.displayName }, (result) => { if (result.bizCode === 900200) { // 跳转至<ylink-room />引用的会议界面 wx.navigateTo({url: '/pages/meeting/index'}); } else { // 异常提示,开发者可基于业务码表进行映射提示 wx.showToast({ title: result.bizCode, icon: 'none', duration: 2000, }); } }); } })
-
加入会议功能,在需要会议功能的wxml使用组件,js中引用sdk的方法
在需引入组件的页面目录下,配置相应页面的xxx.json文件:
{ "usingComponents": { "ylink-room": "@ylink-sdk/wechat-miniprogram" }, // 会议界面布局默认是按照横屏模式来布局的 "pageOrientation": "landscape" }
在wxml文件中使用
<ylink-room />
组件,组件中的配置变量请参见API概览:<ylink-room id="ylink-room" beauty="{{8}}" handup="{{handup}}" muted="{{muted}}" camera="{{camera}}" hideSmallView="{{hideSmallView}}" devicePosition="{{devicePosition}}" bindonRoomEvent="onRoomEvent"> </ylink-room>
在Page中定义data属性及引入sdk方法
Page({ onReady() { // 缓存sdk <ylink-room/>组件节点context,为后续调用组件内部方法用 this.ylinkRoom = this.selectComponent('#ylink-room'); // 通知内部事件开始做初始化准备,启动RoomEvent this.ylinkRoom.start(); }, data: { devicePosition: 'front', handup: false, muted: false, camera: true, hideSmallView: false }, // 非常重要,基本业务处理都是基于此事件的通知进行处理。详细事件请参见API概览 onRoomEvent(ms) { console.log('### onRoomEvent ###', ms); const {event, body} = ms.detail; if (event === 'xxx') { // handle } else if (event === 'xxx') { // handle } } })