tencentTrtcMeeting

来自于：厦门软云网络科技有限公司立即使用

腾讯云多人视频会议

腾讯云实时语音, 提供多人视频会议功能，可以实现远程会议，实现类似腾讯会议和Zoom等类似功能。

论坛示例

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

技术支持

如果您有以下需求：

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

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

接口列表

初始化与监听

接口列表 功能
init 初始化
setMeetingListener 设置监听器
removeMeetingListener 移除监听器
destroy 销毁

登录与登出

接口列表 功能
login 登录
logout 登出
setSelfProfile 修改个人信息

会议房间

接口列表 功能
createMeeting 创建会议
destroyMeeting 销毁会议房间
enterMeeting 进入会议
leaveMeeting 离开会议

远端用户接口

接口列表 功能
getUserInfoList 获取房间内所有的人员列表
getUserInfo 获取房间内指定人员的详细信息
startRemoteView 播放指定成员的远端视频画面
stopRemoteView 停止渲染远端视频画面

本地视频操作

接口列表 功能
startCameraPreview 开启本地视频的预览画面
stopCameraPreview 停止本地视频采集及预览
switchCamera 切换前后摄像头
setVideoResolution 设置分辨率

本地音频操作

接口列表 功能
startMicrophone 开启麦克风采集
stopMicrophone 停止麦克风采集
setAudioQuality 设置音质
muteLocalAudio 静音/取消静音本地的音频
setSpeaker 设置开启扬声器

分享接口

接口列表 功能
getLiveBroadcastingURL 获取CDN分享链接

消息发送

接口列表 功能
sendRoomTextMsg 在房间中广播文本消息
sendRoomCustomMsg 发送自定义文本消息

模块接口

加载模块

var meeting = api.require('tencentTrtcMeeting');

init

初始化

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

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

代码示例

meeting.init({}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setMeetingListener

设置监听

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

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    eventType: "onRoomInfoChange",
    ...
}

|事件回调|回调含义| |onRoomInfoChange|进房成功后会回调该接口|

示例代码

meeting.setMeetingListener({}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

removeMeetingListener

移除监听器

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

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.removeMeetingListener({}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

destroy

销毁

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

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.destroy({}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(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: '错误描述'     // 字符串类型, 错误信息
}

示例代码

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

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

logout

登出

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

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.logout({}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(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: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.setSelfProfile({
    nickName: nickName,
    avatarUrl: avatarUrl
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

createMeeting

创建会议（主持人调用）

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

params

roomId:

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

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.createMeeting({
    roomId: roomId
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

destroyMeeting

销毁会议房间（主持人调用）

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

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.destroyMeeting({
    roomId: roomId
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

enterMeeting

进入会议（参会成员调用）

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

params

roomId:

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

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

metting.enterMeeting({
    roomId: roomId,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

leaveMeeting

离开会议（参会成员调用）

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

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

metting.leaveMeeting({}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

getUserInfoList

获取房间内所有的人员列表

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

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.getUserInfoList({}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

getUserInfo

获取房间内指定人员的详细信息

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

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.getUserInfo({
    userId: userId
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

startRemoteView

播放指定成员的远端视频画面

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

params

userId:

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

rect:

  • 类型: JSON对象
  • 描述: (必填项)视频的位置和大小

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

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

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

stopRemoteView

停止渲染远端视频画面

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

params

userId:

  • 类型: 字符串类型
  • 描述: (必填项)需要停止播放的用户Id

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.stopRemoteView({
    userId: remoteUserId
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(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: '错误描述'     // 字符串类型, 错误信息
}

示例代码

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

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

stopCameraPreview

停止本地视频采集及预览

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

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.stopCameraPreview({}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

switchCamera

切换前后摄像头

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

params

isFront:

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

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.switchCamera({
    isFront: isFront
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setVideoResolution

设置分辨率

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

params

resolution:

  • 类型: 整数类型
  • 描述: (必填项)视频分辨率

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.setVideoResolution({
    resolution: resolution
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

startMicrophone

开启麦克风采集

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

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.startMicrophone({}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

stopMicrophone

停止麦克风采集

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

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.stopMicrophone({}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setAudioQuality

设置音质

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

params

quality:

  • 类型: 整数类型
  • 描述: (必填项)音频质量

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.setAudioQuality({
    quality: audioQuality
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(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: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.muteLocalAudio({
    isMute: isMute
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

setSpeaker

设置开启扬声器

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

params

isSpeaker:

  • 类型: 布尔类型
  • 描述: (必填项) true：扬声器 ；false：听筒

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.setSpeaker({
    isSpeaker: isUseSpeaker
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

getLiveBroadcastingURL

获取 CDN 分享链接

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

callback

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

meeting.getLiveBroadcastingURL({}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(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: '错误描述'     // 字符串类型, 错误信息
}

示例代码

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

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

sendRoomCustomMsg

发送自定义文本消息

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

params

ret:

  • 类型: JSON对象
  • 内部字段: 
{
    status: true     // 布尔类型, true表示操作成功
}

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: -911,        // 整数类型, 错误码
    msg: '错误描述'     // 字符串类型, 错误信息
}

示例代码

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

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

技术支持

如果您有以下需求：

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

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