hx3d  1
2D/3D Simple Game Framework
effect.hpp
1 /*
2  Audio effect.
3  Copyright (C) 2015 Denis BOURGE
4 
5  This library is free software; you can redistribute it and/or
6  modify it under the terms of the GNU Lesser General Public
7  License as published by the Free Software Foundation; either
8  version 2.1 of the License, or (at your option) any later version.
9 
10  This library is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public
16  License along with this library; if not, write to the Free Software
17  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
18  USA
19 */
20 
21 #ifndef HX3D_AUDIO_EFFECT
22 #define HX3D_AUDIO_EFFECT
23 
24 namespace hx3d {
25 namespace audio {
26 
32 class Effect {
33 public:
34  Effect();
35  virtual ~Effect();
36 
46  virtual void onFunction(const int channel, const void* stream, const int length);
47 
55  virtual void onDone(const int channel);
56 
62  int getChannel();
63 
69  void* getStream();
70 
76  int getSampleSize();
77 
81  bool hasProcessed();
82 
83 protected:
84 
86  bool _processed;
87 
89  int _channel;
90 
92  void* _stream;
93 
95  int _length;
96 };
97 
98 } /* audio */
99 } /* hx3d */
100 
101 #endif
void * getStream()
Get the audio stream.
Definition: effect.cpp:35
int _channel
Audio channel.
Definition: effect.hpp:89
bool _processed
Has the effect started ?
Definition: effect.hpp:86
hx3d framework namespace
Definition: audio.hpp:26
Audio effect manipulation.
Definition: effect.hpp:32
int getSampleSize()
Get the sample size.
Definition: effect.cpp:38
void * _stream
Sound stream.
Definition: effect.hpp:92
int getChannel()
Get the audio channel related to the effect.
Definition: effect.cpp:32
virtual void onFunction(const int channel, const void *stream, const int length)
Audio effect function.
Definition: effect.cpp:29
int _length
Sound length.
Definition: effect.hpp:95
virtual void onDone(const int channel)
Audio effect done function.
Definition: effect.cpp:30
bool hasProcessed()
Test if the effect has started.
Definition: effect.cpp:41