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