Interface Phaser

Effector's subclass for Phaser.

interface Phaser {
    context: AudioContext;
    depths: [GainNode, GainNode];
    input: GainNode;
    isActive: boolean;
    lfos: [OscillatorNode, OscillatorNode];
    output: GainNode;
    paused: boolean;
    rates: [AudioParam, AudioParam];
    get INPUT(): GainNode;
    get OUTPUT(): GainNode;
    activate(): Phaser;
    connect(): GainNode;
    deactivate(): Phaser;
    param(params: "state"): boolean;
    param(params: "type"): PhaserType;
    param(params: "stage"): PhaserNumberOfStages;
    param(params: "connectionType"): PhaserFilterConnectionType;
    param(params: "frequency"): number | [number, number];
    param(params: "resonance"): number | [number, number];
    param(params: "depth"): number | [number, number];
    param(params: "rate"): number | [number, number];
    param(params: "mix"): number | [number, number];
    param(params: "dry"): number;
    param(params: "wet"): number | [number, number];
    param(params: PhaserParams): Phaser;
    params(): Required<PhaserParams>;
    start(startTime?: number): void;
    state(): boolean;
    stop(stopTime?: number, releaseTime?: number): void;
    toJSON(): string;
}

Hierarchy (View Summary)

StereoEffector
- Phaser

Index

Properties

`Protected`context

context: AudioContext

`Protected`depths

depths: [GainNode, GainNode]

`Protected`input

input: GainNode

`Protected`isActive

isActive: boolean = true

`Protected`lfos

lfos: [OscillatorNode, OscillatorNode]

`Protected`output

output: GainNode

`Protected`paused

paused: boolean = true

`Protected`rates

rates: [AudioParam, AudioParam]

Accessors

INPUT

get INPUT(): GainNode
Connector for input.

Returns GainNode
Inherited from StereoEffector.INPUT
- Defined in SoundModule/Effectors/StereoEffector.ts:150

OUTPUT

get OUTPUT(): GainNode
Connector for output.

Returns GainNode
Inherited from StereoEffector.OUTPUT
- Defined in SoundModule/Effectors/StereoEffector.ts:157

Methods

activate

activate(): Phaser
This method activates effector.

Returns Phaser
Return value is for method chain.
Inherited from StereoEffector.activate
- Defined in SoundModule/Effectors/StereoEffector.ts:117

connect

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

deactivate

deactivate(): Phaser
This method deactivates effector.

Returns Phaser
Return value is for method chain.
Inherited from StereoEffector.deactivate
- Defined in SoundModule/Effectors/StereoEffector.ts:134

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:291
param(params: "type"): PhaserType
This method gets or sets parameters for phaser effector. This method is overloaded for type interface and type check.
Parameters
- params: "type"
  This argument is string if getter. Otherwise, setter.
Returns PhaserType
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:292
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:293
param(params: "connectionType"): PhaserFilterConnectionType
This method gets or sets parameters for phaser effector. This method is overloaded for type interface and type check.
Parameters
- params: "connectionType"
  This argument is string if getter. Otherwise, setter.
Returns PhaserFilterConnectionType
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:294
param(params: "frequency"): number | [number, 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 | [number, number]
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:295
param(params: "resonance"): number | [number, 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 | [number, number]
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:296
param(params: "depth"): number | [number, 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 | [number, number]
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:297
param(params: "rate"): number | [number, 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 | [number, number]
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:298
param(params: "mix"): number | [number, 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 | [number, number]
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:299
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:300
param(params: "wet"): number | [number, 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 | [number, number]
Return value is parameter for phaser effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Phaser.ts:301
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:302

params

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

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 StereoEffector.start
- Defined in SoundModule/Effectors/StereoEffector.ts:40

state

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

Returns boolean
Inherited from StereoEffector.state
- Defined in SoundModule/Effectors/StereoEffector.ts:109

stop

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

toJSON

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

Returns string
Inherited from StereoEffector.toJSON
- Defined in SoundModule/Effectors/StereoEffector.ts:101

Interface Phaser

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

Protectedcontext

Protecteddepths

Protectedinput

ProtectedisActive

Protectedlfos

Protectedoutput

Protectedpaused

Protectedrates

Accessors

INPUT

Returns GainNode

OUTPUT

Returns GainNode

Methods

activate

Returns Phaser

connect

Returns GainNode

deactivate

Returns Phaser

param

Parameters

Returns boolean

Parameters

Returns PhaserType

Parameters

Returns PhaserNumberOfStages

Parameters

Returns PhaserFilterConnectionType

Parameters

Returns number | [number, number]

Parameters

Returns number | [number, number]

Parameters

Returns number | [number, number]

Parameters

Returns number | [number, number]

Parameters

Returns number | [number, number]

Parameters

Returns number

Parameters

Returns number | [number, 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`depths

`Protected`input

`Protected`isActive

`Protected`lfos

`Protected`output

`Protected`paused

`Protected`rates