更新记录

1.0.4(2021-06-18)

移出消息模块中的会议邀请,新增直播、连麦

1.0.3(2021-06-15)

新增监听用户上线、离线,修改部分函数返回格式

查看更多

平台兼容性

Android iOS
适用版本区间:6.0 - 11.0 支持CPU类型:armeabi-v7a,arm64-v8a ×

原生插件通用使用流程:

  1. 购买插件,选择该插件绑定的项目。
  2. 在HBuilderX里找到项目,在manifest的app原生插件配置中勾选模块,如需要填写参数则参考插件作者的文档添加。
  3. 根据插件作者的提供的文档开发代码,在代码中引用插件,调用插件功能。
  4. 打包自定义基座,选择插件,得到自定义基座,然后运行时选择自定义基座,进行log输出测试。
  5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项:使用HBuilderX2.7.14以下版本,如果同一插件且同一appid下购买并绑定了多个包名,提交云打包界面提示包名绑定不一致时,需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择


私有化部署以及技术支持,请使用如下方式联系:

QQ群:785919513
QQ号:371162760
微信:bin371162760
手机号:1708140884

公共服务Key,仅适用于测试环境,不建议生产环境使用,公共环境建议userId使用UUID,Key会不定期更新,如失效,请联系作者

d21L12dCQM3zKHD1AJFctENBpS8XgwXETpTulPdRHRtN8t+/bCIGjTYy7FMf0lYtrRPcO/UQRAZa/LR7y2y2APJPq1iE3s6R+Fka4A98Ca4=

公共模块

引用插件

let vrtcCloud = uni.requireNativePlugin('VIP-VRTCCloud')

调用函数

函数名 参数 说明
initSDK 1、key 联系作者申请
2、userId 用户ID
初始化SDK
startListener 1、callback 回调 事件监听
sendMeetingInvite 1、targetId 目标ID
2、callback 回调
发送会议邀请
sendOnLineMessage 1、targetId 目标ID
2、message 消息内容
3、callback 回调
发送在线消息
call 1、targetId 目标ID
2、callback 回调
拨打视频电话(一对一)
createMeeting 1、meetingName 会议名称
2、callback 回调
创建会议
joinMeeting 1、meetingId 会议ID
2、callback 回调
加入会议

监听事件

事件名 说明
voip_rev_calling 用户来电
c2c_rev_msg 用户普通消息
c2c_rev_function_msg 用户功能消息,例如:会议邀请、直播邀请等
user_online 用户上线
user_offline 用户掉线

代码示例

//初始化
vrtcCloud.initSDK({
    key:'d21L12dCQM3zKHD1AJFctENBpS8XgwXETpTulPdRHRtN8t+/bCIGjTYy7FMf0lYtrRPcO/UQRAZa/LR7y2y2APJPq1iE3s6R+Fka4A98Ca4=',
    userId:'123456'
},res=>{
    if(res.code==='success'){
        uni.showToast({
            title:'初始化成功'
        })
        this.title = '123456'
        //只监听一次即可,如果想再次监听,需要先停止监听
        this.listener()
    }
    if(res.code==='failed'){
        this.title = res.message
    }
})
//监听
listener(){
    vrtcCloud.startListener(res=>{
        //谁谁谁来电
        if(res.type==='voip_rev_calling'){
            uni.showToast({
                title:res.targetId+'来电了'
            })
            uni.navigateTo({
                url:'../calling/calling?targetId='+res.targetId
            })
        }
        //普通消息
        if(res.type==='c2c_rev_msg'){
            console.log(res.content)
        }
        //功能消息
        if(res.type==='c2c_rev_function_msg'){
            //会议邀请
            if(res.function==='meetingInvite'){
                let meetingId = res.data.meetingId
                uni.showModal({
                    title:'会议邀请',
                    content:'是否进入会议',
                    success:res=>{
                        vrtc.joinMeeting({
                            meetingId:meetingId
                        },res=>{
                            if(res==='success'){
                                uni.navigateTo({
                                    url:'../meeting/meeting'
                                })
                            }
                        })
                    }
                })
            }
            if(res.function==='liveInvite'){
                let creatorId = res.data.creatorId
                let liveId = res.data.liveId
                uni.showModal({
                    title:'直播邀请',
                    content:'是否进入直播',
                    success:res=>{
                        vrtc.watchLive({
                            creatorId:creatorId,
                            liveId:liveId
                        },res=>{
                            if(res.code==='success'){
                                uni.navigateTo({
                                    url:'../liveing/liveing'
                                })
                            }
                        })
                    }
                })
            }
        }
        if(res.type==='user_online'){
            this.title = '123456'+'上线了'
        }
        if(res.type==='user_offline'){
            this.title = '掉线了'
        }
    })
}
//拨打电话
vrtcCloud.call('对方ID',res=>{
    if(res.code==='success'){
        uni.navigateTo({
            url:'../call/call'
        })
    }
})
//创建会议
vrtcCloud.createMeeting({
    meetingName:'会议名字'
},res=>{
    if(res.code==='success'){
        uni.navigateTo({
            url:'../meeting/meeting'
        })
    }
})

IM消息模块

引用插件

let imCloud = uni.requireNativePlugin('VIP-VRTCIMCloud')

调用函数

函数名 参数 说明
sendMeetingInvite 1、targetId 目标ID
2、callback 回调
发送会议邀请
sendOnLineMessage 1、targetId 目标ID
2、message 消息内容
3、callback 回调
发送在线消息

代码示例

