1 |
/* |
2 |
Copyright (C) 2010 Christian Schoenebeck |
3 |
*/ |
4 |
|
5 |
#ifndef _EFFECT_INFO_H_ |
6 |
#define _EFFECT_INFO_H_ |
7 |
|
8 |
namespace LinuxSampler { |
9 |
|
10 |
/** |
11 |
* General informations about a specific effect. At the moment it is mainly |
12 |
* used as unique identifier of a certain effect. In future it might also show |
13 |
* further informations like amount of input / output channels, copyright |
14 |
* informations etc. |
15 |
* |
16 |
* This abstract base class is implemented by the respective internal effect |
17 |
* system. |
18 |
* |
19 |
* @see EffectFactory::GetEffectInfo() |
20 |
*/ |
21 |
class EffectInfo { |
22 |
public: |
23 |
/** |
24 |
* The underlying effect system the effect is based on, e.g. "LADSPA". |
25 |
*/ |
26 |
virtual String EffectSystem() = 0; |
27 |
|
28 |
/** |
29 |
* Unique name of the effect within its module (plugin DLL). |
30 |
*/ |
31 |
virtual String Name() = 0; |
32 |
|
33 |
/** |
34 |
* Name of the module (usually the DLL file name) that contains the effect. |
35 |
*/ |
36 |
virtual String Module() = 0; |
37 |
|
38 |
/** |
39 |
* Human readable name or description of the effect (not necessarily |
40 |
* unique). |
41 |
*/ |
42 |
virtual String Description() = 0; |
43 |
|
44 |
virtual ~EffectInfo() { } |
45 |
}; |
46 |
|
47 |
} // namespace LinuxSampler |
48 |
|
49 |
#endif // _EFFECT_INFO_H_ |