[cosmetics] update date in GPL header
[vuplus_xbmc] / xbmc / cores / AudioEngine / Interfaces / AESound.h
1 #pragma once
2 /*
3  *      Copyright (C) 2010-2013 Team XBMC
4  *      http://xbmc.org
5  *
6  *  This Program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2, or (at your option)
9  *  any later version.
10  *
11  *  This Program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with XBMC; see the file COPYING.  If not, see
18  *  <http://www.gnu.org/licenses/>.
19  *
20  */
21
22 #include "utils/StdString.h"
23 #include "AE.h"
24
25 class IAESound
26 {
27 protected:
28   friend class IAE;
29   IAESound(const std::string &filename) {}
30   virtual ~IAESound() {}
31
32 public:
33   /* play the sound this object represents */
34   virtual void Play() = 0;
35
36   /* stop playing the sound this object represents */
37   virtual void Stop() = 0;
38
39   /* return true if the sound is currently playing */
40   virtual bool IsPlaying() = 0;
41
42   /* set the playback volume of this sound */
43   virtual void SetVolume(float volume) = 0;
44
45   /* get the current playback volume of this sound */
46   virtual float GetVolume() = 0;
47 };
48