class
ItemizedParam

Source: waax.core.js:126

Methods

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

new ItemizedParam(options)

Itemized 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.

model

 

 

Option items.

default

 

 

Default item.

value

 

 

Current item.

_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
getModel() → Array

Returns the reference of items (WAAX model).

Returns

Array WAAX model associated with the parameter.

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