OpenShot Library | libopenshot  0.1.9
EffectInfo.h
Go to the documentation of this file.
1 /**
2  * @file
3  * @brief Header file for the EffectInfo class
4  * @author Jonathan Thomas <jonathan@openshot.org>
5  *
6  * @section LICENSE
7  *
8  * Copyright (c) 2008-2014 OpenShot Studios, LLC
9  * <http://www.openshotstudios.com/>. This file is part of
10  * OpenShot Library (libopenshot), an open-source project dedicated to
11  * delivering high quality video editing and animation solutions to the
12  * world. For more information visit <http://www.openshot.org/>.
13  *
14  * OpenShot Library (libopenshot) is free software: you can redistribute it
15  * and/or modify it under the terms of the GNU Lesser General Public License
16  * as published by the Free Software Foundation, either version 3 of the
17  * License, or (at your option) any later version.
18  *
19  * OpenShot Library (libopenshot) is distributed in the hope that it will be
20  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22  * GNU Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public License
25  * along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
26  */
27 
28 #ifndef OPENSHOT_EFFECT_INFO_H
29 #define OPENSHOT_EFFECT_INFO_H
30 
31 #include "Effects.h"
32 
33 
34 using namespace std;
35 
36 namespace openshot
37 {
38 
39  /**
40  * @brief This class returns a listing of all effects supported by libopenshot
41  *
42  * Use this class to return a listing of all supported effects, and their
43  * descriptions.
44  */
45  class EffectInfo
46  {
47  public:
48  // Create an instance of an effect (factory style)
49  EffectBase* CreateEffect(string effect_type);
50 
51  /// JSON methods
52  static string Json(); ///< Generate JSON string of this object
53  static Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
54 
55  };
56 
57 }
58 
59 #endif
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:66
This header includes all commonly used effects for libopenshot, for ease-of-use.
This namespace is the default namespace for all code in the openshot library.
This class returns a listing of all effects supported by libopenshot.
Definition: EffectInfo.h:45