ddf.minim

Class AudioRecorder

java.lang.Object

ddf.minim.AudioRecorder

public class AudioRecorder
extends java.lang.Object

An AudioRecorder can be used to record audio that is being played by a Recordable object such as an AudioOutput, AudioInput, or AudioPlayer. An AudioRecorder need not necessarily record to disk, but the recorders you receive from Minim's createRecorder method will do so.

Author:

Damien Di Fede

Constructor Summary

Constructors

Constructor and Description
AudioRecorder(Recordable recordSource, ddf.minim.spi.SampleRecorder recorder)

Method Summary

Modifier and Type	Method and Description
void	beginRecord() Begins recording audio from the current record source.
void	endRecord() Halts the recording of audio from the current record source.
boolean	isRecording() Returns the current record state.
ddf.minim.spi.AudioRecordingStream	save() Requests that the recorder saves.
void	setRecordSource(Recordable recordSource) Sets the record source for this recorder.
void	setSampleRecorder(ddf.minim.spi.SampleRecorder recorder)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AudioRecorder

public AudioRecorder(Recordable recordSource,
                     ddf.minim.spi.SampleRecorder recorder)

Parameters:

recordSource - the Recordable object to record

recorder - the SampleRecorder to use to record it

Method Detail

beginRecord

public void beginRecord()

Begins recording audio from the current record source. If recording was previously halted, and the save method was not called, samples will be appended to the end of the material recorded so far.

endRecord

public void endRecord()

Halts the recording of audio from the current record source.

isRecording

public boolean isRecording()

Returns the current record state.

Returns:

true if this is currently recording

save

public ddf.minim.spi.AudioRecordingStream save()

Requests that the recorder saves. This will only work if you have called the endRecord method. If this was created with a buffered recorder, then calling the beginRecord method after saving will not overwrite the file on the disk, unless this method is subsequently called. However, if this was created with an unbuffered recorder, it is likely that a call to the beginRecord method will create the file again, overwriting the file that had previously been saved. An AudioRecordingStream will be returned if the SampleRecorder used to record the audio saved to a file (this will always be the case if you use createRecorder or the first constructor for AudioRecorder).

Returns:

the audio that was recorded as an AudioRecordingStream

setRecordSource

public void setRecordSource(Recordable recordSource)

Sets the record source for this recorder. The record source can be set at any time, but if you are in the middle of recording it is a good idea to mute the old record source, then add the new record source, also muted, and then unmute the new record source. Otherwise, you'll probably wind up with a pop in the recording.

Parameters:

recordSource - an AudioSample, AudioPlayer, AudioInput, or AudioOutput

setSampleRecorder

public void setSampleRecorder(ddf.minim.spi.SampleRecorder recorder)

Parameters:

recorder - the new SampleRecorder to use