soundIndicator

立即使用

open close hide show setValue

概述

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

open

打开模块

open({params},callback(ret))

params

sID:

  • 类型：字符串
  • 描述：（可选项）模块的id，同一个页面支持打开多个模块，通过此ID执行其它操作
  • 默认：模块自动生成一个字符串id（时间戳）

center：

  • 类型：JSON 对象
  • 描述：（可选项）指示器锚点坐标
  • 内部字段：
{
    x: ,         //（可选项）数字类型；x坐标；默认：40
    y:           //（可选项）数字类型；y坐标：默认：20
}

height:

  • 类型：数字
  • 描述：（可选项）模块高度
  • 默认：100

strip：

  • 类型：JSON 对象
  • 描述：（可选项）指示条配置
  • 内部字段：
{
    count: ,         //（可选项）数字类型；条数；默认：10
    interval: ,      //（可选项）数字类型；间隔；默认：5
    width:           //（可选项）数字类型；宽度：默认：4
}

alphas：

  • 类型：数组
  • 描述：（可选项）单条指示器每个指示条的透明度组成的数组。本数组顺序同 orientation 指示的方向。
  • 默认：[1,1,1,1,1,1,1,1]

gradientColors：

  • 类型：数组
  • 描述：（可选项）单条指示器每个指示条的顶部和底部色值配置组成的数组，模块会将两色值渐变处理，渐变色分界点是从上往下30%的位置。本数组顺序同 orientation 指示的方向。
  • 内部字段：
[{
   top: '#5f42c8',       //（可选项）字符串类型；指示条顶部色值，支持rgb、rgba、#；默认：#5f42c8
   bottom: '#ff4e00'     //（可选项）字符串类型；指示条底部色值，支持rgb、rgba、#；默认：#ff4e00
}]

orientation：

  • 类型：字符串
  • 描述：（可选项）指示波传递方向
  • 默认值：right_left
  • 取值范围：
    • right_left：从右往左
    • left_right：从左往右

bg：

  • 类型：字符串
  • 描述：（可选项）录音标识的背景色，支持 rgb，rgba，#
  • 默认值：rgba(0,0,0,0)

fixedOn：

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

fixed:

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

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    sID:         //字符串类型；模块ID
}

示例代码

var soundIndicator = api.require('soundIndicator');
soundIndicator.open({
    sID:'left',
    center:{x:95,y:200},
    height: 200,
    strip:{
     count: 20,
     interval:5,
     width:4
    },
    orientation:'right_left'
});
soundIndicator.open({
    sID:'right',
    center:{x:280,y:200},
    height: 200,
    strip:{
     count: 20,
     interval:5,
     width:4
    },
    orientation:'left_right'
});

可用性

iOS 系统，Android系统

可提供的1.0.0及更高版本

close

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

close({params})

params

sID:

  • 类型：字符串
  • 描述：模块的id

示例代码

var soundIndicator = api.require('soundIndicator');
soundIndicator.close({
  sID:'left'
});

可用性

iOS 系统，Android系统

可提供的1.0.0及更高版本

hide

隐藏soundIndicator按钮

hide({params})

params

sID:

  • 类型：字符串
  • 描述：模块的id

示例代码

var soundIndicator = api.require('soundIndicator');
soundIndicator.hide({
   sID:'right'
});

可用性

iOS 系统，Android系统

可提供的1.0.0及更高版本

show

显示soundIndicator按钮

show({params})

params

sID:

  • 类型：字符串
  • 描述：模块的id

示例代码

var soundIndicator = api.require('soundIndicator');
soundIndicator.show({
   sID:'left'
});

可用性

iOS 系统，Android系统

可提供的1.0.0及更高版本

setValue

设置振幅值

setValue({params})

params

sID:

  • 类型：字符串
  • 描述：模块的id

value：

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

示例代码

var soundIndicator = api.require('soundIndicator');
soundIndicator.setValue({
   sID:'left',
   value:50
});
soundIndicator.setValue({
   sID:'right',
   value:50
});

可用性

iOS 系统，Android系统

可提供的1.0.0及更高版本