WebAudioFont

https://surikov.github.io/webaudiofont/
Admin
WebAudioFont is a sample-based synthesis library that allows you to play thousands of GM MIDI...
Tokens:117,201
Snippets:2,424
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Minimal NPM JavaScript Setup

Source: https://surikov.github.io/webaudiofont/npm/src/docs/index.html

Basic JavaScript setup for using WebAudioFont via NPM. This snippet shows how to require the library and instantiate the player.

```javascript
var webaudiofont = require('webaudiofont');
var player = new WebAudioFontPlayer();
```

--------------------------------

### Hello, World Example

Source: https://surikov.github.io/webaudiofont/npm/src/docs/index.html

A minimal HTML page demonstrating how to initialize WebAudioFontPlayer, load an instrument, and play a single note.

```html
<html>
    <head>
        <script src='https://surikov.github.io/webaudiofont/npm/dist/WebAudioFontPlayer.js'></script>
        <script src='https://surikov.github.io/webaudiofontdata/sound/0250_SoundBlasterOld_sf2.js'></script>
        <script>
            var AudioContextFunc = window.AudioContext || window.webkitAudioContext;
            var audioContext = new AudioContextFunc();
            var player=new WebAudioFontPlayer();
            player.loader.decodeAfterLoading(audioContext, '_tone_0250_SoundBlasterOld_sf2');
            function play(){
                player.queueWaveTable(audioContext, audioContext.destination
                    , _tone_0250_SoundBlasterOld_sf2, 0, 12*4+7, 2);
                return false;
            }
        </script>
    </head>
    <body>
        <p><a href='javascript:play();'>Hello, world!</a></p>
    </body>
</html>
```

--------------------------------

### Initialize WebAudioFontReverberator

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/reverberator.WebAudioFontReverberator.html

Demonstrates how to create a new instance of the WebAudioFontReverberator. This is the basic setup required before applying any reverberation effects.

```javascript
const reverberator = new WebAudioFontReverberator();
```

--------------------------------

### Minimal NPM Installation for WebAudioFont

Source: https://surikov.github.io/webaudiofont

Shows the basic JavaScript and package.json configuration for using WebAudioFont via NPM.

```javascript
var webaudiofont = require('webaudiofont');
var player = new WebAudioFontPlayer();

```

```json
...
"devDependencies": {
	"webaudiofont":"^2.5.0"
...

```

--------------------------------

### WebAudioFontTicker.startTicks

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/ticker.WebAudioFontTicker.html

Starts the tick scheduling process with callbacks for tick events and loop completion.

```APIDOC
## startTicks

### Description
Starts the tick scheduling process with callbacks for tick events and loop completion.

### Parameters
#### audioContext: AudioContext
#### onTick: (when: number, from: number, to: number) => void
  * (when: number, from: number, to: number): void
    ### Parameters
      * when: number
      * from: number
      * to: number
#### loopStart: number
#### loopPosition: number
#### loopEnd: number
#### onEnd: (loopPosition: number) => void
  * (loopPosition: number): void
    ### Parameters
      * loopPosition: number

### Returns
void
```

--------------------------------

### NPM package.json Configuration

Source: https://surikov.github.io/webaudiofont/npm/src/docs/index.html

Example configuration for a package.json file to include WebAudioFont as a dev dependency. Ensure the version matches your project's needs.

```json
...
"devDependencies": {
    "webaudiofont":"^2.5.0"
...

```

--------------------------------

### Minimal HTML Page with WebAudioFont

Source: https://surikov.github.io/webaudiofont

This is a basic HTML setup to play a single note using WebAudioFont. It includes the necessary script includes and a JavaScript function to trigger playback.

```html
<html>
	<head>
		<script src='https://surikov.github.io/webaudiofont/npm/dist/WebAudioFontPlayer.js'></script>
		<script src='https://surikov.github.io/webaudiofontdata/sound/0250_SoundBlasterOld_sf2.js'></script>
		<script>
			var AudioContextFunc = window.AudioContext || window.webkitAudioContext;
			var audioContext = new AudioContextFunc();
			var player=new WebAudioFontPlayer();
			player.loader.decodeAfterLoading(audioContext, '_tone_0250_SoundBlasterOld_sf2');
			function play(){
				player.queueWaveTable(audioContext, audioContext.destination
					, _tone_0250_SoundBlasterOld_sf2, 0, 12*4+7, 2);
				return false;
			}
		</script>
	</head>
	<body>
		<p><a href='javascript:play();'>Hello, world!</a></p>
	</body>
</html>

```

