soundWave

立即使用

open close hide show setLevel

概述

本模块封装了一个音波指示器，可通过 open 接口打开模块，并设置其位置和大小。同时支持自定义设置波线粗细、副波条数、波动速度等样式。close可关闭模块，show和hide可显示隐藏模块。调用 setLevel 接口可使波产生动荡效果。可以用录音模块监听当前音量值，然后通过 setLevel 接口实时设置显示音量波动情况。

open

打开模块

open({params})

params

rect：

  • 类型：JSON 对象
  • 描述：（可选项）模块的位置及尺寸
  • 内部字段：
{
    x: 0,   //（可选项）数字类型；地图左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认：0
    y: 0,   //（可选项）数字类型；地图左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认：0
    w: 320, //（可选项）数字类型；地图的宽度；默认：'auto'
    h: 480  //（可选项）数字类型；地图的高度；默认：'auto'
}

fixedOn：

  • 类型：字符串类型
  • 描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）
  • 默认：模块依附于当前 window

fixed:

  • 类型：布尔
  • 描述：（可选项）模块是否随所属 window 或 frame 滚动
  • 默认值：true（不随之滚动）

numberOfWaves：

  • 类型：数字
  • 描述：（可选项）副波条数
  • 默认：4

mainWaveWidth:

  • 类型：数字
  • 描述：（可选项）主波波线粗细
  • 默认值：2

decorativeWavesWidth:

  • 类型：数字
  • 描述：（可选项）副波波线粗细
  • 默认值：1

phaseShift:

  • 类型：数字
  • 描述：（可选项）波浪线波动速度。
  • 单位：弧度/秒。表示每秒波动的弧度。2*3.14（弧度）是一个波周期
  • 默认值：3.14*3.75

bgColor：

  • 类型：字符串
  • 描述：（可选项）背景色，支持rgb、rgba、#
  • 默认：#90EE90

waveColor：

  • 类型：字符串
  • 描述：（可选项）主波浪线颜色(副波线色根据此色取不同的alpha获取)，支持rgb、rgba、#
  • 默认：#ff0000

示例代码

var soundWave = api.require('soundWave');
soundWave.open({
});

可用性

iOS 系统，Android系统

可提供的1.0.0及更高版本

close

关闭soundWave按钮，注意关闭按钮并不能停止投屏

close()

示例代码

var soundWave = api.require('soundWave');
soundWave.close();

可用性

iOS 系统，Android系统

可提供的1.0.0及更高版本

hide

隐藏soundWave按钮

hide()

示例代码

var soundWave = api.require('soundWave');
soundWave.hide();

可用性

iOS 系统，Android系统

可提供的1.0.0及更高版本

show

显示soundWave按钮

show()

示例代码

var soundWave = api.require('soundWave');
soundWave.show();

可用性

iOS 系统，Android系统

可提供的1.0.0及更高版本

setLevel

设置波动振幅

setLevel({params})

params

level：

  • 类型：数字
  • 描述：波动振幅，0-1

示例代码

var soundWave = api.require('soundWave');
soundWave.setLevel({
   level:0.5
});

可用性

iOS 系统，Android系统

可提供的1.0.0及更高版本