class
BooleanParam

Source: waax.core.js:211

Methods

get()
init(options)
set(value, time, rampType)

new BooleanParam(options)

Boolean parameter abstraction. Usually called by WX.defineParams method.

Parameters

Name Type Optional Description

options

Object

 

Parameter configruation.

Values in options have the following properties:

Name Type Optional Description

name

 

 

User-defined parameter name.

default

 

 

Default value.

value

 

 

Current value.

_parent

 

 

Reference to associated Plug-in.

Methods

static
get() → Number

Returns the paramter value. Note that this is not a computed value of WA AudioParam instance.

Returns

Number Latest paramter value.

static
init(options)

Initializes instance with options.

Parameter

Name Type Optional Description

options

Object

 

Paramter configuration.

static
set(value, time, rampType)

Sets parameter value with time and ramp type. Calls back a corresponding handler.

Parameters

Name Type Optional Description

value

Number

 

Parameter target value

time

(Number or Array)

 

time or array of [start time, time constant]

rampType

Number

 

WAAX ramp type