gemrb/core/MusicMgr.h

   1 /* GemRB - Infinity Engine Emulator
   2  * Copyright (C) 2003 The GemRB Project
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8
   9  * This program 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 this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  *
  19  */
  20
  21 #ifndef MUSICMGR_H
  22 #define MUSICMGR_H
  23
  24 #include "Plugin.h"
  25
  26 class GEM_EXPORT MusicMgr : public Plugin {
  27 public:
  28         MusicMgr();
  29         virtual ~MusicMgr();
  30         /** Ends the Current PlayList Execution */
  31         virtual void End(void) = 0;
  32         virtual void HardEnd(void) = 0;
  33         /** Start the PlayList Music Execution */
  34         virtual void Start(void) = 0;
  35         /** Initializes the PlayList Manager */
  36         virtual bool Init();
  37         /** Loads a PlayList for playing */
  38         virtual bool OpenPlaylist(const char* name) = 0;
  39         /** Switches the current PlayList while playing the current one, return nonzero on error */
  40         virtual int SwitchPlayList(const char* name, bool Hard) = 0;
  41         /** Plays the Next Entry */
  42         virtual void PlayNext() = 0;
  43         /** Returns whether music is currently playing */
  44         virtual bool IsPlaying() = 0;
  45         /** Returns whether given playlist is currently loaded */
  46         virtual bool CurrentPlayList(const char* name) = 0;
  47 };
  48
  49 #endif