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 class SoundActor : public Actor, public ChannelClient, public SoundClient {
34 public:
35  SoundActor() : Actor(kActorTypeSound), _sequence(this) {};
36  ~SoundActor();
37 
38  virtual void readParameter(Chunk &chunk, ActorHeaderSectionType paramType) override;
39  virtual ScriptValue callMethod(BuiltInMethod methodId, Common::Array<ScriptValue> &args) override;
40  virtual void readChunk(Chunk &chunk) override;
41 
42  virtual void onEvent(const ActorEvent &event) override;
43  virtual void timerEvent(const TimerEvent &event) override;
44  virtual void soundPlayStateChanged(SoundPlayState state, SoundStopReason why) override;
45 
46 private:
47  ImtStreamFeed *_streamFeed = nullptr;
48  bool _isLoadedFromChunk = false;
49  bool _discardAfterUse = false;
50  SoundPlayState _playState = kSoundPlayStateStopped;
51  AudioSequence _sequence;
52 
53  void start();
54  void stop();
55  void pause();
56  void resume(bool restart);
57 
58  void openStream();
59 };
60 
61 } // End of namespace MediaStation
62 
63 #endif
Definition: actor.h:34
Definition: audio.h:50
Definition: datafile.h:196
Definition: datafile.h:99
Definition: datafile.h:160
Definition: events.h:103
Definition: events.h:94
Definition: sound.h:33
Definition: audio.h:56
Definition: actor.h:205
Definition: scriptvalue.h:35