--------------------------------

### progress

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/loader.WebAudioFontLoader.html

Gets the current loading progress as a number between 0 and 1.

```APIDOC
## progress

### Description
Returns the current progress of the audio font loading process.

### Returns
- **number** - A number between 0 and 1 representing the loading progress.
```

--------------------------------

### drumKeys

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/loader.WebAudioFontLoader.html

Gets an array of all available drum keys.

```APIDOC
## drumKeys

### Description
Retrieves an array containing all the keys (identifiers) for the available drum sounds.

### Returns
- **string[]** - An array of strings representing the drum keys.
```

--------------------------------

### instrumentKeys

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/loader.WebAudioFontLoader.html

Gets an array of all available instrument keys.

```APIDOC
## instrumentKeys

### Description
Retrieves an array containing all the keys (identifiers) for the available instrument sounds.

### Returns
- **string[]** - An array of strings representing the instrument keys.
```

--------------------------------

### drumTitles

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/loader.WebAudioFontLoader.html

Gets an array of all available drum titles.

```APIDOC
## drumTitles

### Description
Retrieves an array containing the display titles for all available drum sounds.

### Returns
- **string[]** - An array of strings representing the drum titles.
```

--------------------------------

### startLoad

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/loader.WebAudioFontLoader.html

Initiates the loading process for an audio font from a specified file path.

```APIDOC
## startLoad

### Description
Starts the asynchronous loading of an audio font from a given file path.

### Parameters
#### audioContext
- **audioContext** (AudioContext) - The AudioContext to use for loading.
#### filePath
- **filePath** (string) - The path to the audio font file.
#### variableName
- **variableName** (string) - A name to associate with this loaded audio font.

### Returns
- **void**
```

--------------------------------

### setupEnvelope

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Sets up an audio envelope with specified parameters. This method is used internally for configuring how notes are played.

```APIDOC
## setupEnvelope

### Description
Sets up an audio envelope with specified parameters. This method is used internally for configuring how notes are played.

### Method
setupEnvelope

### Parameters
* **audioContext**: AudioContext - The Web Audio API AudioContext.
* **envelope**: WaveEnvelope - The WaveEnvelope object to configure.
* **zone**: WaveZone - The zone defining the sound characteristics for the envelope.
* **volume**: number - The volume for the envelope.
* **when**: number - The time at which the envelope should be set up.
* **sampleDuration**: number - The duration of the audio sample.
* **noteDuration**: number - The duration of the note.

### Returns
void
```

--------------------------------

### WebAudioFontPlayer Constructor

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Initializes a new instance of the WebAudioFontPlayer class.

```APIDOC
## constructor

### Description
Initializes a new instance of the WebAudioFontPlayer class.

### Method
constructor

### Returns
WebAudioFontPlayer
```

--------------------------------

### WebAudioFontLoader Constructor

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/loader.WebAudioFontLoader.html

Initializes a new instance of the WebAudioFontLoader class.

```APIDOC
## constructor

### Description
Initializes a new instance of the WebAudioFontLoader class.

### Parameters
#### player
- **player** (WebAudioFontPlayer) - The WebAudioFontPlayer instance to be used by the loader.

### Returns
- **WebAudioFontLoader** - A new instance of WebAudioFontLoader.
```

--------------------------------

### WebAudioFontTicker Constructor

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/ticker.WebAudioFontTicker.html

Initializes a new instance of the WebAudioFontTicker class.

```APIDOC
## constructor

### Description
Initializes a new instance of the WebAudioFontTicker class.

### Returns
WebAudioFontTicker
```

--------------------------------

### Dynamic Instrument Loading with WebAudioFont

Source: https://surikov.github.io/webaudiofont

Demonstrates how to dynamically load instrument soundfonts using WebAudioFont's startLoad and waitLoad functions. Loaded instruments are cached in memory.

```javascript
var instr=null;
var AudioContextFunc = window.AudioContext || window.webkitAudioContext;
var audioContext = new AudioContextFunc();
var player=new WebAudioFontPlayer();
function changeInstrument(path,name){
	player.loader.startLoad(audioContext, path, name);
	player.loader.waitLoad(function () {
		instr=window[name];
	});
}
changeInstrument('https://surikov.github.io/webaudiofontdata/sound/0290_Aspirin_sf2_file.js','_tone_0290_Aspirin_sf2_file');

```

