tencentTrtcLiveRoom

腾讯云视频互动直播

腾讯云视频互动直播插件，提供互动直播的功能，包括直播、连麦PK、主播 PK、低延时观看、弹幕聊天等在互动直播场景下的相关能力。

论坛示例

该论坛提供了插件使用示例入口，您可以在论坛中找到使用的Demo，以及问题反馈。

技术支持

如果您有以下需求：

• 方案咨询；
• 接入流程协助；
• 测试DEMO功能；
• 内测功能；
• 问题反馈；
• 需求反馈；

音视频产品使用复杂程度高，可以先联系我们，获取技术支持，微信号为: ruanyunkeji001或ruanyunkeji002

接口列表

初始化与监听

登录与登出

房间接口

推拉流相关

主播和观众连麦

主播跨房间 PK

音视频控制

背景音乐音效

基础美颜

消息发送

插件接口

加载插件

var liveRoom = api.require('RYTencentTrtcLiveRoom');

init

初始化

init({}, function(ret, err))

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

##代码示例

liveRoom.init({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setLiveRoomListener

设置监听器

setLiveRoomListener({}, function(ret, err))

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

{
    eventType: 'onAnchorEnter'
}

• 字段详情:

eventType:

• 类型: 字符串类型
• 描述: 事件名称
• 事件详情:

房间事件回调:

主播和观众进出事件回调

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

liveRoom.setLiveRoomListener({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

removeLiveRoomListener

移除监听器

removeLiveRoomListener({}, function(ret, err))

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

liveRoom.removeLiveRoomListener({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

destroy

销毁

destroy({}, function(ret, err))

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

liveRoom.destroy({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

login

登录

login({params}, function(ret, err))

params

sdkAppId:

• 类型: 整数类型
• 描述: (必填项)在实时音视频控制台 >【应用管理】> 应用信息中查看

userId:

• 类型: 字符串类型
• 描述: (必填项)当前用户的Id

userSig:

• 类型: 字符串
• 描述: (必填项)用户签名

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var sdkAppId = 1400387416;
var userId = 'test001';
var userSig = 'eJwtzExxxxxizphb3L40HQ';

liveRoom.login({
    sdkAppId: sdkAppId,
    userId: userId,
    userSig: userSig
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

logout

登出

logout({}, function(ret, err))

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

liveRoom.logout({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setSelfProfile

修改个人信息

setSelfProfile({params}, function(ret, err))

params

userName:

• 类型: 字符串类型
• 描述: (可选项)昵称

avatarUrl:

• 类型: 字符串类型
• 描述: (可选项)头像地址

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var userName = 'userName';
var avatarUrl = 'http://xxxx.myqcloud.com/xxxx.png';

liveRoom.setSelfProfile({
    userName: userName,
    avatarUrl: avatarUrl
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

createRoom

创建房间(主播调用)

createRoom({params}, function(ret, err))

params

roomId:

• 类型: 字符串类型
• 描述: (必填项)房间标识，需要由您分配并进行统一管理

roomName:

• 类型: 字符串类型
• 描述: (必填项)房间名称

coverUrl:

• 类型: 字符串类型
• 描述: (必填项)封面信息

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var roomId = 1;
var roomName = 'room01';
var coverUrl = 'https://xxxx.myqcloud.com/cover001.jpg';

liveRoom.createRoom({
    roomId: roomId,
    roomName: roomName,
    coverUrl: coverUrl
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

destroyRoom

销毁房间(主播调用)

destroyRoom({}, function(ret, err))

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

liveRoom.destroyRoom({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

enterRoom

创建房间(主播调用)

enterRoom({params}, function(ret, err))

params

roomId:

• 类型: 字符串类型
• 描述: (必填项)房间标识，需要由您分配并进行统一管理

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var roomId = 1001;

liveRoom.enterRoom({
    roomId: roomId,
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

exitRoom

离开房间

exitRoom({}, function(ret, err))

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

liveRoom.exitRoom({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

getRoomInfos

获取房间列表的详细信息

getRoomInfos({params}, function(ret, err))

params

roomIdList:

• 类型: 数组类型
• 描述: (必填项)房间号列表

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true, 	// 布尔类型, true表示操作成功
    roomList: [
        ...
    ]
}

• 字段详情:

roomList:

• 类型: JSON数组
• 描述: 房间列表详细信息

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var roomIdList = [1001];

liveRoom.getRoomInfos({
    roomIdList: roomIdList
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

getAnchorList

获取房间内所有的主播列表

getAnchorList({}, function(ret, err))

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true, 	// 布尔类型, true表示操作成功
    userList: [
        ...
    ]
}

• 字段详情:

userList:

• 类型: JSON数组
• 描述: 主播列表

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

liveRoom.getAnchorList({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

getAudienceList

获取房间内所有的观众信息

getAudienceList({}, function(ret, err))

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true, 	// 布尔类型, true表示操作成功
    userList: [
        ...
    ]
}

• 字段详情:

userList:

• 类型: JSON数组
• 描述: 观众信息列表

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

liveRoom.getAudienceList({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

startCameraPreview

开启本地视频的预览画面

startCameraPreview({params}, function(ret, err))

params

isFront:

• 类型: 布尔类型
• 描述: (必填项)true：前置摄像头；false：后置摄像头

rect:

• 类型: JSON对象类型
• 描述: (必填项)视频显示的坐标和大小

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var isFront = true;

liveRoom.startCameraPreview({
    isFront: isFront,
    rect: {
        x: 0,
        y: 0,
        w: api.winWidth / 2,
        h: api.winHeight / 2
    }
}, function(ret) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

stopCameraPreview

停止本地视频采集及预览

stopCameraPreview({}, function(ret, err))

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

function stopCameraPreview() {
    liveRoom.stopCameraPreview({}, function(ret, err) {
        if (ret) {
            api.alert({msg: JSON.stringify(ret)});
        } else {
            api.alert({msg: JSON.stringify(err)});
        }
    });
}

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

startPublish

开始直播(推流)

startPublish({params}, function(ret, err))

params

streamId:

• 类型: 字符串类型
• 描述: (必填项)用于绑定直播 CDN 的 streamId

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var streamId = 'stream01';

liveRoom.startPublish({
    streamId: streamId
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

stopPublish

停止直播(推流)

stopPublish({}, function(ret, err))

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

liveRoom.stopPublish({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

startPlay

播放远端视频画面

startPlay({params}, function(ret, err))

params

userId:

• 类型: 字符串类型
• 描述: (必填项)需要观看的用户Id

rect:

• 类型: JSON对象类型
• 描述: (必填项)视频显示区域坐标和大小

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var remoteUserId = 'test002';

liveRoom.startPlay({
    userId: remoteUserId,
    rect: {
        x: 0,
        y: 0,
        w: api.winWidth / 2,
        h: api.winHeight / 2
    }
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

stopPlay

停止渲染远端视频画面

stopPlay({params}, function(ret, err))

params

userId:

• 类型: 字符串类型
• 描述: (必填项)需要观看的用户Id

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var remoteUserId = 'test002';

liveRoom.stopPlay({
    userId: remoteUserId
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

requestJoinAnchor

观众请求连麦

requestJoinAnchor({params}, function(ret, err))

params

reason:

• 类型: 字符串类型
• 描述: (必填项)连麦原因

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var reason = 'this is a reason';

liveRoom.requestJoinAnchor({
    reason: reason
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

responseJoinAnchor

主播处理连麦请求

responseJoinAnchor({params}, function(ret, err))

params

userId:

• 类型: 字符串类型
• 描述: (必填项)观众Id

isAgree:

• 类型: 布尔类型
• 描述: (必填项)true：同意；false：拒绝

reason:

• 类型: 字符串类型
• 描述: (必填项)同意/拒绝连麦的原因描述

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var remoteUserId = 'test002';
var isAgree = true;
var reason = 'this is a reason';

liveRoom.responseJoinAnchor({
    userId: remoteUserId,
    isAgree: isAgree,
    reason: reason
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

kickoutJoinAnchor

主播踢除连麦观众

kickoutJoinAnchor({params}, function(ret, err))

params

userId:

• 类型: 字符串类型
• 描述: (必填项)连麦观众Id

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var remoteUserId = 'test002';

liveRoom.kickoutJoinAnchor({
    userId: remoteUserId
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

requestRoomPK

主播请求跨房PK

requestRoomPK({params}, function(ret, err))

params

roomId:

• 类型: 字符串类型
• 描述: (必填项)被邀约房间Id

roomName:

• 类型: 字符串类型
• 描述: (必填项)被邀约主播Id

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var remoteUserId = 'test002';
var remoteRoomId = 1002;

liveRoom.requestRoomPK({
    roomId: remoteRoomId,
    userId: remoteUserId
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

responseRoomPK

主播响应跨房PK请求

responseRoomPK({params}, function(ret, err))

params

userId:

• 类型: 字符串类型
• 描述: (必填项)发起PK请求的主播Id

isAgree:

• 类型: 布尔类型
• 描述: (必填项)true：同意；false：拒绝

reason:

• 类型: 字符串类型
• 描述: (必填项)同意/拒绝PK的原因描述

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var remoteUserId = 'test002';
var isAgree = true;
var reason = 'this is a reason';

liveRoom.responseRoomPK({
    userId: remoteUserId,
    isAgree: isAgree,
    reason: reason
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

quitRoomPK

退出跨房PK

quitRoomPK({}, function(ret, err))

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

liveRoom.quitRoomPK({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

switchCamera

切换前后摄像头

switchCamera({}, function(ret, err))

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

liveRoom.switchCamera({}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setMirror

设置是否镜像展示

setMirror({params}, function(ret, err))

params

isMirror:

• 类型: 布尔类型
• 描述: (必填项)开启/关闭镜像

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var isMirror = true;

liveRoom.setMirror({
    isMirror: isMirror
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

muteLocalAudio

静音本地音频

muteLocalAudio({params}, function(ret, err))

params

isMute:

• 类型: 布尔类型
• 描述: (必填项)true：开启静音；false：关闭静音

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var isMute = true;

liveRoom.muteLocalAudio({
    isMute: self.isMute
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

muteRemoteAudio

静音远端音频

muteRemoteAudio({params}, function(ret, err))

params

isMute:

• 类型: 布尔类型
• 描述: (必填项) true：开启静音；false：关闭静音

userId:

• 类型: 字符串类型
• 描述: (必填项)远端的用户Id

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var isMute = true;

liveRoom.muteRemoteAudio({
    userId: remoteUserId,
    isMute: isMute
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

muteAllRemoteAudio

静音远端音频

muteAllRemoteAudio({params}, function(ret, err))

params

isMute:

• 类型: 布尔类型
• 描述: (必填项) true：开启静音；false：关闭静音

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var isMute = true;

liveRoom.muteAllRemoteAudio({
    isMute: isMute
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setVoiceReverbType

设置人声的混响效果

setVoiceReverbType({params}, function(ret, err))

params

mode:

• 类型: 整数类型
• 描述: (必填项)混响效果

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var reverbType = 2;

liveRoom.setVoiceReverbType({
    mode: reverbType
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setVoiceChangerType

设置人声的变声特效

setVoiceChangerType({params}, function(ret, err))

params

mode:

• 类型: 整数类型
• 描述: (必填项)变声类型

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var changerType = 2;

liveRoom.setVoiceChangerType({
    mode: changerType
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setVoiceCaptureVolume

设置麦克风采集人声的音量

setVoiceCaptureVolume({params}, function(ret, err))

params

volume:

• 类型: 整数类型
• 描述: (必填项)音量大小

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var volume = 20;

liveRoom.setVoiceCaptureVolume({
    volume: volume
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setMusicListener

设置音乐监听

setMusicListener({}, function(ret, err))

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

{
    eventType: 'onProgress',
    progressMs: 1200,
    durationMs: 12000
}

• 字段详情:

eventType:

• 类型: 字符串类型
• 描述: 事件名称
• 取值范围:
  • onStart: 播放开始回调
  • onProgress: 播放进度回调
  • onComplete: 播放结束回调

progressMs:

• 类型: 整数类型
• 描述: 播放进度

durationMs:

• 类型: 整数类型
• 描述: 音乐时长

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var id = 10;

liveRoom.setMusicListener({
    id: id
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

removeMusicListener

移除音乐监听

removeMusicListener({}, function(ret, err))

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var id = 12;

liveRoom.removeMusicListener({
    id: id
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

startPlayMusic

开始播放背景音乐

startPlayMusic({params}, function(ret, err))

params

id:

• 类型: 字符串类型
• 描述: (必填项)房间标识，需要由您分配并进行统一管理

path:

• 类型: 字符串类型
• 描述: (必填项)背景音乐文件地址

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var id = 12;
var path = 'http://bgm-1252463788.cos.ap-guangzhou.myqcloud.com/keluodiya.mp3';

liveRoom.startPlayMusic({
    id: id,
    path: bgmPath
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

stopPlayMusic

停止播放背景音乐

stopPlayMusic({params}, function(ret, err))

params

id:

• 类型: 整数类型
• 描述: (必填项)音乐Id

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var id = 12;

liveRoom.stopPlayMusic({
    id: id
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

pausePlayMusic

暂停播放背景音乐

pausePlayMusic({params}, function(ret, err))

params

id:

• 类型: 整数类型
• 描述: (必填项)音乐Id

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var id = 12;

liveRoom.pausePlayMusic({
    id: id
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

resumePlayMusic

恢复播放背景音

resumePlayMusic({params}, function(ret, err))

params

id:

• 类型: 整数类型
• 描述: (必填项)音乐Id

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var id = 12;

liveRoom.resumePlayMusic({
    id: id
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setBeautyStyle

恢复播放背景音

setBeautyStyle({params}, function(ret, err))

params

mode:

• 类型: 整数类型
• 描述: (必填项)美颜风格

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var beautyStyle = 1;

liveRoom.setBeautyStyle({
    mode: beautyStyle
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setBeautyLevel

设置美颜级别

setBeautyLevel({params}, function(ret, err))

params

level:

• 类型: 整数类型
• 描述: (必填项)美颜级别

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var beautyLevel = 0;

liveRoom.setBeautyLevel({
    level: beautyLevel
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setWhitenessLevel

设置美白级别

setWhitenessLevel({params}, function(ret, err))

params

level:

• 类型: 整数类型
• 描述: (必填项)美颜级别

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var whitenessLevel = 0;

liveRoom.setWhitenessLevel({
    level: whitenessLevel
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setRuddyLevel

设置红润级别

setRuddyLevel({params}, function(ret, err))

params

level:

• 类型: 整数类型
• 描述: (必填项)美颜级别

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var ruddyLevel = 2;

liveRoom.setRuddyLevel({
    level: ruddyLevel
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setFilter

设置指定素材滤镜特效

setFilter({params}, function(ret, err))

params

img:

• 类型: 字符串类型
• 描述: (必填项)素指定素材，即颜色查找表图片

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var filterImg = 'xxxx';

liveRoom.setFilter({
    img: filterImg
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setFilterStrength

设置滤镜浓度

setFilterStrength({params}, function(ret, err))

params

strength:

• 类型: 浮点数类型
• 描述: (必填项)滤镜浓度

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var filterStrength = 0.2;

liveRoom.setFilterStrength({
    strength: filterStrength
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

sendRoomTextMsg

在房间中广播文本消息

sendRoomTextMsg({params}, function(ret, err))

params

msg:

• 类型: 字符串类型
• 描述: (必填项)文本消息

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var msg = 'Hello world';

liveRoom.sendRoomTextMsg({
    msg: msg
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

sendRoomCustomMsg

发送自定义文本消息

sendRoomCustomMsg({params}, function(ret, err))

params

cmd:

• 类型: 字符串类型
• 描述: (必填项)命令字，由开发者自定义，主要用于区分不同消息类型

msg:

• 类型: 字符串类型
• 描述: (必填项)文本消息

callback

ret:

• 类型: JSON对象
• 内部字段:

{
    status: true 	// 布尔类型, true表示操作成功
}

err:

• 类型: JSON对象
• 内部字段:

{
    code: -911, 	   // 整数类型, 错误码
    msg: '错误描述' 	// 字符串类型, 错误信息
}

示例代码

var cmd = 'CMD_LIKE';
var msg = 'Hello world';

liveRoom.sendRoomCustomMsg({
    cmd: cmd,
    msg: msg
}, function(ret, err) {
    if (ret) {
        api.alert({msg: JSON.stringify(ret)});
    } else {
        api.alert({msg: JSON.stringify(err)});
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本