ScummVM API documentation
sound.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 #ifndef MEDIASTATION_ACTORS_SOUND_H
23 #define MEDIASTATION_ACTORS_SOUND_H
24 
25 #include "mediastation/actor.h"
26 #include "mediastation/audio.h"
27 #include "mediastation/datafile.h"
28 #include "mediastation/mediascript/scriptvalue.h"
29 #include "mediastation/mediascript/scriptconstants.h"
30 
31 namespace MediaStation {
32 
33 enum SoundPlayState {
34  kSoundStopped = 1,
35  kSoundPlaying = 2,
36  kSoundPaused = 3,
37 };
38 
39 class SoundActor : public Actor, public ChannelClient {
40 public:
41  SoundActor() : Actor(kActorTypeSound) {};
42  ~SoundActor();
43 
44  virtual void readParameter(Chunk &chunk, ActorHeaderSectionType paramType) override;
45  virtual ScriptValue callMethod(BuiltInMethod methodId, Common::Array<ScriptValue> &args) override;
46  virtual void process() override;
47 
48  virtual void readChunk(Chunk &chunk) override;
49 
50 private:
51  ImtStreamFeed *_streamFeed = nullptr;
52  bool _isLoadedFromChunk = false;
53  bool _discardAfterUse = false;
54  SoundPlayState _playState = kSoundStopped;
55  AudioSequence _sequence;
56 
57  void start();
58  void stop();
59  void pause();
60  void resume(bool restart);
61 
62  void openStream();
63 };
64 
65 } // End of namespace MediaStation
66 
67 #endif
Definition: actor.h:33
Definition: datafile.h:199
Definition: datafile.h:102
Definition: datafile.h:163
Definition: sound.h:39
Definition: audio.h:33
Definition: actor.h:187
Definition: scriptvalue.h:35