MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
playlist.h
Go to the documentation of this file.
1 // © Copyright 2010 - 2014 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef _audioplaylist_h
41 #define _audioplsylist_h
42 
43 #include "datatypes.h"
44 #include "Resource/datastream.h"
45 
46 /// @file
47 /// @brief The declaration of the Playlist class.
48 
49 namespace Mezzanine
50 {
51  namespace Audio
52  {
53  class iSound;
54  ///////////////////////////////////////////////////////////////////////////////
55  /// @brief This class is a list of sounds with common playlist features.
56  /// @details
57  ///////////////////////////////////////
58  class MEZZ_LIB Playlist : public std::list< Audio::iSound* >
59  {
60  protected:
61  public:
62  /// @brief Class constructor.
63  Playlist();
64  /// @brief Class destructor.
65  ~Playlist();
66 
67  ///////////////////////////////////////////////////////////////////////////////
68  // Utility
69 
70  /// @brief Adds a sound to the playlist.
71  /// @param ToAdd The sound to be added.
72  void AddSound(iSound* ToAdd);
73  /// @brief Randomly shuffles the content in the Playlist.
74  void Shuffle();
75 
76  /// @brief Checks the playlist to see if it contains a sound.
77  /// @param TheSound The sound to check for.
78  bool ContainsSound(iSound* TheSound);
79  };//Playlist
80  }//Audio
81 }//Mezzanine
82 
83 #endif