Class Phaser

Effector's subclass for Phaser.

Hierarchy (View Summary)

Effector
- Phaser

Index

Constructors

constructor

new Phaser(context: AudioContext): 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:32

Properties

`Protected`context

context: AudioContext

`Protected`depth

depth: GainNode

`Protected`input

input: GainNode

`Protected`isActive

isActive: boolean = true

`Protected`lfo

lfo: OscillatorNode

`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:140

OUTPUT

get OUTPUT(): GainNode
Connector for output.

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

Methods

activate

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

connect

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

deactivate

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

param

param(params: "state"): 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:131
param(params: "stage"): PhaserNumberOfStages
This method gets or sets parameters for phaser effector. This method is overloaded for type interface and type check.
Parameters
- params: "stage"
  This argument is string if getter. Otherwise, setter.
Returns PhaserNumberOfStages
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:132
param(params: "frequency"): number
This method gets or sets parameters for phaser effector. This method is overloaded for type interface and type check.
Parameters
- params: "frequency"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:133
param(params: "resonance"): number
This method gets or sets parameters for phaser effector. This method is overloaded for type interface and type check.
Parameters
- params: "resonance"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:134
param(params: "depth"): number
This method gets or sets parameters for phaser effector. This method is overloaded for type interface and type check.
Parameters
- params: "depth"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:135
param(params: "rate"): number
This method gets or sets parameters for phaser effector. This method is overloaded for type interface and type check.
Parameters
- params: "rate"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:136
param(params: "mix"): number
This method gets or sets parameters for phaser effector. This method is overloaded for type interface and type check.
Parameters
- params: "mix"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:137
param(params: "dry"): number
This method gets or sets parameters for phaser effector. This method is overloaded for type interface and type check.
Parameters
- params: "dry"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:138
param(params: "wet"): number
This method gets or sets parameters for phaser effector. This method is overloaded for type interface and type check.
Parameters
- params: "wet"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:139
param(params: PhaserParams): Phaser
This method gets or sets parameters for phaser effector. This method is overloaded for type interface and type check.
Parameters
- params: PhaserParams
  This argument is string if getter. Otherwise, setter.
Returns Phaser
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:140

params

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

start

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

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:101

stop

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

toJSON

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

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

Class Phaser

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Phaser

Properties

Protectedcontext

Protecteddepth

Protectedinput

ProtectedisActive

Protectedlfo

Protectedoutput

Protectedpaused

Protectedrate

StaticMAX_STAGES

Accessors

INPUT

Returns GainNode

OUTPUT

Returns GainNode

Methods

activate

Returns Phaser

connect

Returns GainNode

deactivate

Returns Phaser

param

Parameters

Returns boolean

Parameters

Returns PhaserNumberOfStages

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns Phaser

params

Returns Required<PhaserParams>

start

Parameters

Returns void

state

Returns boolean

stop

Parameters

Returns void

toJSON

Returns string

Settings

On This Page

`Protected`context

`Protected`depth

`Protected`input

`Protected`isActive

`Protected`lfo

`Protected`output

`Protected`paused

`Protected`rate

`Static`MAX_STAGES