barrage


barrage模块实现在手机屏幕任意位置弹幕.

方法:

对象:

  • initOption : JSON对象 设置初始化数据

  • frameOption : JSON对象 初始化View的坐标位置和宽高及初始化后显示第几张图片

回调方法:

  • barrageCallback : 用户初始化数据、增加弹幕、设置显示弹幕、取消发布弹幕、图片切换的回调方法

返回状态属性(Number):

  • initSuccess: 初始化成功,数值为0
  • addSuccess: 添加弹幕成功,数值为1
  • deleteSuccess: 取消发布弹幕成功,数值为2
  • displaySuccess: 设置显示弹幕成功,数值为3
  • releaseSuccess: 发布弹幕成功,数值为4
  • changeSucceed: 图片切换成功,数值为6(备注:状态为'6'时,回调第二参数str是当前图片地址)
  • barrageErrorCode: 普通错误类型,数值为-1(备注:所有方法失败后都会调用该状态值)

弹幕显示状态(Number):

  • visiable: 显示弹幕,数值为0
  • invisiable: 隐藏弹幕,数值为1

备注:显示或者隐藏弹幕,针对插件里边的每一张图片(如果有多张图片的话)iOS目前都是相对独立的,Android是全局控制的

init


初始化插件并启动.

var barrage = rd.require("barrage");
barrage.init(frameOption,initOption,barrageCallback);    
说明:

初始化插件并启动,默认当前弹幕组动画是显示的,并且在动画显示完毕2秒之后弹幕会自动集体消失.调用( displayBarrage )函数,传入相应的参数,可切换弹幕的显示或隐藏.

参数:
  • frameOption:( frameOption )必选,初始化View的位置坐标和宽高信息以及初始化后显示第几张图片

  • initOption:( initOption )必选,初始化数据内容.

  • callBack:( barrageCallback ) 回调方法(在初始化的时候传递进来,然后除了没有在removeBarrageView函数使用该回调,其他均使用了,根据状态值的不同,通知json页面响应的操作).

返回值:

示例:
function barrageCallback(state,str) {
    alert("初始化state返回值为:"+state);
}
var frameOption={"x":"200","y":"400","width":"300","height":"500","index":"2"};
var initOption=[
{"imgUrl":"图片地址","positionList":[{"x":"0.5","y":"0.5","content":"弹幕内容","ID":"112233"}]}
];
barrage.init(frameOption,initOption,barrageCallback);

addBarrage


添加新的弹幕

var barrage = rd.require("barrage");

barrage.addBarrage(barrageContent,ID);    
说明:

添加新的弹幕

参数:
  • barrageContent: ( String ) 弹幕内容
  • ID: ( String ) 弹幕ID(每个弹幕的唯一标示,必须是符合唯一性),ID重复则添加失败.
返回值:

示例:
var barrage = rd.require("barrage");

barrage.addBarrage(barrageContent,ID);

deleteBarrage


取消发布弹幕

var barrage = rd.require("barrage");

barrage.deleteBarrage();    
说明:

取消发布弹幕,只对新增加且未发布的弹幕进行操作.

参数:

返回值:

示例:
var barrage = rd.require("barrage");

barrage.deleteBarrage();

displayBarrage


显示或隐藏弹幕

var barrage = rd.require("barrage");

barrage.displayBarrage(displayState);    
说明:

显示或隐藏弹幕:iOS调用显示弹幕,会将当前图片对应的弹幕组以动画的形式显示出来并且在显示完毕2秒之后集体自动消失.调用隐藏弹幕,会隐藏当前图片上的所有弹幕;Android调用显示弹幕,会将所有图片对应的弹幕组以动画的形式显示出来并且在显示完毕2秒之后集体自动消失.调用隐藏弹幕,会隐藏所有图片上的所有弹幕

参数:
返回值:

示例:
 var barrage = rd.require("barrage");
 barrage.displayBarrage(displayState);

releaseBarrage


发布弹幕

var barrage = rd.require("barrage");
var result = barrage.releaseBarrage();    
说明:

发布添加的弹幕,添加新的弹幕后,通过确认发布弹幕可以确认弹幕位置.

参数:

返回值:
  • result: ( Object ) 需要用JSON.stringify(result)将Object的转换为新添加的弹幕的ID、内容及最终的位置信息的字符串

备注:转换成字符串的返回值示例:{"ID":"11","content":"添加一个弹幕试试","y":"0.3","x":"0.65"},x和y坐标取值范围为[0,1],目前坐标值是按照百分比进行传输.

示例:
    var barrage = rd.require("barrage");
    var result = barrage.releaseBarrage();

removeBarrageView


移除弹幕View

var barrage = rd.require("barrage");

barrage.removeBarrageView();    
说明:

移除弹幕View.

参数:

返回值:

示例:
var barrage = rd.require("barrage");
barrage.removeBarrageView();

barrageCallback


用户初始化数据、增加弹幕、设置显示弹幕、取消发布弹幕、图片切换的回调方法.

function barrageCallback(state,str) {
// Handle Success
}
说明:

通过状态码返回操作状态.

参数:
  • state: ( 返回状态属性 ) 插件操作状态信息.
  • str: (String)参数作为回调方法barrageCallBack第二参数返回给json页面,目前就只在切换图片(返回当前图片地址)的时候使用该参数.

initOption


设置初始化参数

initOption 
[
{"imgUrl":"图片地址","positionList":[{"x":"0.5","y":"0.5","content":"弹幕内容","ID":"112233"}]}
]
说明

用户初始化图片和弹幕信息

属性
  • imgUrl: (String ) 必选,View的图片地址(该地址为网络图片地址)
  • positionList:(String )必选,弹幕模型数组
    • content: (String ) 必选,弹幕内容
    • ID: (String ) 必选,保证该弹幕的唯一性
    • x: (String ) 必选,弹幕对应的x坐标,x坐标取值范围为[0,1],目前坐标是按照百分比进行传输
    • y: (String ) 必选,弹幕对应的y坐标,y坐标取值范围为[0,1],目前坐标是按照百分比进行传输

frameOption


设置View位置与大小及初始化后显示第几张图片

frameOption
{
    property String x,
    property String y,
    property String width,
    property String height,
    property String index
}
说明

设置View位置与大小

属性
  • x: (String ) 必选,View对应的x坐标
  • y: (String ) 必选,View对应的y坐标
  • width: (String ) 必选,View的宽
  • height: (String ) 必选,View的高
  • index: (String ) 必选,不能为空,初始化后要显示图片的下标, 下标不可越界