Class SynthEventHandler

The synthesizer supports event handling. For example, the MIDI keyboard in the SpessaSynth web app uses it to visualize key presses.

It is accessible via the BasicSynthesizer.eventHandler property.

Event types can be found in LibSynthesizerEvent.

Hierarchy

BasicEventHandler<LibSynthesizerEvent>
- SynthEventHandler

Index

Properties

Methods

addEvent removeEvent

Properties

timeDelay

timeDelay: number = 0

The time delay before an event is called, in seconds. Set to 0 to disable it.

Methods

addEvent

addEvent<T extends keyof LibSynthesizerEvent>(
    event: T,
    id: string,
    callback: (callbackData: LibSynthesizerEvent[T]) => unknown,
): void
Adds a new event listener.
Type Parameters
- T extends keyof LibSynthesizerEvent
Parameters
- event: T
  The event type to listen for.
- id: string
  The unique identifier for the event. It can be used to overwrite an existing callback with the same ID.
- callback: (callbackData: LibSynthesizerEvent[T]) => unknown
  The callback for the event.
Returns void
Inherited from BasicEventHandler.addEvent
- Defined in src/utils/basic_event_handler.ts:26

removeEvent

removeEvent<T extends keyof LibSynthesizerEvent>(event: T, id: string): void
Removes an event listener.
Type Parameters
- T extends keyof LibSynthesizerEvent
Parameters
- event: T
  The event type to remove a listener from.
- id: string
  The unique identifier for the event to remove.
Returns void
Inherited from BasicEventHandler.removeEvent
- Defined in src/utils/basic_event_handler.ts:45