liveUI

来自于:开发者立即使用

概述

本模块实现了iOS和Android的直播界面ui效果,实现了用户头像显示、直播观众列表显示、弹幕、互动消息列表展示、观众进入房间提示消息、系统提示消息展示。丰富了直播功能界面,让您的app更灵动。(备注:本模块是根据手机的屏幕大小来布局的,请在需要设置本模块的界面为全屏,这样才能完全显示完模块的UI元素。)

模块效果图如下: 描述

模块接口

openLiveUI

打开直播UI界面

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

params

uid:

  • 类型:字符串
  • 描述:(必填项)主播用户id

name:

  • 类型:字符串
  • 描述:(可选项)主播名称
  • 默认值:直播

roomName:

  • 类型:字符串
  • 描述:(可选项)直播房间名称

headpic:

  • 类型:字符串
  • 描述:(可选项)主播用户的头像地址(图片不存在时有默认头像,请用圆形图片),支持http:// fs://、widget:// 协议。
  • 默认值:默认用户头像

starpic:

  • 类型:字符串
  • 描述:(可选项)主播等级图标(图片不存在时有默认等级图标,请用圆形图片),支持http:// fs://、widget:// 协议。
  • 默认值:无等级

isDanmu:

  • 类型:布尔型
  • 描述:(可选项)是否开启弹幕。(true:开启弹幕 false:关闭弹幕)
  • 默认值:true(开启弹幕)

isShowGuanZhuBtn:

  • 类型:布尔型
  • 描述:(可选项)是否显示关注按钮 。
  • 默认值:true(显示关注按钮)

memberCounts:

  • 类型:数字型
  • 描述:(可选项)观看人数 。
  • 默认值:0

userList:

  • 类型: 数组对象
  • 描述:(必填项)观众用户列表
  • 内部字段:
[{
    uid: '',   //(必填项)(字符串);用户id
    nickname: '',   //(必填项)字符串;用户名称
    headpic: '', //(可选项)字符串;用户头像,支持http:// fs:// widget://
    starpic: '', //(可选项)字符串;等级图标,支持http:// fs:// widget://
}]

messageList:

  • 类型: 数组对象
  • 描述:(必填项)用户消息列表
  • 内部字段:
[{
    uid: '',   //(必填项)(字符串);用户id
    startnum: 1,   //(必填项)(数字型);用户等级id
    nickname: "小气鬼"+new Date().getTime(),   //(必填项)字符串;用户名称
    nicknameColor: '#BA55D3',   //(可选项)字符串;用户名称字体颜色
    message: "🎁🎁🎁 ☕️☕️☕️😝😝  可以试试消息能不能发送emjo标清",   //(必填项)字符串;消息内容
    messageColor: '#BA55D3',   //(可选项)字符串;消息内容字体颜色
}]

fixedOn:

  • 类型:字符串
  • 描述:(可选项)模块所属 Frame 的名字,若不传则模块归属于当前 Window

fixed:

  • 类型:布尔值
  • 描述:(可选项)模块是否随所属 Window 或 Frame 滚动
  • 默认值:true(不随之滚动)

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true,      //布尔型;true||false
    eventType : 'show',//show              打开ui模块
                       //onClickHeadIcon   点击主播头像
                       //onClickGuanZhu    点击关注按钮
                       //onClickUserList   点击观众列表某用户头像
                       //onClickMessage    点击消息列表某条消息
    uid : '1',            //用户id(根据不同事件返回对应的用户id)
    nickname : ''         //用户名称(仅onClickUserList事件才有此参数)
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: ''
}

示例代码

var demo = api.require('liveUI');
var userList = new Array();
var msgList = new Array();

for(var i =0;i<5;i++){
    var data1 = {
        uid : i,//用户id
        nickname : "小气鬼"+new Date().getTime(),//用户名称
        headpic : "widget://image/mac.png",//用户头像
        starpic : "widget://image/icon_live_toolbar_send_star.png"//等级图标
    };
    userList.push(data1);

    var data = {
        uid : i,//用户id
        startnum : 1,
        nickname : "小气鬼"+new Date().getTime(),
        nicknameColor : "#BA55D3",
        message : "🎁🎁🎁 ☕️☕️☕️😝😝  可以试试消息能不能发送emjo标清",
                    messageColor : "#DDA0DD"
    };

    msgList.push(data);
}

