communicate-fusion-vue-beta v1.0.0-beta.82
communicate-fusion-vue-beta
1. 安装
yarn communicate-fusion-vue-beta
或
npm i communicate-fusion-vue-beta -S
2. 使用
2.1 main.js中引入
import CommunicateFusionVueBeta from 'communicate-fusion-vue-beta'
Vue.use(CommunicateFusionVueBeta)
2.2 组件中使用
<template>
<communicate-fusion-vue-beta
ref="cfvRef"
serverUrl="http://127.0.0.1:8080"
wss="10.21.0.17"
selfWss="10.2.0.37:9001/ws"
@close="closeHandle"
@endMeeting="endMeetingHandle"
@meetingInvite="meetingInvite"
@terminalChange="terminalChange">
</communicate-fusion-vue-beta>
</template>
<script>
mounted(){
<!-- ,cameraId,audioInId,audioOutId -->
// 当前用户登录
this.$refs.cfvRef.login({
username:'user2',
account:'15423998886',
phone:'15423998886',
token:'' //通过网关获取的access_token
}).then((res)=>{
const {cameras,audioIns,audioOuts} = res
//cameras摄像头列表
//audioIns麦克风列表
//audioOuts扬声器列表
})
//参会人员列表
const userInfoList = [{
username:'user2',
account:'15423998886',
isChairman:true,
isOperator:true
}]
//入会设备的resId列表
const deviceList = []
//会议主题
const title = `视频会议${new Date().getTime()}`
//初始化会议(因为目前创建账号时间较长,所以将初始化与创建会议分离)
this.$refs.cfvRef.initMeeting({
userInfoList,
deviceList,
title,
recordEnable:false,
// sessionId,
// sessionNumber,
// cameraId, 摄像头的deviceId
// audioInId, 麦克风的deviceId
// audioOutId 扬声器的deviceId
}).then(()=>{
//创建会议
this.$refs.cfvRef.createMeeting().then(res=>{
// 返回数据包括:
//sessionId:im聊天的会话ID查询历史纪录时用到,
//sessionNumber:im聊天的标识发送消息时用到,
//conferenceId:会议标识,加入会议时有用
})
})
//添加人员进入会议
this.$refs.cfvRef.addUsersToMetting(userInfoList).then(res=>{
//返回数据为当前会议全部人员和设备
})
//添加设备进入会议
this.$refs.cfvRef.addDeviceToMetting(deviceList).then(res=>{
//返回数据为当前会议全部人员和设备
})
// 主动加入会议
// this.$refs.cfvRef.joinTheMeeting({
// conferenceId,
// userInfoList,
// deviceList,
// cameraId, 摄像头的deviceId
// audioInId, 麦克风的deviceId
// audioOutId 扬声器的deviceId
// }).then(res=>{
// 返回数据为会议基本信息
// })
},
methods:{
closeHandle(){
//窗体关闭
},
endMeetingHandle(val){
//会议结束
//返回数据为conferenceNumber会议标识
},
meetingInvite(meetingInfo){
//收到会议邀请
// meetingInfo会议基本信息
// 接受会议邀请,进入会议
//this.$refs.cfvRef.joinByInvite()
}
}
</script>
3. 参数
3.1 serverUrl
会议组件接口服务地址
3.2 wss
会话服务器地址
3.3 selfWss
自建wss服务器地址,用来解决部分海康不支持的即时通讯功能,如:麦克风禁言状态同步;
3.4 title
会议的名称
3.5 deviceList
入会设备的 resId
数组,通过 网关接口 查询
3.6 login
字段 | 说明 | 类型 | 备注 |
---|---|---|---|
username | 用户名 | string | 参会人员姓名 |
account | 账号 | number | 传手机号,作为用户的唯一标识,防止重名 |
phone | 手机号 | number | |
token | access_token | string | 通过网关获取的access_token |
3.7 userInfoList
字段 | 说明 | 类型 | 备注 |
---|---|---|---|
username | 用户名 | string | 参会人员姓名 |
account | 账号 | number | 传手机号,作为用户的唯一标识,防止重名 |
phone | 手机号 | number | 手机号,成员列表显示用 |
isChairman | 是否为主持人 | boolean | 如果需要操作视频,主持人和操作人需要同一个账户,不填默认取第一个 |
isOperator | 是否为登陆人 | boolean | 如果需要操作视频,主持人和操作人需要同一个账户,不填默认取第一个 |
3.8 initMeeting方法的参数
字段 | 说明 | 类型 | 是否必须 | 备注 |
---|---|---|---|---|
userInfoList | 用户列表 | array | 必须 | 参考3.7 |
deviceList | 设备列表 | array | 必须 | 设备resId的数组 |
title | 会议主题 | string | 必须 | |
recordEnable | 是否开启录制 | boolean | 非必须 | |
sessionId | im聊天会话ID | string | 非必须 | im聊天的会话ID查询历史纪录时用到 |
sessionNumber | im聊天会话标识 | string | 非必须 | im聊天的标识发送消息时用到 |
cameraId | 摄像头的deviceId | string | 非必须 | 从login方法返回的cameras摄像头列表中获取 |
audioInId | 麦克风的deviceId | string | 非必须 | 从login方法返回的audioIns麦克风列表中获取 |
audioOutId | 扬声器的deviceId | string | 非必须 | 从login方法返回的audioOuts扬声器列表中获取 |
3.9 joinTheMeeting方法的参数
字段 | 说明 | 类型 | 是否必须 | 备注 |
---|---|---|---|---|
conferenceId | 会议ID | string | 必须 | |
userInfoList | 用户列表 | array | 非必须 | 参考3.7 |
deviceList | 设备列表 | array | 非必须 | 参考3.5 |
4. 方法
方法名 | 说明 | 参数 | 返回结果 |
---|---|---|---|
login | 登录wss | 参考3.6 | cameras摄像头列表,audioIns麦克风列表,audioOuts扬声器列表 |
initMeeting | 创建会议 | 参考3.8 | |
addUsersToMetting | 添加人员 | userInfoList,参考3.7 | 当前会议全部人员和设备 |
addDeviceToMetting | 添加设备 | 入会设备的 resId 数组 | 当前会议全部人员和设备 |
joinTheMeeting | 主动加入会议 | 参考3.9 | 会议相关信息 |
joinByInvite | 接受会议邀请 | 无 |
5. 事件
事件名 | 说明 | 返回结果 |
---|---|---|
close | 窗体关闭 | 无 |
leaveMeeting | 会议离开 | conferenceId:会议标识,conferenceNumber:会议号,sessionId:im聊天的会话ID;sessionNumber:im聊天的标识; |
endMeeting | 会议结束 | conferenceId:会议标识,conferenceNumber:会议号 ,sessionId:im聊天的会话ID;sessionNumber:im聊天的标识; |
meetingInvite | 会议邀请 | 会议基本信息 |
terminalChange | 会议终端改变 | 当前会议全部人员和设备 |
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago