ScummVM API documentation
SoundData.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 /*
23  * Copyright (C) 2006-2010 - Frictional Games
24  *
25  * This file is part of HPL1 Engine.
26  */
27 
28 #ifndef HPL_SOUND_DATA_H
29 #define HPL_SOUND_DATA_H
30 
31 #include "hpl1/engine/resources/ResourceBase.h"
32 #include "hpl1/engine/system/SystemTypes.h"
33 
34 namespace hpl {
35 
36 class cSoundManager;
37 class iSoundChannel;
38 
39 class iSoundData : public iResourceBase {
40 public:
41  iSoundData(tString asName, bool abStream) : iResourceBase(asName, 0),
42  mpSoundManger(NULL), mbStream(abStream) {}
43 
44  virtual ~iSoundData() {}
45 
46  virtual bool CreateFromFile(const tString &asFile) = 0;
47 
48  virtual iSoundChannel *CreateChannel(int alPriority) = 0;
49 
50  bool IsStream() { return mbStream; }
51  void SetLoopStream(bool abX) { mbLoopStream = abX; }
52  bool GetLoopStream() { return mbLoopStream; }
53 
54  bool reload() { return false; }
55  void unload() {}
56  void destroy() {}
57 
58  void SetSoundManager(cSoundManager *apSoundManager) {
59  mpSoundManger = apSoundManager;
60  }
61 
62 protected:
63  bool mbStream;
64  bool mbLoopStream;
65  cSoundManager *mpSoundManger;
66 };
67 
68 } // namespace hpl
69 
70 #endif // HPL_SOUND_DATA_H
Definition: AI.h:36
Definition: str.h:59
Definition: ResourceBase.h:36
Definition: SoundManager.h:39
Definition: SoundData.h:39
Definition: SoundChannel.h:46
void unload()
Definition: SoundData.h:55
bool reload()
Definition: SoundData.h:54
void destroy()
Definition: SoundData.h:56