更新记录
1.0.1(2021-04-28) 下载此版本
1.支持x86库 2.优化语音连接链路
1.0.0(2021-03-17) 下载此版本
1.实时语音通话; 2.音乐直播功能;
平台兼容性
Android | Android CPU类型 | iOS |
---|---|---|
适用版本区间:4.4 - 11.0 | armeabi-v7a:支持,arm64-v8a:支持,x86:支持 | 适用版本区间:9 - 14 |
原生插件通用使用流程:
- 购买插件,选择该插件绑定的项目。
- 在HBuilderX里找到项目,在manifest的app原生插件配置中勾选模块,如需要填写参数则参考插件作者的文档添加。
- 根据插件作者的提供的文档开发代码,在代码中引用插件,调用插件功能。
- 打包自定义基座,选择插件,得到自定义基座,然后运行时选择自定义基座,进行log输出测试。
- 开发完毕后正式云打包
付费原生插件目前不支持离线打包。
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原生插件配置”->”云端插件“列表中删除该插件重新选择
maple-rtc 实时语音SDK接口文档 - dcloud
简介:
maple-rtc 为蓝蘑云推出的实时音视频系统,包括了直播,实时音频,实时视频,变声,美颜等功能,适用于娱乐,游戏,教育等实时场景中;Maple-RTC支持快速私有化部署,一键部署上线。
一:DEMO 演示下载地址
iOS 打包的可以下载demo代码github自行打包产生;
二:下载SDK
1.1 DCloud实时语音SDK
1.2 DCloud实时语音demo源码下载
演示的DCloud 实时语音demo源码自行前往github下载;
三:基本API说明
本模块包括以下接口类:
-
音频基础接口类:使用此类接口无需关心 UI 界面层,接口封装为 Module模式 LM-mapleRTCA, 只需按照蓝蘑云的规范要求设计自己的代码逻辑即可。
-
监听事件类:包括所有底层回调给应用层的事件行为。
注意:
接口调用流程图
音频调用接口流程图:
音频,基础接口类
- initialize
- setAudioProfile
- setJoinChannelUserId
- setParameter
- getSdkVersion
- checkPermission
- joinChannel
- leaveChannel
- startLocalAudio
- stopLocalAudio
- muteLocalAudioStream
- muteRemoteAudioStream
- setEnableSpeakerphone
- adjustPlaybackSignalVolume
- adjustRecordingSignalVolume
- enableAudioVolumeIndication
初始化函数(initialize)
initialize({params}, callback(ret))
该方法用于初始化SDK。
params
appId:
- 类型:字符串
- 默认值:无
- 描述:蓝蘑云后台管理中的appId
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否设置成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.initialize({appId: "46712182****11"}, function(res){
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
设置音频属性(setAudioProfile)
setAudioProfile({params}, callback(ret))
注意事项:
- 同一频道内只能同时设置一种媒体模式;
params
audioProfile:
- 类型:字符串
- 默认值:"voiceStandard"
- 描述:音频模式,"voiceStandard" voice标准模式,"voiceHighQuality" voice高质量模式,"musicStandard" music标准模式,"musicHighQuality" music高质量模式;
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否设置成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.setAudioProfile({audioProfile: "voiceHighQuality"}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
设置加入频道用户Id(setJoinChannelUserId)
setJoinChannelUserId({params}, callback(ret))
注意事项:
- 加入频道的用户Id必须在整个appId中唯一,相同的用户Id登录会被对方踢下线;
- 用户Id为字符串,长度为小于等于32个字符;
- 该方法必须在加入频道前调用和进行设置,进入频道后无法再设置;
params
userId:
- 类型:字符串
- 默认值:无
- 描述:加入频道的用户Id
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否设置成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.setJoinChannelUserId({userId: 'abcd'}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
设置参数(setParameter)
setParameter({params})
该方法用于设置SDK特殊的参数;
params
key:
- 类型:字符串常量
- 默认值:无
- 描述:参数名字
value:
- 类型:字符串常量
- 默认值:无
- 描述:参数值
callback(ret)
无
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.setParameter({name : 'abc', value : 'abc'});
查询SDK版本号(getSdkVersion)
getSdkVersion(callback(ret))
该方法返回SDK版本号。
params
无
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
version: 200 //int类型;sdk版本号;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.getSdkVersion(function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
android获取设备权限(checkPermission)
checkPermission({params}, callback(ret))
该方法在加入房间前调用,用于获取android 麦克风,读写存储权限功能;
注意事项:
- android 没有相关系统权限,调用joinChannel 会失败;
params
无
callback(ret)
无
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.checkPermission();
带uid加入频道(joinChannel)
joinChannel({params}, callback(ret))
该方法允许用户加入频道。如果频道尚未建立,调用该方法可以自动创建频道。 同一个频道内的用户可以互相通话,多个用户加入同一个频道,可以群聊。使用不同 App ID 的应用程序是不能互通的。如果已在通话中,用户必须调用 leaveChannel() 退出当前通话,才能进入下一个频道。
注意事项:
- 该 userId 不能与AppId内现有的其他用户 userId 相同,否则AppId内持有相同 userId 用户的服务将被迫停止。
- userId 属性限制于setJoinChannelUserId(const char* uid)参数userId一样。
- 加入频道后,如果不设置参数enableMic, 麦克风默认打开;扬声器默认打开;
params
channelId:
- 类型:字符串常量
- 默认值:无
- 描述:加入频道Id
userId:
- 类型:字符串常量
- 默认值:无
- 描述:加入频道的用户Id
enableMic:
- 类型:布尔类型
- 默认值:true
- 描述:(可选项) 是否加入房间时候禁麦,默认加入房间为开麦状态
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否加入频道成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.joinChannel({channelId : '123', userId: 'abcdefg'}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
离开频道(leaveChannel)
leaveChannel({params}, callback(ret))
该方法为用户离开频道,即挂断或退出通话。通过调用 joinChannel 加入频道后,必须调用 leaveChannel() 以结束通话,否则不能进行下一次通话。 不管当前是否在通话中,都可以调用 leaveChannel(),没有副作用。leaveChannel() 会把会话相关的所有资源释放掉。
params
无
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否离开频道成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.leaveChannel(function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
开启本地音频的采集和上行(startLocalAudio)
startLocalAudio(callback(ret))
开启本地音频的采集和上行。调用该方法后,打开录音设备,在同一频道内的其他用户听到你的声音;
params
无
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否调用成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.startLocalAudio(function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
关闭本地音频的采集和上行(stopLocalAudio)
stopLocalAudio(callback(ret))
开启本地音频的采集和上行。调用该方法后,关闭录音设备,在同一频道内的其他用户将无法听到你的声音,;
params
无
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否调用成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.stopLocalAudio(function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
将自己禁音(muteLocalAudioStream)
muteLocalAudioStream({params}, callback(ret))
静音/取消静音。调用该方法后,在同一频道内的其他用户将无法听到你的声音;
params
muted:
- 类型:布尔型
- 默认值:无
- 描述:true 设置本地静音,即麦克风静音; false 取消本地静音;
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否调用成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.muteLocalAudioStream({muted : true}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
静音指定用户音频(muteRemoteAudioStream)
muteRemoteAudioStream({params}, callback(ret))
该方法用于允许/禁止播放远端指定用户的音频流。没有被禁止用户的音频流接受和播放正常;
params
userId:
- 类型:字符串常量
- 默认值:无
- 描述:加入频道的用户Id
muted:
- 类型:布尔型
- 默认值:无
- 描述:true 停止播放指定用户的音频流; false 允许播放指定用户的音频流;
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否调用成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.muteRemoteAudioStream({userId : 'abc', muted : true}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
打开外放扬声器模式(setEnableSpeakerphone)
setEnableSpeakerphone({params}, callback(ret))
该方法用于打开/关闭外放扬声器模式,即听筒和扬声器播放的切换;
params
enabled:
- 类型:布尔型
- 默认值:无
- 描述:true 切换至外放扬声器模式; false 切换至听筒模式;
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否调用成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.setEnableSpeakerphone({enabled : true}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
调节播放信号音量(adjustPlaybackSignalVolume)
adjustPlaybackSignalVolume({params}, callback(ret))
该方法用于调节播放信号音量;软件调节播放信号音量,默认值为100(原始音量),最大调整为200(即原始音量的2倍),如果为小于等于0,即软件级静音,无法听到任何远端音频流;
params
volume:
- 类型:int
- 默认值:100
- 描述:软件调节播放信号音量,默认值为100(原始音量),最大调整为200(即原始音量的2倍),如果为小于等于0,即软件级静音,无法听到任何远端音频流;
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否调用成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.adjustPlaybackSignalVolume({volume : 50}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
调节录制信号音量(adjustRecordingSignalVolume)
adjustRecordingSignalVolume({params}, callback(ret))
该方法用于调节录制信号音量(即麦克风采样音量);软件调节录制信号音量,默认值为100(原始音量),最大调整为400(即原始音量的4倍),如果为小于等于0,即软件级静音,远端用户无法听到您的声音;
params
volume:
- 类型:int
- 默认值:100
- 描述:软件调节录制信号音量,默认值为100(原始音量),最大调整为400(即原始音量的4倍),如果为小于等于0,即软件级静音,远端用户无法听到您的声音;
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否调用成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.adjustRecordingSignalVolume({volume : 50}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
启用说话音量提示(enableAudioVolumeIndication)
enableAudioVolumeIndication({params}, callback(ret))
该方法允许 SDK 定期向应用程序反馈当前房间里所有说话人状态。
注意事项:
- 在audioVolumeIndicationListener 回调事件中获得相关音量信息;
params
interval:
- 类型:int
- 默认值:无
- 描述:指定音量提示的时间间隔。<20: 禁用音量提示功能 >=20: 提示间隔,单位为毫秒。建议设置到大于 500 毫秒
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否调用成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.enableAudioVolumeIndication({interval : 500}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
媒体播放接口类
- startPlayMedia
- stopPlayMedia
- pausePlayMedia
- mutePlayMedia
- adjustPlayMediaVolume
- setPlayMediaPosition
- getPlayMediaTotalDuration
- getPlayMediaCurrentPosition
开始播放媒体文件(startPlayMedia)
startPlayMedia({params}, callback(ret))
注意事项:
- 该方法必须在加入频道joinChannel后才可以调用,进入频道前无法调用;
params
path:
- 类型:字符串常量
- 默认值:无
- 描述:需要混音的本地媒体文件名和网络文件路径;支持mp3,wav,mp4;
type:
- 类型:int
- 默认值:无
- 描述:媒体文件播放类型, 1:音频仅广播; 2:音频仅本地播放; 3:音频即本地播放同时也广播;
cycle:
- 类型:int
- 默认值:无
- 描述:播放次数,-1为循环播放;
index:
- 类型:int
- 默认值:-1
- 描述:可选项,媒体播放id,设置为不同的值,支持多个音频文件同时播放;
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否调用成功;
}
示例代码1
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.startPlayMedia({path: "http://share.lmaple.com/test.mp3", type:3, cycle:1}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
停止媒体播放(stopPlayMedia)
stopPlayMedia({params}, callback(ret))
注意事项:
- 该方法必须在加入频道joinChannel成功后才可以调用,进入频道前无法调用;
params
index:
- 类型:int
- 默认值:-1
- 描述:可选项,媒体播放id,设置为不同的值,支持多个音频文件同时播放;
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否调用成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.stopPlayMedia({}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
暂停媒体播放(pausePlayMedia)
pausePlayMedia({params}, callback(ret))
注意事项:
- 该方法必须在加入频道joinChannel后才可以调用,进入频道前无法调用;
params
paused:
- 类型:布尔型
- 默认值:false 关闭
- 描述:true 暂停播放; false 恢复播放;
index:
- 类型:int
- 默认值:-1
- 描述:可选项,媒体播放id,设置为不同的值,支持多个音频文件同时播放;
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否调用成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.pausePlayMedia({paused : true}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
静音媒体播放(mutePlayMedia)
mutePlayMedia({params}, callback(ret))
注意事项:
- 该方法必须在加入频道joinChannel后才可以调用,进入频道前无法调用;
params
muted:
- 类型:布尔型
- 默认值:false 关闭
- 描述:true 静音; false 恢复播放;
index:
- 类型:int
- 默认值:-1
- 描述:可选项,媒体播放id,设置为不同的值,支持多个音频文件同时播放;
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否调用成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.mutePlayMedia({muted : true}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
调整媒体播放音量(adjustPlayMediaVolume)
adjustPlayMediaVolume({params}, callback(ret))
注意事项:
- 该方法必须在加入频道joinChannel后才可以调用,进入频道前无法调用;
params
volume:
- 类型:int
- 默认值:100
- 描述:音量值,最大值为100;
index:
- 类型:int
- 默认值:-1
- 描述:可选项,媒体播放id,设置为不同的值,支持多个音频文件同时播放;
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否调用成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.adjustPlayMediaVolume({volume : 50}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
设置媒体播放位置(setPlayMediaPosition)
setPlayMediaPosition({params}, callback(ret))
注意事项:
- 该方法必须在加入频道joinChannel后才可以调用,进入频道前无法调用;
params
position:
- 类型:int
- 默认值:无
- 描述:文件位置值,单位毫秒;
index:
- 类型:int
- 默认值:-1
- 描述:可选项,媒体播放id,设置为不同的值,支持多个音频文件同时播放;
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
status: true //布尔类型;true||false,是否调用成功;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.setPlayMediaPosition({position : 10000}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
获取媒体播放总时长(getPlayMediaTotalDuration)
getPlayMediaTotalDuration({params}, callback(ret))
注意事项:
- 该方法必须在加入频道joinChannel后才可以调用,进入频道前无法调用;
params
index:
- 类型:int
- 默认值:-1
- 描述:可选项,媒体播放id,设置为不同的值,支持多个音频文件同时播放;
callback(ret)
duration:
- 类型:JSON对象
- 描述:媒体文件总时长,单位毫秒
内部字段:
{
duration: 159000 //媒体文件总时长;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.getPlayMediaTotalDuration({}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
获取媒体播放实时位置(getPlayMediaCurrentPosition)
getPlayMediaCurrentPosition({params}, callback(ret))
注意事项:
- 该方法必须在加入频道joinChannel后才可以调用,进入频道前无法调用;
params
index:
- 类型:int
- 默认值:-1
- 描述:可选项,媒体播放id,设置为不同的值,支持多个音频文件同时播放;
callback(ret)
position:
- 类型:JSON对象
- 描述:媒体文件实时位置,单位毫秒
内部字段:
{
duration: 10000 //媒体文件实时位置;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.getPlayMediaCurrentPosition({}, function(ret) {
uni.showToast({ title: JSON.stringify(ret), icon:'none'});
});
监听事件接口类
添加监听事件(addEventListen)
addEventListen({params}, callback(ret))
params
name:
- 类型:字符串
- 默认值:无
- 描述:sdk事件名称(详见事件)
callback(ret)
ret:
- 类型:JSON对象
- 描述:事件发生时回调的参数
示例代码
//监听用户加入频道成功事件
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.addEventListen({
name:'joinChannelSuccessListener'
},function(ret){
//operation
});
移除事件监听(removeEventListen)
removeEventListen({params})
该方法用于移除事件监听;
params
name:
- 类型:字符串
- 默认值:无
- 描述:sdk事件名称(详见事件)
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.removeEventListen({
name: 'joinChannelSuccessListener'
});
移除所有的事件监听(removeAllEventListens)
removeAllEventListens()
该方法用于移除所有的事件监听;
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.removeAllEventListens();
监听事件
- joinChannelSuccessListener
- joinChannelFailedListener
- connectionLostListener
- leaveChannelListener
- forceKickOutChannelListener
- audioVolumeIndicationListener
- userJoinedNoticeListener
- userOfflineNoticeListener
- mediaStopListener
- warningListener
- errorListener
加入频道成功监听事件(joinChannelSuccessListener)
callback(ret)
表示客户端登入服务器成功,且创建和分配了频道 ID 和用户 ID。
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
channelId: 'abc' //字符串类型;加入成功后频道Id;
uid: 'abc' //字符串类型;加入成功后用户Id;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.addEventListen({
name:'joinChannelSuccessListener'
},function(ret){
//operation
});
加入频道失败监听事件(joinChannelFailedListener)
callback(ret)
表示客户端登入服务器失败监听事件;
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
reason: 4001 //int类型;(详见 回调状态码)
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.addEventListen({
name:'joinChannelFailedListener'
},function(ret){
//operation
});
连接丢失监听事件(connectionLostListener)
callback(ret)
连接丢失监听事件;sdk 和服务器失去了网络连接,并且尝试自动重连一段事件(15s左右)后仍未连上。回调该事件后,sdk将不会再次自动重连,需要用户手动调用leaveChannel,后再次尝试加入频道;
callback(ret)
ret:
- 类型:JSON对象
内部字段: 空
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.addEventListen({
name:'connectionLostListener'
},function(ret){
//operation
});
离开频道监听事件(leaveChannelListener)
callback(ret)
用程序调用 leaveChannel() 方法时,SDK提示应用程序离开频道成功或者失败。参数reason表示具体原因状态码。
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
reason: 200 //int类型;(详见 回调状态码)
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.addEventListen({
name:'leaveChannelListener'
},function(ret){
//operation
});
强行踢下线监听事件(forceKickOutChannelListener)
callback(ret)
由于某种原因,自己强行被系统踢下线。参数reason表示具体原因状态码。
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
reason: 200 //int类型;(详见 回调状态码)
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.addEventListen({
name:'forceKickOutChannelListener'
},function(ret){
//operation
});
本地音量监听事件(audioVolumeIndicationListener)
callback(ret)
该回调允许 SDK 定期向应用程序反馈房间里所有用户的音量信息。该提示默认为关闭状态,如有需要,调用 enableAudioVolumeIndication() 方法触发该提示。
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
totalVolume: 100, //int 类型; 房间里总音量, 值为0~255;
volumeInfo: "[{uid:"abc",volume:10}, {uid:"abcd",volume:90}]"
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.addEventListen({
name:'audioVolumeIndicationListener'
},function(ret){
//operation
});
用户加入频道监听事件(userJoinedNoticeListener)
callback(ret)
提示有用户加入了频道。如果该客户端加入频道时已经有人在频道中,SDK也会向应用程序上报这些已在频道中的全部用户。
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
uids: ['abc','dfg'], //字符串数组类型; 全部进入频道的用户id集;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.addEventListen({
name:'userJoinedNoticeListener'
},function(ret){
//operation
});
用户离开当前频道监听事件(userOfflineNoticeListener)
callback(ret)
提示有用户离开了频道(或掉线)。
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
uids: ['abc','dfg'], //字符串数组类型; 离开频道的用户id;
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.addEventListen({
name:'userOfflineNoticeListener'
},function(ret){
//operation
});
媒体播放结束监听事件(mediaStopListener)
callback(ret)
提示媒体播放结束。
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
path: "http://share.lmaple.com/test.mp3", //播放路径;
index: -1 //媒体index
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.addEventListen({
name:'mediaStopListener'
},function(ret){
//operation
});
警告监听事件(warningListener)
callback(ret)
该回调事件表示 SDK 运行时出现了(网络或媒体相关的)警告。 通常情况下,SDK上报的警告信息应用程序可以忽略,SDK 会自动恢复。
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
reason: 200 //int类型;(详见 回调状态码)
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.addEventListen({
name:'warningListener'
},function(ret){
//operation
});
错误监听事件(errorListener)
callback(ret)
表示 SDK 运行时出现了(网络或媒体相关的)错误。 通常情况下,SDK 上报的错误意味着 SDK 无法自动恢复,需要 APP 干预或提示用户。
callback(ret)
ret:
- 类型:JSON对象
内部字段:
{
reason: 200 //int类型;(详见 回调状态码)
}
示例代码
const maplertc = uni.requireNativePlugin('LM-mapleRTCA');
maplertc.addEventListen({
name:'errorListener'
},function(ret){
//operation
});
回调状态码
状态码 | 值 | 描述 |
---|---|---|
KC_StatusOk | 200 | 状态正常 |
KC_JoinChannelFailed | 4000 | 加入频道失败 |
KC_LoginSignalServerFailed | 4001 | 登录信令服务器失败 |
KC_ConnectMediaServerFailed | 4003 | 连接媒体服务器失败 |
KC_AppIdInvalid | 4005 | 无效的AppId或者过期 |
KC_HttpRequestFailed | 4006 | AppId被禁用 |
KC_PermissionFailed | 4007 | 设备没有麦克风权限 |
KC_LeaveChannelFailed | 4100 | 离开频道失败 |
KC_KickedOutReLogin | 4200 | 相同userId用户登录,服务器强行踢出当前用户 |
KC_KickedOutTimeOut | 4201 | 客户端长时间未通知服务器状态,服务器强行踢出当前用户 |