diff options
Diffstat (limited to 'labb8/lib/StanfordCPPLib/sound.h')
| -rwxr-xr-x | labb8/lib/StanfordCPPLib/sound.h | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/labb8/lib/StanfordCPPLib/sound.h b/labb8/lib/StanfordCPPLib/sound.h new file mode 100755 index 0000000..89e2066 --- /dev/null +++ b/labb8/lib/StanfordCPPLib/sound.h @@ -0,0 +1,63 @@ +/* + * File: sound.h + * ------------- + * This file defines a class that represents a sound. + */ + +#ifndef _sound_h +#define _sound_h + +/* + * Class: Sound + * ------------ + * This class encapsulates a sound file. The sound file is specified in the + * constructor and must be a file in either the current directory or a + * subdirectory named <code>sounds</code>. + * + * <p>The following code, for example, plays the sound file + * <code>ringtone.wav</code>: + * + *<pre> + * Sound ringtone("ringtone.wav"); + * ringtone.play(); + *</pre> + */ + +class Sound { + +public: + +/* + * Constructor: Sound + * Usage: Sound sound; + * Sound sound(filename); + * ----------------------------- + * Creates a <code>Sound</code> object. The default constructor + * creates an empty sound that cannot be played. The second form + * initializes the sound by reading in the contents of the specified + * file. + */ + + Sound(std::string filename); + +/* + * Destructor: ~Sound + * ------------------ + * Frees the memory associated with the sound. + */ + + virtual ~Sound(); + +/* + * Method: play + * Usage: sound.play(); + * -------------------- + * Starts playing the sound. This call returns immediately without waiting + * for the sound to finish. + */ + + void play(); + +}; + +#endif |