--------------------------------

### Dynamic Instrument Loading

Source: https://surikov.github.io/webaudiofont/npm/src/docs/index.html

Demonstrates how to dynamically load instrument data using startLoad and waitLoad functions. Loaded instruments are cached in memory.

```javascript
var instr=null;
var AudioContextFunc = window.AudioContext || window.webkitAudioContext;
var audioContext = new AudioContextFunc();
var player=new WebAudioFontPlayer();
function changeInstrument(path,name){
    player.loader.startLoad(audioContext, path, name);
    player.loader.waitLoad(function () {
        instr=window[name];
    });
}
changeInstrument('https://surikov.github.io/webaudiofontdata/sound/0290_Aspirin_sf2_file.js','_tone_0290_Aspirin_sf2_file');
```

--------------------------------

### WebAudioFontChannel Constructor

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/channel.WebAudioFontChannel.html

Initializes a new instance of the WebAudioFontChannel class. This constructor requires an AudioContext to be provided.

```APIDOC
## constructor WebAudioFontChannel

### Description
Initializes a new instance of the WebAudioFontChannel class.

### Parameters
#### audioContext
* **audioContext** (AudioContext) - The AudioContext to use for this channel.
```

--------------------------------

### resumeContext

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Resumes the audio context. This is often necessary due to browser autoplay policies.

```APIDOC
## resumeContext

### Description
Resumes the audio context. This is often necessary due to browser autoplay policies.

### Method
resumeContext

### Parameters
* **audioContext**: AudioContext - The Web Audio API AudioContext to resume.

### Returns
void
```

--------------------------------

### queueStrum Method

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Queues a strum to be played with specified parameters.

```APIDOC
## queueStrum

### Description
Queues a strum to be played with specified parameters.

### Method
queueStrum(audioContext: AudioContext, target: AudioNode, preset: WavePreset, when: number, pitches: number[], duration: number, volume?: number, slides?: WaveSlide[][]): WaveEnvelope[]

### Parameters
#### Path Parameters
* **audioContext** (AudioContext) - Description not available
* **target** (AudioNode) - Description not available
* **preset** (WavePreset) - Description not available
* **when** (number) - Description not available
* **pitches** (number[]) - Description not available
* **duration** (number) - Description not available
* **volume** (number) - Optional - Description not available
* **slides** (WaveSlide[][]) - Optional - Description not available

### Returns
WaveEnvelope[]
```

--------------------------------

### waitLoad

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/loader.WebAudioFontLoader.html

Waits for the audio font loading to complete and then executes a callback function.

```APIDOC
## waitLoad

### Description
Pauses execution until the audio font loading is complete, then calls the provided callback function.

### Parameters
#### onFinish
- **onFinish** (function) - The callback function to execute upon completion of loading.
  * Signature: `(): void`

### Returns
- **void**
```

--------------------------------

### adjustPreset Method

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Adjusts the preset for a given AudioContext.

```APIDOC
## adjustPreset

### Description
Adjusts the preset for a given AudioContext.

### Method
adjustPreset(audioContext: AudioContext, preset: WavePreset): void

### Parameters
#### Path Parameters
* **audioContext** (AudioContext) - Description not available
* **preset** (WavePreset) - Description not available

### Returns
void
```

--------------------------------

### waitOrFinish

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/loader.WebAudioFontLoader.html

Waits for a specific audio font to finish loading or completes immediately if already loaded, then executes a callback.

```APIDOC
## waitOrFinish

### Description
Waits for the audio font associated with `variableName` to finish loading. If it's already loaded, the callback is executed immediately.

### Parameters
#### variableName
- **variableName** (string) - The name of the audio font to wait for.
#### onFinish
- **onFinish** (function) - The callback function to execute once the audio font is loaded.
  * Signature: `(): void`

### Returns
- **void**
```

--------------------------------

### createChannel Method

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Creates a new audio channel for the given AudioContext.

```APIDOC
## createChannel

### Description
Creates a new audio channel for the given AudioContext.

### Method
createChannel(audioContext: AudioContext): WebAudioFontChannel

### Parameters
#### Path Parameters
* **audioContext** (AudioContext) - Description not available

### Returns
WebAudioFontChannel
```

--------------------------------

### WebAudioFontReverberator Constructor

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/reverberator.WebAudioFontReverberator.html

Initializes a new instance of the WebAudioFontReverberator class. It requires an AudioContext to set up the audio processing nodes.

