upLiveModule 直播模块
模块概述
直播模块为 H5 页面提供打开、关闭直播浮窗能力。
方法列表
- showFloatWindow(打开浮窗)
- closeFloatWindow(关闭浮窗)
公共数据
- 所有数据均以JSON结构返回,由代码,信息和数据三部分组成
{ "retCode": "000000", //接口状态标识码 "retInfo": "操作成功",//接口信息说明 "retData": null //业务数据 }
具体定义:返回数据通用
模块变更记录
- v3.1.0
- 新增方法:
- showFloatWindow(打开浮窗)
- closeFloatWindow(关闭浮窗)
- 新增方法:
方法说明
showFloatWindow(打开浮窗)
说明
- 打开直播浮窗
适用性
容器 | cordova | APICloud | Nebula |
---|---|---|---|
支持情况 | 否 | 是 | 是 |
APP版本 | / | 6.8.0 及以上 | 6.12.0 及以上 |
params 输入参数:
无
错误返回 retCode 说明:
按照通用
正确返回 retData说明:
无
示例
uplusapi.upLiveModule.showFloatWindow().then((result) => console.log('result',result));
成功返回结果
{
"retCode": "000000",
"retInfo": "成功打开浮窗",
"retData": null
}
closeFloatWindow(关闭浮窗)
说明
- 关闭直播浮窗
适用性
容器 | cordova | APICloud | Nebula |
---|---|---|---|
支持情况 | 否 | 是 | 是 |
APP版本 | / | 6.8.0 及以上 | 6.12.0 及以上 |
params 输入参数:
无
错误返回 retCode 说明:
按照通用
正确返回 retData说明:
无
示例
uplusapi.upLiveModule.closeFloatWindow().then((result) => console.log('result',result));
成功返回结果
{
"retCode": "000000",
"retInfo": "成功关闭浮窗",
"retData": null
}