Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## ddf.minim.spi
Interface SampleRecorder

All Superinterfaces:
  AudioListener

    public interface SampleRecorder

extends AudioListener

`SampleRecorder` is an interface that describes the limited set of functionality required of an object that records samples. It is not required that the `SampleRecorder` records to disk, though the implementations in Minim do so.

Author:
  Damien Di Fede

Method Summary
`void` | `beginRecord()` Begins recording.
`void` | `endRecord()` Halts recording.
`java.lang.String` | `filePath()` Returns the full path to the file this is saving to, if it exists.
`boolean` | `isRecording()` Returns the current record state.
`AudioRecordingStream` | `save()` Saves the recorded samples, probably to disk.

Methods inherited from interface ddf.minim.AudioListener
`samples, samples`

Method Detail

### filePath

    java.lang.String filePath()

  Returns the full path to the file this is saving to, if it exists. If this is not saving to a file, an empty `String` will be returned.

  Returns:
    the full path to the file or an empty String

### beginRecord

    void beginRecord()

  Begins recording.

### endRecord

    void endRecord()

  Halts recording.

### isRecording

    boolean isRecording()

  Returns the current record state.

  Returns:
    true if this is recording

### save

    AudioRecordingStream save()

  Saves the recorded samples, probably to disk. Returns the recorded audio as an AudioRecordingStream.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD