Class EnvelopeGenerator

constructor

• new EnvelopeGenerator(context: AudioContext): EnvelopeGenerator

  Parameters

  • context: AudioContext

    This argument is in order to use Web Audio API.

  Returns EnvelopeGenerator

StaticMIN_GAIN

activate

• activate(): EnvelopeGenerator

  This method activates envelope generator.

  Returns EnvelopeGenerator

  Return value is for method chain.

clear

• clear(disconnected: boolean): void

  This method clears variables for managing instance of GainNode.

  Parameters

  • disconnected: boolean

    This argument is in order to determine whether disconnect AudioNode.

  Returns void

  This is returned for method chain.

deactivate

• deactivate(): EnvelopeGenerator

  This method deactivates envelope generator.

  Returns EnvelopeGenerator

  Return value is for method chain.

getGenerator

• getGenerator(index: number): null | GainNode

  This method gets instance of GainNode for Envelope Generator.

  Parameters

  • index: number

    This argument is index of array that contains instance of GainNode for Envelope Generator.

  Returns null | GainNode

  This is returned as instance of GainNode for Envelope Generator.

param

• param(params: "state"): boolean

  This method gets or sets parameters for envelope generator. 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 envelope generator if getter. Otherwise, return value is for method chain.
• param(params: "attack"): number

  This method gets or sets parameters for envelope generator. This method is overloaded for type interface and type check.

  Parameters

  • params: "attack"

    This argument is string if getter. Otherwise, setter.

  Returns number

  Return value is parameter for envelope generator if getter. Otherwise, return value is for method chain.
• param(params: "decay"): number

  This method gets or sets parameters for envelope generator. This method is overloaded for type interface and type check.

  Parameters

  • params: "decay"

    This argument is string if getter. Otherwise, setter.

  Returns number

  Return value is parameter for envelope generator if getter. Otherwise, return value is for method chain.
• param(params: "sustain"): number

  This method gets or sets parameters for envelope generator. This method is overloaded for type interface and type check.

  Parameters

  • params: "sustain"

    This argument is string if getter. Otherwise, setter.

  Returns number

  Return value is parameter for envelope generator if getter. Otherwise, return value is for method chain.
• param(params: "release"): number

  This method gets or sets parameters for envelope generator. This method is overloaded for type interface and type check.

  Parameters

  • params: "release"

    This argument is string if getter. Otherwise, setter.

  Returns number

  Return value is parameter for envelope generator if getter. Otherwise, return value is for method chain.
• param(params: EnvelopeGeneratorParams): EnvelopeGenerator

  This method gets or sets parameters for envelope generator. This method is overloaded for type interface and type check.

  Parameters

  • params: EnvelopeGeneratorParams

    This argument is string if getter. Otherwise, setter.

  Returns EnvelopeGenerator

  Return value is parameter for envelope generator if getter. Otherwise, return value is for method chain.

params

• params(): Required<EnvelopeGeneratorParams>

  This method gets effector's parameters as associative array.

  Returns Required<EnvelopeGeneratorParams>

paused

• paused(): boolean

  This method determines whether the all of gain schedulings have ended.

  Returns boolean

  If the all of gain schedulings have ended, this value is true. Otherwise, this value is false.

ready

• ready(index: number, input: null | AudioNode, output: null | AudioNode): void

  This method connects instance of AudioNode.

  Parameters

  • index: number

    This argument is in order to select instance of GainNode that is Envelope Generator.
  • input: null | AudioNode

    This argument is instance of AudioNode as input.
  • output: null | AudioNode

    This argument is instance of AudioNode as output.

  Returns void

setGenerator

• setGenerator(index: number): void

  This method sets instance of GainNode for Envelope Generator.

  Parameters

  • index: number

    This argument is index of array that contains instance of GainNode for Envelope Generator.

  Returns void

  This is returned for method chain.

start

• start(startTime: number): void

  This method changes gain (Attack -> Decay -> Sustain).

  Parameters

  • startTime: number

    This argument is start time of Attack.

  Returns void

state

• state(): boolean

  This method gets envelope generator state. If returns true, envelope generator is active.

  Returns boolean

stop

• stop(stopTime: number, useCurve?: boolean): void

  This method changes gain (Attack or Decay or Sustain -> Release).

  Parameters

  • stopTime: number

    This argument is start time of Release.
  • OptionaluseCurve: boolean

    This argument is to use different methods. The default value is false.

  Returns void

toJSON

• toJSON(): string

  This method gets effector's parameters as JSON.

  Returns string