mwTencentRTC

来自于:开发者立即使用

概述

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

名称:

  • MWTencentRTC // key

参数:

参数 描述
SDKAppID SDK的id
accountType SDK的type

示例代码

    <feature name="MWTencentRTC">
        <param name="SDKAppID" value="SDK20181621040845si2pd4ksxnrd3xt"/>
        <param name="accountType" value="SDK20181621040845si2pd4ksxnrd3xt" />
    </feature>

registerApp

手动注册

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

callback(ret)

ret:

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

示例代码

        var mwTencentRTC = api.require('mwTencentRTC');
        mwTencentRTC.registerApp({

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

可用性

Android系统 ios系统

loginRTC

登录

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

params

userName:

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

userSig:

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

callback(ret)

ret:

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

示例代码

   var mwTencentRTC = api.require('mwTencentRTC');
   mwTencentRTC.loginRTC({
           userName:@"",
           userSig:@"",
   }, function (ret, err) {
         if (ret) {
             alert(JSON.stringify(ret));
         } else {
             alert(JSON.stringify(err));
          }
   });

可用性

Android系统 iOS 系统

joinRoom

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

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

params

roomID:

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

privateMapKey:

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

role:

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

callback(ret)

ret:

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

示例代码

   var mwTencentRTC = api.require('mwTencentRTC');
   mwTencentRTC.joinRoom({
           roomID:@"",
   }, function (ret, err) {
         if (ret) {
             alert(JSON.stringify(ret));
         } else {
             alert(JSON.stringify(err));
          }
   });

可用性

Android系统 iOS系统

quitRoom

退出房间

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

params

roomID:

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

privateMapKey:

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

role:

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

callback(ret)

ret:

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

示例代码

   var mwTencentRTC = api.require('mwTencentRTC');
   mwTencentRTC.quitRoom({
   }, function (ret, err) {
         if (ret) {
             alert(JSON.stringify(ret));
         } else {
             alert(JSON.stringify(err));
          }
   });

可用性

Android系统 iOS系统