[rbdr/r.bdr.sh] / jekyll / js / vendor / recorderjs / README.md

# Recorder.js

## A plugin for recording/exporting the output of Web Audio API nodes

### Syntax
#### Constructor
    var rec = new Recorder(source [, config])

Creates a recorder instance.

- **source** - The node whose output you wish to capture
- **config** - (*optional*) A configuration object (see **config** section below)

---------
#### Config

- **workerPath** - Path to recorder.js worker script. Defaults to 'js/recorderjs/recorderWorker.js'
- **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.
- **callback** - A default callback to be used with `exportWAV`.
- **type** - The type of the Blob generated by `exportWAV`. Defaults to 'audio/wav'.

---------
#### Instance Methods

    rec.record()
    rec.stop()

Pretty self-explanatory... **record** will begin capturing audio and **stop** will cease capturing audio. Subsequent calls to **record** will add to the current recording.

    rec.clear()

This will clear the recording.

    rec.exportWAV([callback][, type])

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.

In addition, you may specify the type of Blob to be returned (defaults to 'audio/wav').

    rec.getBuffer([callback])

This will pass the recorded stereo buffer (as an array of two Float32Arrays, for the separate left and right channels) to the callback. It can be played back by creating a new source buffer and setting these buffers as the separate channel data:

	function getBufferCallback( buffers ) {
		var newSource = audioContext.createBufferSource();
		var newBuffer = audioContext.createBuffer( 2, buffers[0].length, audioContext.sampleRate );
		newBuffer.getChannelData(0).set(buffers[0]);
		newBuffer.getChannelData(1).set(buffers[1]);
		newSource.buffer = newBuffer;

		newSource.connect( audioContext.destination );
		newSource.start(0);
	}

This sample code will play back the stereo buffer.


    rec.configure(config)

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

#### Utility Methods (static)

    Recorder.forceDownload(blob[, filename])

This method will force a download using the new anchor link *download* attribute. Filename defaults to 'output.wav'.

## License (MIT)

Copyright © 2013 Matt Diamond

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Commit	Line	Data
ea3786d9 BB	1	# Recorder.js
	2
	3	## A plugin for recording/exporting the output of Web Audio API nodes
	4
	5	### Syntax
	6	#### Constructor
	7	var rec = new Recorder(source [, config])
	8
	9	Creates a recorder instance.
	10
	11	- source - The node whose output you wish to capture
	12	- config - (optional) A configuration object (see config section below)
	13
	14	---------
	15	#### Config
	16
	17	- workerPath - Path to recorder.js worker script. Defaults to 'js/recorderjs/recorderWorker.js'
	18	- 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.
	19	- callback - A default callback to be used with `exportWAV`.
	20	- type - The type of the Blob generated by `exportWAV`. Defaults to 'audio/wav'.
	21
	22	---------
	23	#### Instance Methods
	24
	25	rec.record()
	26	rec.stop()
	27
	28	Pretty self-explanatory... record will begin capturing audio and stop will cease capturing audio. Subsequent calls to record will add to the current recording.
	29
	30	rec.clear()
	31
	32	This will clear the recording.
	33
	34	rec.exportWAV([callback][, type])
	35
	36	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.
	37
	38	In addition, you may specify the type of Blob to be returned (defaults to 'audio/wav').
	39
	40	rec.getBuffer([callback])
	41
	42	This will pass the recorded stereo buffer (as an array of two Float32Arrays, for the separate left and right channels) to the callback. It can be played back by creating a new source buffer and setting these buffers as the separate channel data:
	43
	44	function getBufferCallback( buffers ) {
	45	var newSource = audioContext.createBufferSource();
	46	var newBuffer = audioContext.createBuffer( 2, buffers[0].length, audioContext.sampleRate );
	47	newBuffer.getChannelData(0).set(buffers[0]);
	48	newBuffer.getChannelData(1).set(buffers[1]);
	49	newSource.buffer = newBuffer;
	50
	51	newSource.connect( audioContext.destination );
	52	newSource.start(0);
	53	}
	54
	55	This sample code will play back the stereo buffer.
	56
	57
	58	rec.configure(config)
	59
	60	This will set the configuration for Recorder by passing in a config object.
	61
	62	#### Utility Methods (static)
	63
	64	Recorder.forceDownload(blob[, filename])
65
66	This method will force a download using the new anchor link download attribute. Filename defaults to 'output.wav'.
67
68	## License (MIT)
69
70	Copyright © 2013 Matt Diamond
71
72	Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
73
74	The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
75
76	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.