Update of /cvsroot/audacity/audacity-src/src
In directory 23jxhf1.ch3.sourceforge.com:/tmp/cvs-serv31858/src

Modified Files:
        AudioIO.h 
Log Message:
Correct documentation errors


Index: AudioIO.h
===================================================================
RCS file: /cvsroot/audacity/audacity-src/src/AudioIO.h,v
retrieving revision 1.68
retrieving revision 1.69
diff -u -d -r1.68 -r1.69
--- AudioIO.h   6 Apr 2009 23:21:44 -0000       1.68
+++ AudioIO.h   23 May 2009 14:51:22 -0000      1.69
@@ -155,7 +155,7 @@
     * soundcard mixer (driven by PortMixer) */
    wxArrayString GetInputSourceNames();
 
-   /** \Brief update state after changing what audio devices are selected 
+   /** \brief update state after changing what audio devices are selected 
     *
     * Called when the devices stored in the preferences are changed to update
     * the audio mixer capabilities
@@ -436,11 +436,19 @@
     * with the two buffers needs some care to ensure that the right things
     * happen for all possible cases.
     * @param inputBuffer Buffer of length framesPerBuffer containing samples
-    * from the sound card, or null if not capturing audio.
+    * from the sound card, or null if not capturing audio. Note that the data
+    * type will depend on the format of audio data that was chosen when the
+    * stream was created (so could be floats or various integers)
     * @param outputBuffer Uninitialised buffer of length framesPerBuffer which
     * will be sent to the sound card after the callback, or null if not playing
     * audio back.
     * @param framesPerBuffer The length of the playback and recording buffers
+    * @param PaStreamCallbackTimeInfo Pointer to PortAudio time information
+    * structure, which tells us how long we have been playing / recording
+    * @param statusFlags PortAudio stream status flags
+    * @param userData pointer to user-defined data structure. Provided for
+    * flexibility by PortAudio, but not used by Audacity - the data is stored 
in
+    * the AudioIO class instead.
     */
    friend int audacityAudioCallback(
                 const void *inputBuffer, void *outputBuffer,


------------------------------------------------------------------------------
Register Now for Creativity and Technology (CaT), June 3rd, NYC. CaT
is a gathering of tech-side developers & brand creativity professionals. Meet
the minds behind Google Creative Lab, Visual Complexity, Processing, & 
iPhoneDevCamp asthey present alongside digital heavyweights like Barbarian
Group, R/GA, & Big Spaceship. http://www.creativitycat.com 
_______________________________________________
Audacity-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/audacity-cvs

Reply via email to