Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisn committed Jan 18, 2024
1 parent 26d726f commit 0f2bd51
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions doc/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ Audio API.
| `array_buffer` | [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) | Contains encoded audio. If using this option, an `audio_context` is also required |
| `audio_buffer` | [`AudioBuffer`](https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer) | Contains decoded audio. If using this option, an `audio_context` is not required |
| `scale` | Number (integer, default: `512`) | Controls the resolution of the waveform data by specifying the number of input audio samples per output waveform data point |
| `bits` | Number (integer, default: `8`) | Sets the number of bits to use for output waveform data points. Valid values are either `8` or `16`. |
| `amplitude_scale` | Number (default: `1.0`) | Applies amplitude scaling to the waveform data. For example, set to `2.0` to double the waveform amplitude |
| `split_channels` | Boolean (default: `false`) | Set to `true` to produce separate waveform channels instead of combining all channels into a single waveform |
| `disable_worker` | Boolean (default: `false`) | Set to `true` to disable use of a [Web Worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers) |
Expand Down

0 comments on commit 0f2bd51

Please sign in to comment.