Class VocalCanceler

This private class is for Vocal Canceler.

Hierarchy (View Summary)

Effector
- VocalCanceler

Index

Constructors

constructor

new VocalCanceler(context: AudioContext): VocalCanceler
Parameters
- context: AudioContext
  This argument is in order to use Web Audio API.
Returns VocalCanceler
Overrides Effector.constructor
- Defined in SoundModule/Effectors/VocalCanceler.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

Accessors

INPUT

get INPUT(): GainNode
Connector for input.

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

OUTPUT

get OUTPUT(): GainNode
Connector for output.

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

Methods

activate

activate(): VocalCanceler
This method activates effector.

Returns VocalCanceler
Return value is for method chain.
Inherited from Effector.activate
- Defined in SoundModule/Effectors/Effector.ts:109

connect

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

deactivate

deactivate(): VocalCanceler
This method deactivates effector.

Returns VocalCanceler
Return value is for method chain.
Inherited from Effector.deactivate
- Defined in SoundModule/Effectors/Effector.ts:126

param

param(params: "state"): boolean
This method gets or sets parameters for vocal canceler.
Parameters
- params: "state"
  This argument is string if getter. Otherwise, setter.
Returns boolean
Return value is parameter for vocal canceler if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/VocalCanceler.ts:83
param(params: "algorithm"): VocalCancelerAlgorithm
This method gets or sets parameters for vocal canceler.
Parameters
- params: "algorithm"
  This argument is string if getter. Otherwise, setter.
Returns VocalCancelerAlgorithm
Return value is parameter for vocal canceler if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/VocalCanceler.ts:84
param(params: "depth"): number
This method gets or sets parameters for vocal canceler.
Parameters
- params: "depth"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for vocal canceler if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/VocalCanceler.ts:85
param(params: "minFrequency"): number
This method gets or sets parameters for vocal canceler.
Parameters
- params: "minFrequency"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for vocal canceler if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/VocalCanceler.ts:86
param(params: "maxFrequency"): number
This method gets or sets parameters for vocal canceler.
Parameters
- params: "maxFrequency"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for vocal canceler if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/VocalCanceler.ts:87
param(params: "threshold"): number
This method gets or sets parameters for vocal canceler.
Parameters
- params: "threshold"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for vocal canceler if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/VocalCanceler.ts:88
param(params: VocalCancelerParams): VocalCanceler
This method gets or sets parameters for vocal canceler.
Parameters
- params: VocalCancelerParams
  This argument is string if getter. Otherwise, setter.
Returns VocalCanceler
Return value is parameter for vocal canceler if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/VocalCanceler.ts:89

params

params(): Required<VocalCancelerParams>
This method gets vocal canceler parameters as associative array.

Returns Required<VocalCancelerParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/VocalCanceler.ts:202

start

start(): void
Returns void
Overrides Effector.start
- Defined in SoundModule/Effectors/VocalCanceler.ts:52

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(): void
Returns void
Overrides Effector.stop
- Defined in SoundModule/Effectors/VocalCanceler.ts:56

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 VocalCanceler

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns VocalCanceler

Properties

Protectedcontext

Protecteddepth

Protectedinput

ProtectedisActive

Protectedlfo

Protectedoutput

Protectedpaused

Protectedrate

Accessors

INPUT

Returns GainNode

OUTPUT

Returns GainNode

Methods

activate

Returns VocalCanceler

connect

Returns GainNode

deactivate

Returns VocalCanceler

param

Parameters

Returns boolean

Parameters

Returns VocalCancelerAlgorithm

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns VocalCanceler

params

Returns Required<VocalCancelerParams>

start

Returns void

state

Returns boolean

stop

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