floatWords

canDrawOverlays

openView

hideView

showView

closeView

startPlay

stopPlay

updateStyle

updateSpeed

setShowLine

startPIP

stopPIP

论坛示例

为帮助用户更好更快的使用插件，论坛维护了一个示例，示例中包含示例代码供您参考。

概述

floatWords插件使用画中画功能实现了iOS、Android悬浮提词显示功能。

插件使用攻略

  1. 必须开起后台运行权限：
<preference name="backgroundMode" value="audio"/>

接口

canDrawOverlays

是否有悬浮权限(安卓会弹出悬浮权限申请界面)

canDrawOverlays(callback(ret, err))

callback(ret, err)

ret：

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

err：

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

示例代码

var demo = api.require('floatWords');
demo.canDrawOverlays(function (ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

openView

打开预览视图

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

params

rect：

  • 类型：JSON 对象
  • 默认值：见内部字段
  • 描述：（可选项）浏览器窗口的位置和大小，设置margin后，在不同手机上面会保持与父页面的各方向边距一致，而中间区域会自动扩充。建议使用margin布局，可以完美适配带smartBar的手机。**(注意：当fixed设置false时，margin界面布局会异常)**
  • 内部字段：
{
    x:0,             //左上角x坐标，默认0
    y:0,             //左上角y坐标，默认0
    w:320,           //宽度，默认'auto'，页面从x位置开始自动充满父页面宽度
    h:480            //高度，默认'auto'，页面从y位置开始自动充满父页面高度

    marginLeft:0,    //相对父页面左外边距的距离，默认0
    marginTop:0,    //相对父页面上外边距的距离，默认0
    marginBottom:0,    //相对父页面下外边距的距离，默认0
    marginRight:0    //相对父页面右外边距的距离，默认0
}

fixedOn：

  • 类型：字符串型
  • 描述：（可选项）插件所属 Frame 的名字，若不传则插件归属于当前 Window

fixed：

  • 类型：布尔型
  • 描述：（可选项）插件是否随所属 Window 或 Frame 滚动
  • 默认值：true（不随之滚动）

backgroundColor：

  • 类型：字符串型
  • 描述：（可选项）背景颜色
  • 默认值：#000000

textColor：

  • 类型：字符串型
  • 描述：（可选项）文字颜色
  • 默认值：#FFFFFF

textSize：

  • 类型：数字型
  • 描述：（可选项）文字大小
  • 默认值：20

radius：

  • 类型：数字型
  • 描述：（可选项）圆角
  • 默认值：10

text：

  • 类型：字符串型
  • 描述：（必填项）预览提词内容

isShowLine：

  • 类型：布尔型
  • 描述：（可选项）是否显示中间标准线
  • 默认值：true

isAudoPlay：

  • 类型：布尔型
  • 描述：（可选项）预览时是否自动播放提词
  • 默认值：false

speed：

  • 类型：数字型
  • 描述：（可选项）每秒显示帧数（1-100）
  • 默认值：30

alpha：

  • 类型：数字型
  • 描述：（可选项）背景透明度（0-100）
  • 默认值：50

countDown：

  • 类型：数字型
  • 描述：（可选项）倒计时开始数
  • 默认值：3

callback(ret, err)

ret：

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

err：

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

示例代码

var demo = api.require('floatWords');
demo.openView({
    rect: {
        x : 20,
        y : 50,
        w: api.frameWidth - 40,
        h: api.frameHeight/3
    },
    fixedOn: api.frameName,
    fixed: true,
    text: '文本文本文本文本文本文本文本文本文本文本文本文本可以放任意view\n文本文本文本文本文本文本文本文本文本文本文本文本可以放任意view\n文本文本文本文本文本文本文本文本文本文本文本文本可以放任意view\n文本文本文本文本文本文本文本文本文本文本文本文本可以放任意view\n文本文本文本文本文本文本文本文本文本文本文本文本可以放任意view\n '
}, function (ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

hideView

隐藏预览视图

hideView(callback(ret, err))

callback(ret, err)

ret：

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

示例代码

var demo = api.require('floatWords');
demo.hideView(function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

showView

显示预览视图

showView(callback(ret, err))

callback(ret, err)

ret：

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

示例代码

var demo = api.require('floatWords');
demo.showView(function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

closeView

关闭预览视图

closeView(callback(ret, err))

callback(ret, err)

ret：

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

示例代码

var demo = api.require('floatWords');
demo.closeCompare(function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

startPlay

开始滚动播放

startPlay()

##ret：

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

示例代码

var obj = api.require('floatWords');
var ret = obj.startPlay();
api.alert({msg: JSON.stringify(ret)});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

stopPlay

停止滚动播放

stopPlay()

##ret：

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

示例代码

var obj = api.require('floatWords');
var ret = obj.stopPlay();
api.alert({msg: JSON.stringify(ret)});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

updateStyle

更新样式

updateStyle({params})

params

backgroundColor：

  • 类型：字符串型
  • 描述：（可选项）背景颜色
  • 默认值：#000000

textColor：

  • 类型：字符串型
  • 描述：（可选项）文字颜色
  • 默认值：#FFFFFF

textSize：

  • 类型：数字型
  • 描述：（可选项）文字大小
  • 默认值：20

##ret：

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

示例代码

var demo = api.require('floatWords');
var ret = demo.updateStyle({
    backgroundColor: '#FFFFFF',
    textFontColor: '#000000',
    textFontSize: 30,
});
api.alert({msg: JSON.stringify(ret)});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

updateSpeed

更新播放速度

updateSpeed({params})

params

speed：

  • 类型：数字型
  • 描述：（可选项）每秒显示帧数(1-100)
  • 默认值：30

##ret：

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

示例代码

var demo = api.require('floatWords');
var ret = demo.updateSpeed({
    speed: 100,
});
api.alert({msg: JSON.stringify(ret)});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setShowLine

是否显示中间标准线

setShowLine({params})

params

isShowLine：

  • 类型：布尔型
  • 描述：（可选项）是否显示中间标准线
  • 默认值：true

##ret：

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

示例代码

var demo = api.require('floatWords');
var ret = demo.setShowLine({
    isShowLine: false,
});
api.alert({msg: JSON.stringify(ret)});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

startPIP

开启画中画

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

params

videoType：

  • 类型：数字型
  • 描述：（可选项）悬浮窗显示比例(0->1:1 1->3:4 2->4:3 3->9:16 4->16:9)
  • 默认值：0

countDown：

  • 类型：数字型
  • 描述：（可选项）倒计时开始数
  • 默认值：3

callback(ret, err)

ret：

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

err：

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

示例代码

var demo = api.require('floatWords');
demo.startPIP({
    videoType: 0,
    countDown: 3,
}, function (ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

stopPIP

停止画中画

stopPIP()

##ret：

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

示例代码

var demo = api.require('floatWords');
var ret = demo.stopPIP();
api.alert({msg: JSON.stringify(ret)});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/04/24