# HG changeset patch
# User Robert McIntyre <rlm@mit.edu>
# Date 1322940913 21600
# Node ID 8a091a5f48fad1744cd3061f5c1c0ca019566342
# Parent  121b6d7e4d3f9d4a5c87a40ca21906088119c7f9
documentation for basic use case

diff -r 121b6d7e4d3f -r 8a091a5f48fa src/com/aurellem/capture/examples/Advanced.java
--- a/src/com/aurellem/capture/examples/Advanced.java	Sat Dec 03 13:22:27 2011 -0600
+++ b/src/com/aurellem/capture/examples/Advanced.java	Sat Dec 03 13:35:13 2011 -0600
@@ -35,7 +35,6 @@
 import com.jme3.system.AppSettings;
 import com.jme3.system.JmeSystem;
 
-
 /**
  * 
  * Demonstrates advanced use of the audio capture and recording features.
@@ -57,7 +56,6 @@
 
 public class Advanced extends SimpleApplication {
 
-
 	private Geometry bell;
 	private Geometry ear1;
 	private Geometry ear2;
@@ -66,7 +64,6 @@
 	private MotionTrack motionControl;
 		
 	public static void main(String[] args) {
-		//Logger.getLogger("com.jme3").setLevel(Level.OFF); 
 		Advanced app = new Advanced();
 		AppSettings settings = new AppSettings(true);
 		settings.setAudioRenderer(AurellemSystemDelegate.SEND);
diff -r 121b6d7e4d3f -r 8a091a5f48fa src/com/aurellem/capture/examples/HelloAudioRecording.java
--- a/src/com/aurellem/capture/examples/HelloAudioRecording.java	Sat Dec 03 13:22:27 2011 -0600
+++ b/src/com/aurellem/capture/examples/HelloAudioRecording.java	Sat Dec 03 13:35:13 2011 -0600
@@ -9,6 +9,22 @@
 import com.aurellem.capture.IsoTimer;
 import com.jme3.app.Application;
 
+/** Recording audio from your Application is simple.  If all you 
+ *  want to do is record Audio, then follow the following steps.
+ * 
+ *  1.) Set the Application's timer to an IsoTimer.  The framerate is
+ *  irrelevant for sound, but must evenly divide 44,100Hz, which is the
+ *  frequency at which sound will be recorded.  For example
+ *  IsoTimer(60) is ok, but IsoTimer(61) is not.
+ * 
+ *  2.) Call Capture.captureAudio(yourApplication, target-file) before
+ *  calling yourApplication.start()
+ *  
+ *  That's it!  If you have any comments/problems, please PM me on the
+ *  jMonkeyEngine forms.  My username is bortreb.
+ * 
+ * @author Robert McIntyre
+ */
 public class HelloAudioRecording {
 
 	public static void main(String[] ignore) throws IOException{
@@ -19,5 +35,4 @@
 		app.start();
 		System.out.println(audio.getCanonicalPath());		
 	}
-	
 }
diff -r 121b6d7e4d3f -r 8a091a5f48fa src/com/aurellem/capture/examples/HelloVideoRecording.java
--- a/src/com/aurellem/capture/examples/HelloVideoRecording.java	Sat Dec 03 13:22:27 2011 -0600
+++ b/src/com/aurellem/capture/examples/HelloVideoRecording.java	Sat Dec 03 13:35:13 2011 -0600
@@ -9,6 +9,22 @@
 import com.aurellem.capture.IsoTimer;
 import com.jme3.app.Application;
 
+/** Recording Video from your Application is simple.  If all you
+ *  want to do is record Video, then follow the following steps.
+ * 
+ *  1.) Set the Application's timer to an IsoTimer.  The framerate of
+ *  the IsoTimer will determine the framerate of the resulting video.
+ * 
+ *
+ * 
+ *  2.) Call Capture.captureVideo(yourApplication, target-file) before
+ *  calling yourApplication.start()
+ *  
+ *  That's it!  If you have any comments/problems, please PM me on the
+ *  jMonkeyEngine forms.  My username is bortreb.
+ * 
+ * @author Robert McIntyre
+ */
 public class HelloVideoRecording {
 
 	public static void main(String[] ignore) throws IOException {