```APIDOC
## constructor

### Description
Initializes a new instance of the WebAudioFontReverberator class.

### Signature
`new WebAudioFontReverberator(audioContext: AudioContext): WebAudioFontReverberator`

### Parameters
#### audioContext
- **audioContext** (AudioContext) - Required - The AudioContext to use for creating audio nodes.
```

--------------------------------

### queueChord Method

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Queues a chord to be played with specified parameters.

```APIDOC
## queueChord

### Description
Queues a chord to be played with specified parameters.

### Method
queueChord(audioContext: AudioContext, target: AudioNode, preset: WavePreset, when: number, pitches: number[], duration: number, volume?: number, slides?: WaveSlide[][]): WaveEnvelope[]

### Parameters
#### Path Parameters
* **audioContext** (AudioContext) - Description not available
* **target** (AudioNode) - Description not available
* **preset** (WavePreset) - Description not available
* **when** (number) - Description not available
* **pitches** (number[]) - Description not available
* **duration** (number) - Description not available
* **volume** (number) - Optional - Description not available
* **slides** (WaveSlide[][]) - Optional - Description not available

### Returns
WaveEnvelope[]
```

--------------------------------

### queueWaveTable

Source: https://surikov.github.io/webaudiofont

Queues a single note to be played using a WebAudioFontPlayer. This method allows for precise control over timing, pitch, duration, volume, and pitch slides.

```APIDOC
## queueWaveTable

### Description
Queues a single note to be played with specified parameters. Returns an envelope object for control.

### Method
queueWaveTable

### Parameters
#### Path Parameters
* None

#### Query Parameters
* None

#### Request Body
* **audioContext** (AudioContext) - The Web Audio API AudioContext.
* **target** (AudioNode) - The audio node to connect to (e.g., audioContext.destination).
* **preset** (variable) - The instrument preset to use.
* **when** (number) - The time to play the note (e.g., audioContext.currentTime or 0 for immediate playback).
* **pitch** (number) - The MIDI note pitch (0-127).
* **duration** (number) - The duration of the note in seconds.
* **volume** (number) - The volume of the note (0.0 to 1.0).
* **slides** (array) - An array of pitch bends.

### Request Example
```json
{
  "audioContext": "AudioContext object",
  "target": "audioContext.destination",
  "preset": "instrumentPreset",
  "when": 0,
  "pitch": 60,
  "duration": 2,
  "volume": 0.8,
  "slides": []
}
```

### Response
#### Success Response
* **envelope object** - An object that can be used to cancel the sound or access the AudioBufferSourceNode.

#### Response Example
```json
{
  "envelope": "envelope object details"
}
```
```

--------------------------------

### Chords and Strumming

Source: https://surikov.github.io/webaudiofont/npm/src/docs/index.html

Provides methods for playing chords and performing strumming effects, offering more complex musical arrangements.

```APIDOC
## Chords and Strumming

### Description
Methods for playing chords and executing strumming effects.

### Methods
* **queueChord**: Queues a chord to be played.
* **queueStrumUp**: Simulates a strum up effect.
* **queueStrumDown**: Simulates a strum down effect.
* **queueSnap**: Simulates a snap effect.

### Usage
Refer to the live example for detailed usage of these chord and strumming functions.
```

--------------------------------

### loaded

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/loader.WebAudioFontLoader.html

Checks if the audio data for a given variable name has been loaded.

```APIDOC
## loaded

### Description
Checks whether the audio font data associated with a specific variable name has been successfully loaded.

### Parameters
#### variableName
- **variableName** (string) - The name of the audio font data to check.

### Returns
- **boolean** - True if the data is loaded, false otherwise.
```

--------------------------------

### Chords and Strumming

Source: https://surikov.github.io/webaudiofont

Functions for playing chords and strumming effects. These include queueChord, queueStrumUp, queueStrumDown, and queueSnap.

```APIDOC
## Chords and Strumming

### Description
Provides methods for playing chords and simulating strumming actions.

### Methods
* **queueChord**: Plays a chord.
* **queueStrumUp**: Simulates a strum up.
* **queueStrumDown**: Simulates a strum down.
* **queueSnap**: Simulates a snap sound.

### Usage
Refer to the live example for detailed usage of these functions.
```

--------------------------------

### adjustZone Method

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Adjusts the zone for a given AudioContext.

