Skip to content

Commit aaa926b

Browse files
author
Matt Diamond
committed
updating docs
1 parent c00bfb9 commit aaa926b

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Creates a recorder instance.
2020

2121
- **bufferLen** - The length of the buffer that the internal JavaScriptNode uses to capture the audio. Can be tweaked if experiencing performance issues. Defaults to 4096.
2222
- **callback** - A default callback to be used with `exportWAV`.
23+
- **type** - The type of the Blob generated by `exportWAV`. Defaults to 'audio/wav'. To force a download, try setting this to 'application/octet-stream'.
2324

2425
---------
2526
#### Methods
@@ -33,10 +34,12 @@ Pretty self-explanatory... **record** will begin capturing audio and **stop** wi
3334

3435
This will clear the recording.
3536

36-
rec.exportWAV([callback])
37+
rec.exportWAV([callback] [, type])
3738

3839
This will generate a Blob object containing the recording in WAV format. The callback will be called with the Blob as its sole argument. If a callback is not specified, the default callback (as defined in the config) will be used. If no default has been set, an error will be thrown.
3940

41+
In addition, you may specify the type of Blob to be returned (defaults to 'audio/wav').
42+
4043
rec.configure(config)
4144

4245
This will set the configuration for Recorder by passing in a config object.

0 commit comments

Comments
 (0)