更新记录

1.0.1(2022-02-07)

提供提词器api


平台兼容性

Android Android CPU类型 iOS
适用版本区间:5.0 - 11.0 armeabi-v7a:支持,arm64-v8a:支持,x86:支持 ×

原生插件通用使用流程:

  1. 购买插件,选择该插件绑定的项目。
  2. 在HBuilderX里找到项目,在manifest的app原生插件配置中勾选模块,如需要填写参数则参考插件作者的文档添加。
  3. 根据插件作者的提供的文档开发代码,在代码中引用插件,调用插件功能。
  4. 打包自定义基座,选择插件,得到自定义基座,然后运行时选择自定义基座,进行log输出测试。
  5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项:使用HBuilderX2.7.14以下版本,如果同一插件且同一appid下购买并绑定了多个包名,提交云打包界面提示包名绑定不一致时,需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择


插件方法

  1. canDrawOverlays
  2. startPIP
  3. stopPIP
  4. startPlayer
  5. stopPlayer
  6. updateStyle
  7. updateSpeed
  8. setShowLine
  9. setContent

    概述

    XF-floatWordsModule封装了安卓悬浮题词的功能

    方法

    canDrawOverlays

    悬浮窗权限申请

    canDrawOverlays(callback(ret))

    callback(ret): ret

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

      示例代码

      const demoModule = uni.requireNativePlugin('XF-floatWordsModule');
      demoModule.canDrawOverlays((ret)=>{})

startPIP

显示悬浮窗

    startPIP({params},callback(ret))

params: backgroundColor:

  • 类型:String
  • 描述:(可选项)背景颜色
  • 默认值:#000000

textColor:

  • 类型:String
  • 描述:(可选项)文字颜色
  • 默认值:#FFFFFF

textSize:

  • 类型:Number
  • 描述:(可选项)文字大小
  • 默认值:20

radius:

  • 类型:Number
  • 描述:(可选项)圆角
  • 默认值:10

text:

  • 类型:String
  • 描述:(可选项)预览题词的内容
  • 默认值:''

isShowLine:

  • 类型:Boolean
  • 描述:(可选项)是否显示中间标准线
  • 默认值:true

isLoop:

  • 类型:Boolean
  • 描述:(可选项)是否循环播放内容
  • 默认值:false

speed:

  • 类型:Number
  • 描述:(可选项)每秒显示帧数(1-100)
  • 默认值:30

alpha:

  • 类型:Number
  • 描述:(可选项)背景透明度(0-100)
  • 默认值:50

countDown:

  • 类型:Number
  • 描述:(可选项)倒计时
  • 默认值:3

imageButton:

  • 类型:String
  • 描述:(可选项)按钮图片路径 图片路径如果是本地路径 需要用plus.io.convertLocalFileSystemURL方法转换一下

isMirror:

  • 类型:Boolean
  • 描述:(可选项)是否镜像
  • 默认值:false

callback(ret): ret

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

    示例代码

    const demoModule = uni.requireNativePlugin('XF-floatWordsModule');
    demoModule.startPIP({params},(ret)=>{})

stopPIP

关闭悬浮窗

    stopPIP(callback(ret))

callback(ret): ret

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

    示例代码

    const demoModule = uni.requireNativePlugin('XF-floatWordsModule');
    demoModule.stopPIP((ret)=>{})

startPlayer

开始滚动

    startPlayer(callback(ret))

callback(ret): ret

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

    示例代码

    const demoModule = uni.requireNativePlugin('XF-floatWordsModule');
    demoModule.startPlayer((ret)=>{})

stopPlayer

停止滚动

    stopPlayer(callback(ret))

callback(ret): ret

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

    示例代码

    const demoModule = uni.requireNativePlugin('XF-floatWordsModule');
    demoModule.stopPlayer((ret)=>{})

updateStyle

更新样式

    updateStyle({params},callback(ret))

params: backgroundColor:

  • 类型:String
  • 描述:(可选项)背景颜色
  • 默认值:#000000

textColor:

  • 类型:String
  • 描述:(可选项)文字颜色
  • 默认值:#FFFFFF

textSize:

  • 类型:Number
  • 描述:(可选项)文字大小
  • 默认值:20

callback(ret): ret

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

    示例代码

    const demoModule = uni.requireNativePlugin('XF-floatWordsModule');
    demoModule.updateStyle({params},(ret)=>{})

updateSpeed

更新播放速度

    updateSpeed({params},callback(ret))

params: speed:

  • 类型:Number
  • 描述:(可选项)播放速度
  • 默认值:30

callback(ret): ret

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

    示例代码

    const demoModule = uni.requireNativePlugin('XF-floatWordsModule');
    demoModule.updateSpeed({params},(ret)=>{})

setShowLine

是否显示中间标准线

    setShowLine({params},callback(ret))

params: isShowLine:

  • 类型:Boolean
  • 描述:(可选项)是否显示中间标准线
  • 默认值:true

callback(ret): ret

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

    示例代码

    const demoModule = uni.requireNativePlugin('XF-floatWordsModule');
    demoModule.setShowLine({params},(ret)=>{})

setContent

设置题词内容

    setContent({params},callback(ret))

params: text:

  • 类型:String
  • 描述:(必填)题词内容

callback(ret): ret

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

    示例代码

    const demoModule = uni.requireNativePlugin('XF-floatWordsModule');
    demoModule.setContent({params},(ret)=>{})

隐私、权限声明

1. 本插件需要申请的系统权限列表:

悬浮窗权限

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

插件不采集任何数据

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

暂无用户评论。

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问