```APIDOC
## adjustZone

### Description
Adjusts the zone for a given AudioContext.

### Method
adjustZone(audioContext: AudioContext, zone: WaveZone): void

### Parameters
#### Path Parameters
* **audioContext** (AudioContext) - Description not available
* **zone** (WaveZone) - Description not available

### Returns
void
```

--------------------------------

### queueSnap Method

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Queues a snap to be played with specified parameters.

```APIDOC
## queueSnap

### Description
Queues a snap to be played with specified parameters.

### Method
queueSnap(audioContext: AudioContext, target: AudioNode, preset: WavePreset, when: number, pitches: number[], duration: number, volume?: number, slides?: WaveSlide[][]): WaveEnvelope[]

### Parameters
#### Path Parameters
* **audioContext** (AudioContext) - Description not available
* **target** (AudioNode) - Description not available
* **preset** (WavePreset) - Description not available
* **when** (number) - Description not available
* **pitches** (number[]) - Description not available
* **duration** (number) - Description not available
* **volume** (number) - Optional - Description not available
* **slides** (WaveSlide[][]) - Optional - Description not available

### Returns
WaveEnvelope[]
```

--------------------------------

### Play Custom Instrument

Source: https://surikov.github.io/webaudiofont/examples/customsample.html

Queues a custom instrument to be played by the Web Audio API. Specify the audio context, destination node, instrument definition, MIDI program, MIDI key, velocity, and time in seconds. Use this to trigger custom sounds within your application.

```javascript
player.queueWaveTable(audioContext, audioContext.destination, myCustomSampledInstrument, 0, key, 2,0.5);
```

--------------------------------

### WebAudioFontTicker.playLoop

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/ticker.WebAudioFontTicker.html

Plays a loop of audio using the provided player and queue.

```APIDOC
## playLoop

### Description
Plays a loop of audio using the provided player and queue.

### Parameters
#### player: WebAudioFontPlayer
#### audioContext: AudioContext
#### loopStart: number
#### loopPosition: number
#### loopEnd: number
#### queue: ChordQueue[]

### Returns
void
```

--------------------------------

### instrumentInfo

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/loader.WebAudioFontLoader.html

Retrieves information about a specific instrument sound by its index.

```APIDOC
## instrumentInfo

### Description
Retrieves detailed information about a specific instrument sound based on its index.

### Parameters
#### n
- **n** (number) - The index of the instrument sound.

### Returns
- **PresetInfo** - An object containing information about the specified instrument sound.
```

--------------------------------

### queueWaveTable

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Queues a single note using a wavetable. This method is suitable for playing individual notes with specific timing and duration.

```APIDOC
## queueWaveTable

### Description
Queues a single note using a wavetable. This method is suitable for playing individual notes with specific timing and duration.

### Method
queueWaveTable

### Parameters
* **audioContext**: AudioContext - The Web Audio API AudioContext.
* **target**: AudioNode - The target AudioNode to connect the audio to.
* **preset**: WavePreset - The preset defining the sound characteristics.
* **when**: number - The time at which the note should start playing.
* **pitch**: number - The MIDI pitch number of the note.
* **duration**: number - The duration of the note in seconds.
* **volume**: number (Optional) - The volume of the note, ranging from 0 to 1.
* **slides**: WaveSlide[] (Optional) - An array of slide definitions for the note.

### Returns
null | WaveEnvelope - A WaveEnvelope object representing the queued note, or null if an error occurred.
```

--------------------------------

### findZone Method

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Finds a zone within a preset for a given pitch in the AudioContext.

```APIDOC
## findZone

### Description
Finds a zone within a preset for a given pitch in the AudioContext.

### Method
findZone(audioContext: AudioContext, preset: WavePreset, pitch: number): null | WaveZone

### Parameters
#### Path Parameters
* **audioContext** (AudioContext) - Description not available
* **preset** (WavePreset) - Description not available
* **pitch** (number) - Description not available

### Returns
null | WaveZone
```

--------------------------------

### PresetInfo Type Alias

Source: https://surikov.github.io/webaudiofont/npm/src/docs/modules/otypes.html

Structure for preset information, including pitch, title, URL, and variable name.

```APIDOC
## PresetInfo

### Description
Contains information about a preset, such as its pitch, title, URL, and associated variable name.

### Type Declaration
- **pitch**: number
- **title**: string
- **url**: string
- **variable**: string
```

--------------------------------

### queueStrumUp

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Queues a strum up effect for a series of pitches. This method is used to play a sequence of notes with an upward strumming motion.