var param = {
    roomName : "映票:9116683", //房间名称
    uid : '12333', //用户id
    name : "直播",//用户名称或者直播名称
    headpic : "widget://image/mac.png", //用户头像或者直播房间头像
    starpic : "widget://image/icon_live_toolbar_send_star.png",//等级图标
    isDanmu : true,//是否开启弹幕
    isShowGuanZhuBtn : true,//是否显示关注按钮
    memberCounts : 100,//观看人数
    userList : userList,
    messageList : msgList,
    fixedOn : api.frameName,
    fixed : true
};
demo.openLiveUI(param, function(ret, err) {
    api.toast({msg : JSON.stringify(ret)+"  "+JSON.stringify(err)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

addUserInfo

添加观众用户加入接口

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

params

uid:

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

nickname:

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

headpic:

  • 类型: 字符串
  • 描述:(可选项)用户头像(图片不存在时有默认头像,请用圆形图片),支持http:// fs:// widget://
  • 默认值:默认用户头像

starpic:

  • 类型: 字符串
  • 描述:(可选项)用户等级图片(图片不存在时有默认等级图片,请用圆形图片),支持http:// fs:// widget://
  • 默认值:无等级

isJoinView:

  • 类型:布尔型
  • 描述:(可选项)是否隐藏登场消息框
  • 默认值:true(不显示)

backgroundPic:

  • 类型: 字符串
  • 描述:(可选项)登场消息框背景图片(图片不存在时有默认背景图片),支持http:// fs:// widget://

startnum:

  • 类型: 数字型
  • 描述:(可选项)用户等级

nicknameColor:

  • 类型: 字符串
  • 描述:(可选项)用户名称字体颜色
  • 默认值:#D08600

message:

  • 类型: 字符串
  • 描述:(可选项)登场消息内容
  • 默认值:进入

messageColor:

  • 类型: 字符串
  • 描述:(可选项)登场消息内容字体颜色
  • 默认值:#FE1E4D

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: ''
}

示例代码

var demo = api.require('liveUI');
var param = {
    uid : new Date().getTime(),//用户id
    nickname : "小气鬼"+new Date().getTime(),//用户名称
    headpic : "widget://image/mac.png",//头像图片
    starpic : "widget://image/icon_live_toolbar_send_star.png",//等级图片

    isJoinView : false,  //是否显示闪亮登场消息框 默认 true 不显示|false 显示
    backgroundPic : "widget://image/listview_messgage_jion_background.png",//闪亮登场的背景图片
    startnum : 99,//等级
    nicknameColor : "#B03060",//用户名称字体颜色
    message : "闪亮登场",//消息内容
    messageColor : "#836FFF"//消息字体颜色
};
demo.addUserInfo(param, function(ret, err) {
    api.toast({msg : JSON.stringify(ret)+"  "+JSON.stringify(err)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

addUserInfoList

批量添加观众用户加入接口

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

params

userList:

  • 类型: 数组对象
  • 描述:(必填项)加入观众用户列表
  • 内部字段:
[{
    uid: '1',   //(必填项)(字符串);用户id
    nickname: '',   //(必填项)字符串;用户名称
    headpic: '', //(可选项)字符串;用户头像,支持http:// fs:// widget://
    starpic: '', //(可选项)字符串;等级图标,支持http:// fs:// widget://
}]

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: ''
}

示例代码

var demo = api.require('liveUI');
var userList = new Array();
for(var i =0;i<5;i++){
    var data1 = {
        uid : i,//用户id
        nickname : "小气鬼"+new Date().getTime(),//用户名称
        headpic : "widget://image/mac.png",//用户头像
        starpic : "widget://image/icon_live_toolbar_send_star.png"//等级图标
    };
    userList.push(data1);
}
demo.addUserInfoList({
    userList : userList
}, function(ret, err) {
    api.toast({msg : JSON.stringify(ret)+"  "+JSON.stringify(err)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setMemberCounts

仅设置显示置观众人数,和观众列表纪录数无关

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

params

memberCounts:

  • 类型:数字型
  • 描述:(必填项)观看人数。

callback(ret,err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: ''
}

示例代码

var demo = api.require('liveUI');
demo.setMemberCounts({
    memberCounts : 99999//观看人数
}, function(ret,err) {
    api.toast({msg : JSON.stringify(ret));
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

isShowGuanZhuBtn

是否显示关注按钮

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

params

isShowGuanZhuBtn:

  • 类型:布尔型
  • 描述:(可选项)是否显示关注按钮。
  • 默认值:true(显示)

callback(ret,err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: ''
}

示例代码

var demo = api.require('liveUI');
demo.setMemberCounts({
    isShowGuanZhuBtn : false
}, function(ret,err) {
    api.toast({msg : JSON.stringify(ret));
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

delUserInfo

观看用户退出

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

params

uid:

  • 类型:字符串
  • 描述:(可选项)用户id。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg : ''
}

示例代码

var demo = api.require('liveUI');
demo.delUserInfo({
    uid : ''
}, function(ret,err) {
    api.toast({msg : JSON.stringify(ret));
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

showDanmu

发送弹幕消息

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

params

nickname:

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

nicknameColor:

  • 类型: 字符串
  • 描述:(可选项)用户名称字体颜色
  • 默认值:#D08600

headpic:

  • 类型: 字符串
  • 描述:(可选项)用户头像(图片不存在时有有默认头像,请用圆形图片),支持http:// fs:// widget://
  • 默认值:默认用户头像

starpic:

  • 类型: 字符串
  • 描述:(可选项)等级图标(图片不存在时有默认等级图标,请用圆形图片),支持http:// fs:// widget://
  • 默认值:无等级

message:

  • 类型: 字符串
  • 描述:(必填项)弹幕消息内容

messageColor:

  • 类型: 字符串
  • 描述:(可选项)弹幕消息内容字体颜色
  • 默认值:#FE1E4D

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status: true|false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: ''
}

示例代码

var demo = api.require('liveUI');
var param = {
    nickname : "小气鬼",  //用户名称
    headpic : "widget://image/mac.png", //用户头像
    starpic : "widget://image/icon_live_toolbar_send_star.png",//等级图片
    message : "🎁🎁🎁 ☕️☕️☕️😝😝  可以试试消息能不能发送emjo标清" + new Date().getTime()  //弹幕消息内容
};
demo.showDanmu(param, function(ret, err) {
    api.toast({msg : JSON.stringify(ret)+"  "+JSON.stringify(err)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

showMessage

消息列表显示消息信息

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

params

uid:

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

startnum:

  • 类型: 数字型
  • 描述:(可选项)用户等级

nickname:

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

nicknameColor:

  • 类型: 字符串
  • 描述:(可选项)用户名称字体颜色
  • 默认值:#D08600

message:

  • 类型: 字符串
  • 描述:(必填项)发送消息内容

messageColor:

  • 类型: 字符串
  • 描述:(可选项)发送消息内容字体颜色
  • 默认值:#FE1E4D

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status: true,      //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: ''
}

示例代码

var demo = api.require('liveUI');
var param = {
    uid : new Date().getTime(),//用户id
    startnum : 1,  //等级
    nickname : "小气鬼"+new Date().getTime(),//用户名称
    nicknameColor : "#BA55D3",//用户名称字体颜色
    message : "🎁🎁🎁 ☕️☕️☕️😝😝  可以试试消息能不能发送emjo标清",//消息
    messageColor : "#DDA0DD"//消息字体颜色
};
demo.showMessage(param, function(ret, err) {
    api.toast({msg : JSON.stringify(ret)+"  "+JSON.stringify(err)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

showMessageList

批量添加消息列表显示消息信息

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

params

messageList:

  • 类型: 数组对象
  • 描述:(必填项)用户消息列表
  • 内部字段:
[{
    uid: '',   //(必填项)(字符串);用户id
    startnum: 1,   //(必填项)(数字型);用户等级id
    nickname: "小气鬼"+new Date().getTime(),   //(必填项)字符串;用户名称
    nicknameColor: '#BA55D3',   //(可选项)字符串;用户名称字体颜色
    message: "🎁🎁🎁 ☕️☕️☕️😝😝  可以试试消息能不能发送emjo标清",   //(必填项)字符串;消息内容
    messageColor: '#BA55D3',   //(可选项)字符串;消息内容字体颜色
}]

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: ''
}

示例代码

var demo = api.require('liveUI');
var messageList = new Array();
for(var i =0;i<5;i++){
    var data1 = {
        uid : new Date().getTime(),//用户id
        startnum : 1,  //等级
        nickname : "小气鬼"+new Date().getTime(),//用户名称
        nicknameColor : "#BA55D3",//用户名称字体颜色
        message : "🎁🎁🎁 ☕️☕️☕️😝😝  可以试试消息能不能发送emjo标清",//消息
        messageColor : "#DDA0DD"//消息字体颜色
    };
    messageList.push(data1);
}
demo.showMessageList({
    messageList : messageList
}, function(ret, err) {
    api.toast({msg : JSON.stringify(ret)+"  "+JSON.stringify(err)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

showSystemMessage

显示直播系统消息

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

params

title:

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

titleColor:

  • 类型: 字符串
  • 描述:(可选项)用户名称字体颜色
  • 默认值:#D08600

message:

  • 类型: 字符串
  • 描述:(必填项)系统消息内容

messageColor:

  • 类型: 字符串
  • 描述:(可选项)系统消息内容字体颜色
  • 默认值:#FE1E4D

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true,      //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: ''
}

示例代码

var demo = api.require('liveUI');
var param = {
    title : "直播消息:",//标题
    titleColor : "#BA55D3",//标题颜色
    message : "哲宝宝入住贡献榜,空降头等舱",//消息
    messageColor : "#DDA0DD"//消息字体颜色
};
demo.showSystemMessage(param, function(ret, err) {
    api.toast({msg : JSON.stringify(ret)+"  "+JSON.stringify(err)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

clearMessage

清空消息列表

clearMessage(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true,      //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: ''
}

示例代码

var demo = api.require('liveUI');
demo.clearMessage(function(ret, err) {
    api.toast({msg : JSON.stringify(ret)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

hiddenLiveUI

隐藏直播ui

hiddenLiveUI(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true,      //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: ''
}

示例代码

var demo = api.require('liveUI');
demo.hiddenLiveUI(function(ret, err) {
    api.toast({msg : JSON.stringify(ret)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

showLiveUI

显示直播ui

showLiveUI(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true,      //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: ''
}

示例代码

var demo = api.require('liveUI');
demo.showLiveUI(function(ret, err) {
    api.toast({msg : JSON.stringify(ret)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

closeLiveUI

关闭直播ui

closeLiveUI(callback(ret, err))

示例代码

var demo = api.require('liveUI');
demo.closeLiveUI(function(ret, err) {
    api.toast({msg : JSON.stringify(ret)});
});

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true,      //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: ''
}

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本