[Gnash-commit] gnash/libmedia sound_handler.h

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Sandro Santilli <strk>  08/05/26 10:19:14

Modified files:
        libmedia       : sound_handler.h 

Log message:
        more dox cleanups/generalization

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/libmedia/sound_handler.h?cvsroot=gnash&r1=1.17&r2=1.18

Patches:
Index: sound_handler.h
===================================================================
RCS file: /sources/gnash/gnash/libmedia/sound_handler.h,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -b -r1.17 -r1.18
--- sound_handler.h     26 May 2008 10:11:57 -0000      1.17
+++ sound_handler.h     26 May 2008 10:19:13 -0000      1.18
@@ -281,12 +281,12 @@
        ///
        virtual SoundInfo* get_sound_info(int sound_handle) = 0;
 
-       /// Schedule playing of a sound source
+       /// Schedule playing of a sound buffer slot
        //
        /// All scheduled sounds will be played on next output flush.
        ///
        /// @param sound_handle
-       ///     The sound_handlers id for the sound to start playing
+       ///     Id of the sound buffer slot schedule playback of.
        ///
        /// @param loop_count
        /// loop_count == 0 means play the sound once (1 means play it twice, 
etc)
@@ -305,11 +305,13 @@
        ///
        virtual void    play_sound(int sound_handle, int loop_count, int 
secondOffset, long start, const std::vector<sound_envelope>* envelopes) = 0;
 
-       /// Remove any scheduled request to play sound 
+       /// Remove all scheduled request for playback of sound buffer slots
        virtual void    stop_all_sounds() = 0;
 
-       /// Gets the volume for a given sound. Only used by the AS Sound class
+       /// Gets the volume for a given sound buffer slot.
        //
+       /// Only used by the AS Sound class
+       ///
        /// @param sound_handle
        ///     The sound_handlers id for the sound to be deleted
        ///
@@ -318,18 +320,21 @@
        ///
        virtual int     get_volume(int sound_handle) = 0;
        
-       /// Sets the volume for a given sound. Only used by the AS Sound class
+       /// Sets the volume for a given sound buffer slot.
        //
+       /// Only used by the AS Sound class
+       ///
        /// @param sound_handle
        ///     The sound_handlers id for the sound to be deleted
        ///
        /// @param volume
        /// A number from 0 to 100 representing a volume level. 
-       /// 100 is full volume and 0 is no volume. The default setting is 100.
+       ///     100 is full volume and 0 is no volume.
+       ///     The default setting is 100.
        ///
        virtual void    set_volume(int sound_handle, int volume) = 0;
                
-       /// Remove any scheduled request to play the specified sound 
+       /// Remove scheduled requests to play the specified sound buffer slot
        //
        /// Stop the specified sound if it's playing.
        /// (Normally a full-featured sound API would take a
@@ -348,7 +353,9 @@
        ///
        virtual void    delete_sound(int sound_handle) = 0;
 
-       /// Discard any sound input and clear scheduling
+       /// \brief
+       /// Discard all sound inputs (slots and aux streamers)
+       /// and clear scheduling
        //
        /// Gnash calls this on movie restart.
        ///