1.1 --- a/src/com/aurellem/capture/audio/SoundProcessor.java	Mon Oct 31 07:43:44 2011 -0700
     1.2 +++ b/src/com/aurellem/capture/audio/SoundProcessor.java	Thu Nov 03 16:00:46 2011 -0700
     1.3 @@ -6,8 +6,25 @@
     1.4  
     1.5  public interface SoundProcessor {
     1.6  
     1.7 -	void cleanup();
     1.8 +    /**
     1.9 +     * Called when the SoundProcessor is being destroyed, and
    1.10 +     * there are no more samples to process.  This happens at the
    1.11 +     * latest when the Application is shutting down.
    1.12 +     * 
    1.13 +     */
    1.14 +    void cleanup();
    1.15  	
    1.16 -	void process(ByteBuffer audioSamples, int numSamples, AudioFormat format);
    1.17 +    /**
    1.18 +     * 
    1.19 +     * Called whenever there are new audio samples to process. The
    1.20 +     * audioSamples ByteBuffer contains 3D audio data rendered by
    1.21 +     * OpenAL.
    1.22 +     * 
    1.23 +     * @param audioSamples a ByteBuffer containing processed audio
    1.24 +     * samples
    1.25 +     * @param numSamples the number of samples, in bytes, that are valid
    1.26 +     * @param format the format of the audio samples in audioSamples
    1.27 +     */
    1.28 +    void process(ByteBuffer audioSamples, int numSamples, AudioFormat format);
    1.29  	
    1.30  }