```APIDOC
## queueStrumUp

### Description
Queues a strum up effect for a series of pitches. This method is used to play a sequence of notes with an upward strumming motion.

### Method
queueStrumUp

### Parameters
* **audioContext**: AudioContext - The Web Audio API AudioContext.
* **target**: AudioNode - The target AudioNode to connect the audio to.
* **preset**: WavePreset - The preset defining the sound characteristics.
* **when**: number - The time at which the notes should start playing.
* **pitches**: number[] - An array of MIDI pitch numbers to play.
* **duration**: number - The duration of each note in seconds.
* **volume**: number (Optional) - The volume of the notes, ranging from 0 to 1.
* **slides**: WaveSlide[][] (Optional) - An array of slide definitions for each note.

### Returns
WaveEnvelope[] - An array of WaveEnvelope objects representing the queued notes.
```

--------------------------------

### decodeAfterLoading

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/loader.WebAudioFontLoader.html

Decodes audio data after it has been loaded.

```APIDOC
## decodeAfterLoading

### Description
Decodes audio data after it has been loaded, making it ready for playback.

### Parameters
#### audioContext
- **audioContext** (AudioContext) - The AudioContext to use for decoding.
#### variableName
- **variableName** (string) - The name associated with the loaded audio data.

### Returns
- **void**
```

--------------------------------

### bandEqualizer Method

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/channel.WebAudioFontChannel.html

Applies a band equalizer to an audio node. This method takes an audio node and a frequency as input and returns a BiquadFilterNode.

```APIDOC
## bandEqualizer

### Description
Applies a band equalizer to an audio node.

### Parameters
#### from
* **from** (AudioNode) - The audio node to apply the equalizer to.
#### frequency
* **frequency** (number) - The frequency for the equalizer band.

### Returns
* **BiquadFilterNode** - The created BiquadFilterNode.
```

--------------------------------

### Define Custom Sampled Instrument

Source: https://surikov.github.io/webaudiofont/examples/customsample.html

Defines a custom instrument with a single zone, specifying MIDI program, root pitch, key range, loop points, tuning, sample rate, AHDSR envelope, and the Base64 encoded audio file. Use this to create your own playable instruments from audio samples.

```javascript
var myCustomSampledInstrument={
	zones:[
		{
			midi:0 //MIDI program
			,originalPitch: 84*100-36*100 //root pitch in cent, may be transpose up/down
			,keyRangeLow: 12*3+6 //zone low key
			,keyRangeHigh: 127 //zone high key
			,loopStart: 0 //loop tart in seconds
			,loopEnd: 0 //loop end in seconds
			,coarseTune: 0 //use fine tune
			,fineTune: -11 //tune correction in cents
			,sampleRate: 48000 //file sample rate
			,ahdsr: true // see example
			,file:'//uUxAAAAAAAAAAAAAAAAAAAAAAAWGluZwAAAA8AAADzAA...'
		}
	]
};
		
```

--------------------------------

### noZeroVolume Method

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Ensures a number is not zero.

```APIDOC
## noZeroVolume

### Description
Ensures a number is not zero.

### Method
noZeroVolume(n: number): number

### Parameters
#### Path Parameters
* **n** (number) - Description not available

### Returns
number
```

--------------------------------

### WavePreset Type Alias

Source: https://surikov.github.io/webaudiofont/npm/src/docs/modules/otypes.html

Represents a wave preset, primarily composed of an array of WaveZone objects.

```APIDOC
## WavePreset

### Description
Represents a complete wave preset, which is a collection of WaveZone definitions.

### Type Declaration
- **zones**: WaveZone[]
```

--------------------------------

### findInstrument

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/loader.WebAudioFontLoader.html

Finds the index of an instrument sound based on its program number.

```APIDOC
## findInstrument

### Description
Searches for an instrument sound and returns its corresponding index based on the General MIDI program number.

### Parameters
#### program
- **program** (number) - The General MIDI program number for the instrument.

### Returns
- **number** - The index of the found instrument sound.
```

--------------------------------

### drumInfo

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/loader.WebAudioFontLoader.html

Retrieves information about a specific drum sound by its index.

```APIDOC
## drumInfo

### Description
Retrieves detailed information about a specific drum sound based on its index.

### Parameters
#### n
- **n** (number) - The index of the drum sound.

### Returns
- **PresetInfo** - An object containing information about the specified drum sound.
```

--------------------------------

