Skip to content

Commit

Permalink
make init documentation more clear
Browse files Browse the repository at this point in the history
  • Loading branch information
terry083000 committed Jul 1, 2024
1 parent da44b38 commit 6714185
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/Chuck.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export default class Chuck extends window.AudioWorkletNode {
* @example
* ```ts
* // Initialize ChucK with a list of files to preload
* theChuck = await Chuck.init([{ serverFilename: "./path/filename.ck", virtualFilename: "filename.ck" }...]);
* theChuck = await Chuck.init([{ serverFilename: "./path/filename.wav", virtualFilename: "filename.wav" }...]);
* ```
*
* @example
Expand All @@ -102,7 +102,7 @@ export default class Chuck extends window.AudioWorkletNode {
* theChuck = await Chuck.init([], undefined, undefined, "./src");
* ```
*
* @param filenamesToPreload Array of Files to preload into ChucK's filesystem `[{serverFilename: "./path/filename", virtualFilename: "filename"}...]`
* @param filenamesToPreload Array of auxiliary files to preload into ChucK's filesystem. These can be .wav files, .ck files, .etc. `[{serverFilename: "./path/filename.wav", virtualFilename: "filename.wav"}...]`
* @param audioContext Optional parameter if you want to use your own AudioContext. **Note**: If an AudioContext is passed in, you will need to connect the ChucK instance to your own destination.
* @param numOutChannels Optional custom number of output channels. Default is 2 channel stereo and the Web Audio API supports up to 32 channels.
* @param whereIsChuck Optional custom url to your WebChucK `src` folder containing `webchuck.js` and `webchuck.wasm`. By default, `whereIsChuck` is {@link https://chuck.stanford.edu/webchuck/src | here}.
Expand Down

0 comments on commit 6714185

Please sign in to comment.