Class Phaser

Effector's subclass for Phaser.

Hierarchy

Effector
- Phaser

Index

Constructors

Properties

context depth depthRate filters input isActive lfo mix numberOfStages output paused rate MAX_STAGES

Accessors

Methods

activate connect deactivate param params start state stop toJSON

Constructors

constructor

new Phaser(context): Phaser
Parameters
- context: AudioContext
  
  This argument is in order to use Web Audio API.
Returns Phaser
Overrides Effector.constructor
- Defined in SoundModule/Effectors/Phaser.ts:31

Properties

`Protected` context

context: AudioContext

`Protected` depth

depth: GainNode

`Private` depthRate

depthRate: number = 0

`Private` filters

filters: BiquadFilterNode[] = []

`Protected` input

input: GainNode

`Protected` isActive

isActive: boolean = true

`Protected` lfo

lfo: OscillatorNode

`Private` mix

mix: GainNode

`Private` numberOfStages

numberOfStages: PhaserNumberOfStages = 12

`Protected` output

output: GainNode

`Protected` paused

paused: boolean = true

`Protected` rate

rate: AudioParam

`Static` MAX_STAGES

MAX_STAGES: number = 24

Accessors

INPUT

get INPUT(): GainNode
Connector for input.

Returns GainNode
Inherited from Effector.INPUT
- Defined in SoundModule/Effectors/Effector.ts:146

OUTPUT

get OUTPUT(): GainNode
Connector for output.

Returns GainNode
Inherited from Effector.OUTPUT
- Defined in SoundModule/Effectors/Effector.ts:153

Methods

activate

activate(): Phaser
Returns Phaser
Overrides Effector.activate
- Defined in SoundModule/Effectors/Phaser.ts:233

connect

connect(): GainNode
Returns GainNode
Overrides Effector.connect
- Defined in SoundModule/Effectors/Phaser.ts:79

deactivate

deactivate(): Phaser
Returns Phaser
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/Phaser.ts:239

param

param(params): boolean
This method gets or sets parameters for phaser effector. This method is overloaded for type interface and type check.
Parameters
- params: "state"
  
  This argument is string if getter. Otherwise, setter.
Returns boolean
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:120
param(params): PhaserNumberOfStages
Parameters
- params: "stage"
Returns PhaserNumberOfStages
- Defined in SoundModule/Effectors/Phaser.ts:121
param(params): number
Parameters
- params: "frequency"
Returns number
- Defined in SoundModule/Effectors/Phaser.ts:122
param(params): number
Parameters
- params: "resonance"
Returns number
- Defined in SoundModule/Effectors/Phaser.ts:123
param(params): number
Parameters
- params: "depth"
Returns number
- Defined in SoundModule/Effectors/Phaser.ts:124
param(params): number
Parameters
- params: "rate"
Returns number
- Defined in SoundModule/Effectors/Phaser.ts:125
param(params): number
Parameters
- params: "mix"
Returns number
- Defined in SoundModule/Effectors/Phaser.ts:126
param(params): Phaser
Parameters
- params: PhaserParams
Returns Phaser
- Defined in SoundModule/Effectors/Phaser.ts:127

params

params(): Required<PhaserParams>
Returns Required<PhaserParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/Phaser.ts:220

start

start(startTime?): void
This method starts LFO. Namely, this method starts effector.
Parameters
- Optional startTime: number
  
  This argument is in order to schedule parameter.
Returns void
Inherited from Effector.start
- Defined in SoundModule/Effectors/Effector.ts:44

state

state(): boolean
This method gets effector state. If returns true, effector is active.

Returns boolean
Inherited from Effector.state
- Defined in SoundModule/Effectors/Effector.ts:107

stop

stop(stopTime?, releaseTime?): void
Parameters
- Optional stopTime: number
- Optional releaseTime: number
Returns void
Overrides Effector.stop
- Defined in SoundModule/Effectors/Phaser.ts:65

toJSON

toJSON(): string
This method gets effector's parameters as JSON.

Returns string
Inherited from Effector.toJSON
- Defined in SoundModule/Effectors/Effector.ts:99

Generated using TypeDoc