[Scummvm-cvs-logs] SF.net SVN: scummvm: [25742] scummvm/trunk/sound/audiocd.h

fingolfin at users.sourceforge.net fingolfin at users.sourceforge.net
Tue Feb 20 17:13:46 CET 2007


Revision: 25742
          http://scummvm.svn.sourceforge.net/scummvm/?rev=25742&view=rev
Author:   fingolfin
Date:     2007-02-20 08:13:45 -0800 (Tue, 20 Feb 2007)

Log Message:
-----------
Document AudioCDManager::play

Modified Paths:
--------------
    scummvm/trunk/sound/audiocd.h

Modified: scummvm/trunk/sound/audiocd.h
===================================================================
--- scummvm/trunk/sound/audiocd.h	2007-02-20 15:54:29 UTC (rev 25741)
+++ scummvm/trunk/sound/audiocd.h	2007-02-20 16:13:45 UTC (rev 25742)
@@ -51,6 +51,16 @@
 		int numLoops;
 	};
 
+	/**
+	 * Start playback of the specified "CD" track. This method mimics
+	 * the interface of OSystem::playCD (which it in fact may call, if an Audio CD is
+	 * present), but also can play digital audio tracks in various formats.
+	 *
+	 * @param track			the track to play.
+	 * @param num_loops		how often playback should be repeated (-1 = infinitely often).
+	 * @param start_frame	the frame at which playback should start (75 frames = 1 second).
+	 * @param duration		the number of frames to play (0: play until end)
+	 */
 	void play(int track, int numLoops, int startFrame, int duration);
 	void stop();
 	bool isPlaying() const;


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




More information about the Scummvm-git-logs mailing list