Class AdsrBase

Base class for an ADSR envelope.

It outputs values on a scale of 0..1 corresponding to each phase.

Hierarchy (View Summary)

SimpleEventEmitter<AdsrEvents>
- AdsrBase
  - Adsr

Index

Constructors

Properties

attackDuration decayDuration decayDurationTotal releaseDuration shouldLoop

Accessors

hasTriggered isDisposed isDone

Methods

addEventListener compute computeRaw dispose fireEvent onTrigger release removeEventListener switchStateIfNeeded trigger

Constructors

constructor

new AdsrBase(opts?: Partial): AdsrBase
Parameters
- opts: Partial = {}
Returns AdsrBase
Overrides SimpleEventEmitter.constructor

Properties

`Protected`attackDuration

attackDuration: number

`Protected`decayDuration

decayDuration: number

`Protected`decayDurationTotal

decayDurationTotal: number

`Protected`releaseDuration

releaseDuration: number

shouldLoop

shouldLoop: boolean

If true envelope will loop

Accessors

hasTriggered

get hasTriggered(): boolean
Returns boolean

isDisposed

get isDisposed(): boolean
Returns boolean
Overrides SimpleEventEmitter.isDisposed

isDone

get isDone(): boolean
Returns true if envelope has finished

Returns boolean

Methods

addEventListener

addEventListener<K extends keyof AdsrEvents>(
    name: K,
    listener: (
        event: AdsrEvents[K],
        sender: SimpleEventEmitter<AdsrEvents>,
    ) => void,
): void
Adds event listener.
Type Parameters
- Kextendskeyof AdsrEvents
  Events
Parameters
- name: K
  Event name
- listener: (event: AdsrEvents[K], sender: SimpleEventEmitter<AdsrEvents>) => void
  Event handler
Returns void
Throws
Error if emitter is disposed

Inherited from SimpleEventEmitter.addEventListener

compute

compute(): void
Returns void

`Protected`computeRaw

computeRaw(
allowStateChange?: boolean,
allowLooping?: boolean,
): [stage: string, amount: number, prevStage: string]
Computes a stage's progress from 0-1
Parameters
- allowStateChange: boolean = true
- allowLooping: boolean = true
Returns [stage: string, amount: number, prevStage: string]

dispose

dispose(): void
Returns void
Overrides SimpleEventEmitter.dispose

`Protected`fireEvent

fireEvent<K extends keyof AdsrEvents>(type: K, args: AdsrEvents[K]): void
Fire event
Type Parameters
- Kextendskeyof AdsrEvents
Parameters
- type: K
  Type of event
- args: AdsrEvents[K]
  Arguments for event
Returns void
Inherited from SimpleEventEmitter.fireEvent

`Protected`onTrigger

onTrigger(): void
Returns void

release

release(): void
Release if 'trigger(true)' was previouslly called. Has no effect if not triggered or held.

Returns void

removeEventListener

removeEventListener<K extends keyof AdsrEvents>(
    type: K,
    listener: (
        event: AdsrEvents[K],
        sender: SimpleEventEmitter<AdsrEvents>,
    ) => void,
): void
Remove event listener
Type Parameters
- Kextendskeyof AdsrEvents
Parameters
- type: K
- listener: (event: AdsrEvents[K], sender: SimpleEventEmitter<AdsrEvents>) => void
Returns void
Inherited from SimpleEventEmitter.removeEventListener

`Protected`switchStateIfNeeded

switchStateIfNeeded(allowLooping: boolean): boolean
Changes state based on timer status
Parameters
- allowLooping: boolean
Returns boolean
True if state was changed

trigger

trigger(hold?: boolean): void
Triggers envelope, optionally holding it.

If hold is false (default), envelope will run through all stages, but sustain stage won't have an affect.

If hold is true, it will run to, and stay at the sustain stage. Use release to later release the envelope.

If event is already trigged it will be retriggered. Initial value depends on opts.retrigger
- false (default): envelope continues at current value.
- true: envelope value resets to opts.initialValue.
Parameters
- hold: boolean = false
  If true envelope will hold at sustain stage
Returns void