Class Panner

Effector's subclass for Panner.

Hierarchy (View Summary)

Effector
- Panner

Index

Constructors

constructor

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

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

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(): Panner
Returns Panner
Overrides Effector.activate
- Defined in SoundModule/Effectors/Panner.ts:328

connect

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

deactivate

deactivate(): Panner
Returns Panner
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/Panner.ts:334

param

param(params: "state"): boolean
This method gets or sets parameters for panner. 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 panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:98
param(params: "x"): number
This method gets or sets parameters for panner. This method is overloaded for type interface and type check.
Parameters
- params: "x"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:99
param(params: "y"): number
This method gets or sets parameters for panner. This method is overloaded for type interface and type check.
Parameters
- params: "y"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:100
param(params: "z"): number
This method gets or sets parameters for panner. This method is overloaded for type interface and type check.
Parameters
- params: "z"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:101
param(params: "ox"): number
This method gets or sets parameters for panner. This method is overloaded for type interface and type check.
Parameters
- params: "ox"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:102
param(params: "oy"): number
This method gets or sets parameters for panner. This method is overloaded for type interface and type check.
Parameters
- params: "oy"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:103
param(params: "oz"): number
This method gets or sets parameters for panner. This method is overloaded for type interface and type check.
Parameters
- params: "oz"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:104
param(params: "refDistance"): number
This method gets or sets parameters for panner. This method is overloaded for type interface and type check.
Parameters
- params: "refDistance"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:105
param(params: "maxDistance"): number
This method gets or sets parameters for panner. This method is overloaded for type interface and type check.
Parameters
- params: "maxDistance"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:106
param(params: "rolloffFactor"): number
This method gets or sets parameters for panner. This method is overloaded for type interface and type check.
Parameters
- params: "rolloffFactor"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:107
param(params: "coneInnerAngle"): number
This method gets or sets parameters for panner. This method is overloaded for type interface and type check.
Parameters
- params: "coneInnerAngle"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:108
param(params: "coneOuterAngle"): number
This method gets or sets parameters for panner. This method is overloaded for type interface and type check.
Parameters
- params: "coneOuterAngle"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:109
param(params: "coneOuterGain"): number
This method gets or sets parameters for panner. This method is overloaded for type interface and type check.
Parameters
- params: "coneOuterGain"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:110
param(params: "panningModel"): PanningModelType
This method gets or sets parameters for panner. This method is overloaded for type interface and type check.
Parameters
- params: "panningModel"
  This argument is string if getter. Otherwise, setter.
Returns PanningModelType
Return value is parameter for panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:111
param(params: "distanceModel"): DistanceModelType
This method gets or sets parameters for panner. This method is overloaded for type interface and type check.
Parameters
- params: "distanceModel"
  This argument is string if getter. Otherwise, setter.
Returns DistanceModelType
Return value is parameter for panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:112
param(params: PannerParams): Panner
This method gets or sets parameters for panner. This method is overloaded for type interface and type check.
Parameters
- params: PannerParams
  This argument is string if getter. Otherwise, setter.
Returns Panner
Return value is parameter for panner if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Panner.ts:113

params

params(): Required<PannerParams>
Returns Required<PannerParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/Panner.ts:307

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
This method stops LFO, then creates instance of OscillatorNode again.
Parameters
- OptionalstopTime: number
  This argument is in order to schedule parameter.
- OptionalreleaseTime: number
  This argument is in order to schedule parameter when it is necessary to consider release time.
Returns void
Inherited from Effector.stop
- Defined in SoundModule/Effectors/Effector.ts:54

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 Panner

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Panner

Properties

Protectedcontext

Protecteddepth

Protectedinput

ProtectedisActive

Protectedlfo

Protectedoutput

Protectedpaused

Protectedrate

Accessors

INPUT

Returns GainNode

OUTPUT

Returns GainNode

Methods

activate

Returns Panner

connect

Returns GainNode

deactivate

Returns Panner

param

Parameters

Returns boolean

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns PanningModelType

Parameters

Returns DistanceModelType

Parameters

Returns Panner

params

Returns Required<PannerParams>

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