OpenShot Library | libopenshot 0.2.7
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
38namespace openshot
39{
40 class Clip;
41 /**
42 * @brief This class returns a listing of all effects supported by libopenshot
43 *
44 * Use this class to return a listing of all supported effects, and their
45 * descriptions.
46 */
48 {
49 public:
50 /// Create an instance of an effect (factory style)
51 EffectBase* CreateEffect(std::string effect_type);
52
53 // JSON methods
54 static std::string Json(); ///< Generate JSON string of this object
55 static Json::Value JsonValue(); ///< Generate Json::Value for this object
56
57 };
58
59}
60
61#endif
This header includes all commonly used effects for libopenshot, for ease-of-use.
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:71
This class returns a listing of all effects supported by libopenshot.
Definition: EffectInfo.h:48
static Json::Value JsonValue()
Generate Json::Value for this object.
Definition: EffectInfo.cpp:133
static std::string Json()
Generate JSON string of this object.
Definition: EffectInfo.cpp:37
EffectBase * CreateEffect(std::string effect_type)
Create an instance of an effect (factory style)
Definition: EffectInfo.cpp:44
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:47