mwTencentRTC

registerApp loginRTC joinRoom quitRoom

概述

进入腾讯云音视频的入口进行开通,目前有测试套餐

腾讯云音视频入口

购买后 进入后台在账号信息中 应用基本信息的 SDKAppid 为 config.xml 配置中的 SDKAppID accountType 为 用户的账号类型 (非必须) 使用过程中有任何疑问可以发工单,论坛发帖

使用此模块之前需要先配置 config.xml 文件,配置完毕,需通过云端编译生效,配置方法如下:

名称:

  • MWTencentRTC // key

参数:

参数描述
SDKAppIDSDK的id
accountTypeSDK的type

示例代码

  1. <feature name="MWTencentRTC">
  2. <param name="SDKAppID" value="SDK20181621040845si2pd4ksxnrd3xt"/>
  3. <param name="accountType" value="SDK20181621040845si2pd4ksxnrd3xt" />
  4. </feature>

registerApp

手动注册

registerApp({params}, callback(ret, err))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: //布尔类型,是否成功
  3. }

示例代码

  1. var mwTencentRTC = api.require('mwTencentRTC');
  2. mwTencentRTC.registerApp({
  3. }, function (ret, err) {
  4. if (ret) {
  5. alert(JSON.stringify(ret));
  6. } else {
  7. alert(JSON.stringify(err));
  8. }
  9. });

可用性

Android系统 ios系统

loginRTC

登录

loginRTC({params}, callback(ret, err))

params

userName:

  • 类型:字符串
  • 描述:用户名
  • 默认值:空

userSig:

  • 类型:字符串
  • 描述:签名
  • 默认值:空

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: //布尔类型,是否成功
  3. errId: '', //int类型 (数据请求失败编号)
  4. errMsg: '', //字符串类型(数据请求失败描述)
  5. }

示例代码

  1. var mwTencentRTC = api.require('mwTencentRTC');
  2. mwTencentRTC.loginRTC({
  3. userName:@"",
  4. userSig:@"",
  5. }, function (ret, err) {
  6. if (ret) {
  7. alert(JSON.stringify(ret));
  8. } else {
  9. alert(JSON.stringify(err));
  10. }
  11. });

可用性

Android系统 iOS 系统

joinRoom

加入房间 roomID 不存在时会自动创建房间

joinRoom({params}, callback(ret, err))

params

roomID:

  • 类型:字符串
  • 描述:房间id
  • 默认值:空

privateMapKey:

  • 类型:字符串
  • 描述:房间加密的key
  • 默认值:空

role:

  • 类型:字符串
  • 描述:角色
  • 默认值:空

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: //布尔类型,是否成功
  3. errId: '', //int类型 (数据请求失败编号)
  4. eventType: '', //视图类型 viewTypeMy viewTypeOther
  5. errMsg: '', //字符串类型(数据请求失败描述)
  6. }

示例代码

  1. var mwTencentRTC = api.require('mwTencentRTC');
  2. mwTencentRTC.joinRoom({
  3. roomID:@"",
  4. }, function (ret, err) {
  5. if (ret) {
  6. alert(JSON.stringify(ret));
  7. } else {
  8. alert(JSON.stringify(err));
  9. }
  10. });

可用性

Android系统 iOS系统

quitRoom

退出房间

quitRoom({params}, callback(ret, err))

params

roomID:

  • 类型:字符串
  • 描述:房间id
  • 默认值:空

privateMapKey:

  • 类型:字符串
  • 描述:房间加密的key
  • 默认值:空

role:

  • 类型:字符串
  • 描述:角色
  • 默认值:空

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: //布尔类型,是否成功
  3. errId: '', //int类型 (数据请求失败编号)
  4. errMsg: '', //字符串类型(数据请求失败描述)
  5. }

示例代码

  1. var mwTencentRTC = api.require('mwTencentRTC');
  2. mwTencentRTC.quitRoom({
  3. }, function (ret, err) {
  4. if (ret) {
  5. alert(JSON.stringify(ret));
  6. } else {
  7. alert(JSON.stringify(err));
  8. }
  9. });

可用性

Android系统 iOS系统