communicate-fusion-vue-zsxt-h5
v1.0.7
Published
## 1. 安装 ``` yarn communicate-fusion-vue-zsxt-h5 或 npm i communicate-fusion-vue-zsxt-h5 -S ```
Downloads
337
Readme
communicate-fusion-vue-h5-beta
1. 安装
yarn communicate-fusion-vue-zsxt-h5
或
npm i communicate-fusion-vue-zsxt-h5 -S
2. 使用
2.1 main.js中引入
import communicateFusionVueZsxtH5 from 'communicate-fusion-vue-zsxt-h5'
Vue.use(communicateFusionVueZsxtH5)
2.2 组件中使用
<template>
<communicate-fusion-vue-zsxt-h5
ref="cfvh5Ref"
serverUrl="/xmessage-cms"
wss="10.21.0.17:444"
selfWss="10.2.0.55:9001/ws"
:operationConfig="operationConfig"
@invite="inviteHandle"
@close="closeHandle"
@leaveMeeting="leaveMeetingHandle"
@endMeeting="endMeetingHandle">
</communicate-fusion-vue-zsxt-h5>
</template>
<script>
mounted(){
//按钮区控制,样式通过class修改, onClick为自定义按钮执行函数
this.operationConfig = [
{type:'vocie'},
{type:'mute'},
{type:'video'},
{type:'members'},
{
title: '边聊边办',
class: 'chat',
onClick: ()=> {console.log('---边聊边办---')}
}];
// 当前用户登录
this.$refs.cfvh5Ref.login({
username:'user2',
account:'15423998886',
phone:'15423998886',
token:'' //通过网关获取的access_token
}).then(()=>{
})
},
methods:{
inviteHandle() {
//邀请用户
},
closeHandle(){
//窗体关闭
},
leaveMeetingHandle(val){
//会议离开
//返回数据为conferenceI、conferenceNumber、error
},
endMeetingHandle(val){
//会议结束
//返回数据为conferenceI、conferenceNumber、error
},
}
</script>
3. 参数
3.1 serverUrl
会议组件接口服务地址
3.2 wss
会话服务器地址
3.3 selfWss
自建wss服务器地址,用来解决部分海康不支持的即时通讯功能,如:麦克风禁言状态同步;
3.4 operationConfig
按钮区配置 | 字段 | 说明 | 备注 | |:--------:| :---------: | :---------| |type|系统按钮类型|vocie-听筒控制;mute-麦克风控制;video-摄像头控制;members-成员管理;vocie-听筒控制;switchCamera-摄像头切换 |title|按钮文字| 无 |class|类名| 无 |onClick|按钮点击时触发的函数|()=>{}
3.5 login
| 字段 | 说明 | 类型 | 备注 | |:--------:| :---------:|:---------:|:---------| | username | 用户名 | string | 参会人员姓名 | | account | 账号 | number | 传手机号,作为用户的唯一标识,防止重名 | | phone | 手机号 | number | | | token | access-token | string | 通过网关获取的access-token |
4. 方法
| 方法名 | 说明| 参数 | 返回结果 | |:--------:| :---------:| :---------:|:---------| | login | 登录wss | 参考3.4 | |
5. 事件
| 事件名 | 说明 | 返回结果 | |:--------:| :---------:|:---------| | invite | 邀请用户 | 无 | | close | 窗体关闭 | 无 | | leaveMeeting | 会议离开 | conferenceId:会议标识,conferenceNumber:会议号, error:报错时的信息 | | endMeeting | 会议结束 | conferenceId:会议标识,conferenceNumber:会议号, error:报错时的信息 |