//发送在线消息
imCloud.sendOnLineMessage('123456','你好',res=>{
    if(res.code==='success'){
        uni.showToast({
            title:'发送成功'
        })
    }
    if(res.code==='failed'){
        uni.showToast({
            title:'发送失败'
        })
    }
})

双人视频聊天模块

引用插件

//这个是在对方发起通话之后,在单独的一个页面进行引用的
let voipCloud = uni.requireNativePlugin('VIP-VRTCVoipCloud')

调用函数

函数名 参数 说明
startListener 1、callback 回调 监听事件
accept 1、targetId 目标ID
2、callback 回调
接听,对方调用
refuse 1、callback 回调 挂断,对方调用

监听事件

事件名 说明
hangup 对方已取消通话

代码示例

//事件监听
voipCloud.startListener(res=>{
    //对方已取消通话
    if(res.type==='hangup'){
        uni.navigateBack({
            delta:1
        })
    }
})
//拒接
voipCloud.refuse(res=>{
    if(res.code==='success'){
        uni.navigateBack({
            delta:1
        })
    }
})
//接听
voipCloud.accept(this.targetId,res=>{
    if(res.code==='success'){
        uni.redirectTo({
            url:'../call/call'
        })
    }
})

渲染视频组件

//渲染本地端
<VIP-VRTCVoipLocalPlayView
    ref="localVideo"
    @onHangup="hangup"
    @onRefuse="refuse"
    @onBusy="busy"
    @="error"
    @onNoPermission="noPermission">
</VIP-VRTCVoipLocalPlayView>
//渲染远程端
<VIP-VRTCVoipRemotePlayView></VIP-VRTCVoipRemotePlayView>

视频组件调用函数

函数名 参数 说明
hangup 1、callback 回调 挂断,双方调用
cancel 1、callback 回调 取消通话,我方调用
switchCamera 切换摄像头
setVideoEnable 1、enable 启用/禁用摄像头
setAudioEnable 1、enable 启用/禁用音频

视频组件监听事件

事件名 说明
onHangup 对方挂断
onRefuse 对方拒接
onBusy 对方正忙
通话发生错误
onNoPermission 没有给App授权(摄像头、音频)

代码示例

//取消通话,如果是接通之前调用这个挂断
this.$refs.localVideo.cancel(res=>{
    if(res.code==='success'){
        uni.navigateBack({
            delta:1
        })
    }
})
//挂断,通话正在进行中调用这个来结束通话
this.$refs.localVideo.hangup(res=>{
    if(res.code==='success'){
        uni.navigateBack({
            delta:1
        })
    }
})

多人通话模块(适用于视频会议)

//渲染本地端
<VIP-VRTCMeetingLocalPlayView
    ref="localVideo"
    @onAddPlayer="addPlayer"
    @onRemovePlayer="removePlayer"
    @onCreateSuccess="createSuccess"
    @onJoinSuccess="joinSuccess"
    @onNoPermission="noPermission"
    @onSelfKicked="selfKicked">
</VIP-VRTCMeetingLocalPlayView>
//渲染远程端
<VIP-VRTCMeetingRemotePlayView
    ref="remoteVideo" 
    v-for="(userId, index) in players" :key="index" 
    :remoteUserId="userId">
</VIP-VRTCMeetingRemotePlayView>

视频组件调用函数

函数名 参数 说明
leaveMeeting 1、callback 回调 离开会议
kickMember 1、targetId 目标ID
2、callback 回调
踢人
switchCamera 切换摄像头
setVideoEnable 1、enable 启用/禁用摄像头
setAudioEnable 1、enable 启用/禁用音频

视频组件监听事件

函数名 参数 说明
addPlayer 对方ID 新人加入
removePlayer 对方ID 有人离开
createSuccess 会议ID 创建会议成功
joinSuccess 会议ID 加入会议成功
selfKicked 被踢了
onNoPermission 没有给App授权(摄像头、音频)

远端渲染需要接收的参数

函数名 参数 说明
remoteUserId 对方ID 用于渲染对方的视频组件

代码示例

//离开会议
this.$refs.localVideo.leaveMeeting(res=>{
    if(res.code==='success'){
        uni.navigateBack({
            delta:1
        })
    }
})
//踢人
this.$refs.localVideo.kickMember('123456',res=>{
    if(res.code==='success'){
        uni.navigateBack({
            delta:1
        })
    }
})

直播模块

渲染视频组件

<VIP-VRTCVideoLivePlayView
    ref="localVideo"
    @onCreateSuccess="createSuccess"
    @Success="startSuccess"
    @onAddPlayer="addPlayer"
    @onRemovePlayer="removePlayer"
    @onApplyLink="applyLink"
    @onApplyLinkResult="applyLinkResult"
    @onWatchSuccess="watchSuccess"
    @onUploader="uploader"
    @d="closed">
</VIP-VRTCVideoLivePlayView>

视频组件监听函数

函数名 参数 说明
leaveLive 1、callback 回调 离开直播
applyToBroadcaster targetId 对方ID 观众申请连麦
agreeApplyToBroadcaster targetId 对方ID 主播同意观众连麦
refuseApplyToBroadcaster targetId 对方ID 主播拒绝对方连麦
inviteToBroadcaster targetId 对方ID 主播邀请观众连麦
agreeInviteToBroadcaster targetId 对方ID 观众同意主播连麦
refuseInviteToBroadcaster targetId 对方ID 观众拒绝主播连麦
commandToAudience targetId 对方ID 主播命令连麦者下麦
changeToBroadcaster 观众切换为连麦者

隐私、权限声明

1. 本插件需要申请的系统权限列表:

网络,摄像头,录音

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

插件不采集任何数据

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

暂无用户评论。

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问