### limitVolume Method

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Limits a given volume to a valid range.

```APIDOC
## limitVolume

### Description
Limits a given volume to a valid range.

### Method
limitVolume(volume: undefined | number): number

### Parameters
#### Path Parameters
* **volume** (undefined | number) - Description not available

### Returns
number
```

--------------------------------

### findEnvelope Method

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Finds an envelope associated with a target AudioNode in the given AudioContext.

```APIDOC
## findEnvelope

### Description
Finds an envelope associated with a target AudioNode in the given AudioContext.

### Method
findEnvelope(audioContext: AudioContext, target: AudioNode): WaveEnvelope

### Parameters
#### Path Parameters
* **audioContext** (AudioContext) - Description not available
* **target** (AudioNode) - Description not available

### Returns
WaveEnvelope
```

--------------------------------

### WebAudioFontTicker.tick

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/ticker.WebAudioFontTicker.html

Processes a single tick, scheduling the next audio event and handling callbacks.

```APIDOC
## tick

### Description
Processes a single tick, scheduling the next audio event and handling callbacks.

### Parameters
#### audioContext: AudioContext
#### nextAudioTime: number
#### onTick: (when: number, from: number, to: number) => void
  * (when: number, from: number, to: number): void
    ### Parameters
      * when: number
      * from: number
      * to: number
#### loopStart: number
#### loopPosition: number
#### loopEnd: number
#### onEnd: (loopPosition: number) => void
  * (loopPosition: number): void
    ### Parameters
      * loopPosition: number

### Returns
void
```

--------------------------------

### queueStrumDown

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Queues a strum down effect for a series of pitches. This method is used to play a sequence of notes with a strumming motion.

```APIDOC
## queueStrumDown

### Description
Queues a strum down effect for a series of pitches. This method is used to play a sequence of notes with a strumming motion.

### Method
queueStrumDown

### Parameters
* **audioContext**: AudioContext - The Web Audio API AudioContext.
* **target**: AudioNode - The target AudioNode to connect the audio to.
* **preset**: WavePreset - The preset defining the sound characteristics.
* **when**: number - The time at which the notes should start playing.
* **pitches**: number[] - An array of MIDI pitch numbers to play.
* **duration**: number - The duration of each note in seconds.
* **volume**: number (Optional) - The volume of the notes, ranging from 0 to 1.
* **slides**: WaveSlide[][] (Optional) - An array of slide definitions for each note.

### Returns
WaveEnvelope[] - An array of WaveEnvelope objects representing the queued notes.
```

--------------------------------

### CachedPreset Type Alias

Source: https://surikov.github.io/webaudiofont/npm/src/docs/modules/otypes.html

Represents a cached preset with its file path and variable name.

```APIDOC
## CachedPreset

### Description
Represents a cached preset, storing the file path and the variable name associated with it.

### Type Declaration
- **filePath**: string
- **variableName**: string
```

--------------------------------

### numValue Method

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Converts a value to a number, providing a default if conversion fails.

```APIDOC
## numValue

### Description
Converts a value to a number, providing a default if conversion fails.

### Method
numValue(aValue: any, defValue: number): number

### Parameters
#### Path Parameters
* **aValue** (any) - Description not available
* **defValue** (number) - Description not available

### Returns
number
```

--------------------------------

### createReverberator Method

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Creates a reverberator effect for the given AudioContext.

```APIDOC
## createReverberator

### Description
Creates a reverberator effect for the given AudioContext.

### Method
createReverberator(audioContext: AudioContext): WebAudioFontReverberator

### Parameters
#### Path Parameters
* **audioContext** (AudioContext) - Description not available

### Returns
WebAudioFontReverberator
```

--------------------------------

### ChordQueue Type Alias

Source: https://surikov.github.io/webaudiofont/npm/src/docs/modules/otypes.html

Defines the structure for a chord queue, including destination, duration, pitch, preset, and optional slides and volume.

```APIDOC
## ChordQueue

### Description
Represents a queue for playing chords, specifying the audio destination, duration, pitch, and preset. It also supports optional slides and volume settings.

### Type Declaration
- **destination**: AudioNode
- **duration**: number
- **pitch**: number
- **preset**: WavePreset
- **Optional slides?**: WaveSlide[]
- **Optional volume?**: number
- **when**: number
```

--------------------------------

### WaveZone Type Alias

Source: https://surikov.github.io/webaudiofont/npm/src/docs/modules/otypes.html

Details a wave zone, including its AHDSR settings, buffer, tuning, key range, looping points, and sample information.

```APIDOC
## WaveZone

### Description
Defines a single zone within a wave, specifying its AHDSR envelope, audio buffer, tuning parameters, key range, looping information, and sample details.

### Type Declaration
- **Optional ahdsr?**: boolean | WaveAHDSR[]
- **Optional buffer?**: AudioBuffer
- **coarseTune**: number
- **Optional delay?**: number
- **Optional file?**: string
- **fineTune**: number
- **keyRangeHigh**: number
- **keyRangeLow**: number
- **loopEnd**: number
- **loopStart**: number
- **originalPitch**: number
- **Optional sample?**: string
- **sampleRate**: number
- **Optional sustain?**: number
```

--------------------------------

### WebAudioFontTicker.cancel

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/ticker.WebAudioFontTicker.html

Cancels any ongoing tick operations.

```APIDOC
## cancel

### Description
Cancels any ongoing tick operations.

### Returns
void
```

--------------------------------

### WebAudioFontReverberator Properties

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/reverberator.WebAudioFontReverberator.html

This snippet details the publicly accessible properties of the WebAudioFontReverberator class.

```APIDOC
## WebAudioFontReverberator

### Description
Represents a reverberator effect for WebAudioFont.

### Properties

#### irrArrayBuffer
- **irrArrayBuffer** (ArrayBuffer) - The impulse response buffer for the reverberator.

#### output
- **output** (GainNode) - The output node of the reverberator.

#### wet
- **wet** (GainNode) - The wet gain node controlling the reverberated signal level.
```

--------------------------------

### WaveEnvelope Type Alias

Source: https://surikov.github.io/webaudiofont/npm/src/docs/modules/otypes.html

Details the parameters for a Wave Envelope, including its associated AudioBufferSourceNode, duration, pitch, preset, target, and timing.

```APIDOC
## WaveEnvelope

### Description
Defines the parameters for a wave envelope, including optional AudioBufferSourceNode, duration, pitch, preset, target node, and timing. It also includes a cancel function.

### Type Declaration
- **Optional audioBufferSourceNode?**: AudioBufferSourceNode | null
- **duration**: number
- **pitch**: number
- **preset**: WavePreset
- **target**: AudioNode
- **when**: number
- **cancel**: function
  - cancel(): void
    - Returns: void
```

--------------------------------

### findDrum

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/loader.WebAudioFontLoader.html

Finds the index of a drum sound based on its number.

```APIDOC
## findDrum

### Description
Searches for a drum sound and returns its corresponding index.

### Parameters
#### nn
- **nn** (number) - The number identifier for the drum sound to find.

### Returns
- **number** - The index of the found drum sound.
```

--------------------------------

### cancelQueue Method

Source: https://surikov.github.io/webaudiofont/npm/src/docs/classes/player.WebAudioFontPlayer.html

Cancels all queued audio events for the given AudioContext.

```APIDOC
## cancelQueue

### Description
Cancels all queued audio events for the given AudioContext.

### Method
cancelQueue(audioContext: AudioContext): void

### Parameters
#### Path Parameters
* **audioContext** (AudioContext) - Description not available

### Returns
void
```

--------------------------------

### WaveAHDSR Type Alias

Source: https://surikov.github.io/webaudiofont/npm/src/docs/modules/otypes.html

Defines the Attack, Hold, Decay, Sustain, Release (AHDSR) envelope parameters.

```APIDOC
## WaveAHDSR

### Description
Represents the parameters for an Attack, Hold, Decay, Sustain, Release (AHDSR) envelope, including duration and volume.

### Type Declaration
- **duration**: number
- **volume**: number
```

--------------------------------

### NumPair Type Alias

Source: https://surikov.github.io/webaudiofont/npm/src/docs/modules/otypes.html

A simple type alias for an array of numbers.

```APIDOC
## NumPair

### Description
An alias for a number array, typically used for pairs of numerical values.

### Type Declaration
- **NumPair**: number[]
```

--------------------------------

### WaveSlide Type Alias

Source: https://surikov.github.io/webaudiofont/npm/src/docs/modules/otypes.html

Defines a wave slide, specifying the delta change and the time when it occurs.

```APIDOC
## WaveSlide

### Description
Represents a slide in a wave, defined by a delta value and the time ('when') it should occur.

### Type Declaration
- **delta**: number
- **when**: number
```
Tokens:
Raw