OpenShot Library | libopenshot  0.3.3
Bars.h
Go to the documentation of this file.
1 
9 // Copyright (c) 2008-2019 OpenShot Studios, LLC
10 //
11 // SPDX-License-Identifier: LGPL-3.0-or-later
12 
13 #ifndef OPENSHOT_BARS_EFFECT_H
14 #define OPENSHOT_BARS_EFFECT_H
15 
16 #include "../EffectBase.h"
17 
18 #include "../Color.h"
19 #include "../Frame.h"
20 #include "../Json.h"
21 #include "../KeyFrame.h"
22 
23 #include <string>
24 #include <memory>
25 
26 namespace openshot
27 {
28 
36  class Bars : public EffectBase
37  {
38  private:
40  void init_effect_details();
41 
42 
43  public:
49 
51  Bars();
52 
61 
68  std::shared_ptr<openshot::Frame> GetFrame(int64_t frame_number) override { return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
69 
79  std::shared_ptr<openshot::Frame> GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number) override;
80 
81  // Get and Set JSON methods
82  std::string Json() const override;
83  void SetJson(const std::string value) override;
84  Json::Value JsonValue() const override;
85  void SetJsonValue(const Json::Value root) override;
86 
89  std::string PropertiesJSON(int64_t requested_frame) const override;
90  };
91 
92 }
93 
94 #endif
openshot::Bars::SetJsonValue
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: Bars.cpp:141
openshot::EffectBase
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:53
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:28
openshot::Bars::Json
std::string Json() const override
Generate JSON string of this object.
Definition: Bars.cpp:101
openshot::Bars::left
Keyframe left
Size of left bar.
Definition: Bars.h:45
openshot::Color
This class represents a color (used on the timeline and clips)
Definition: Color.h:27
openshot::Bars::Bars
Bars()
Blank constructor, useful when using Json to load the effect properties.
Definition: Bars.cpp:19
openshot::Bars
This class draws black bars around your video (from any side), and can be animated with openshot::Key...
Definition: Bars.h:36
openshot::Keyframe
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition: KeyFrame.h:53
openshot::Bars::SetJson
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: Bars.cpp:124
openshot::Bars::bottom
Keyframe bottom
Size of bottom bar.
Definition: Bars.h:48
openshot::Bars::right
Keyframe right
Size of right bar.
Definition: Bars.h:47
openshot::Bars::GetFrame
std::shared_ptr< openshot::Frame > GetFrame(int64_t frame_number) override
This method is required for all derived classes of ClipBase, and returns a new openshot::Frame object...
Definition: Bars.h:68
openshot::Bars::color
Color color
Color of bars.
Definition: Bars.h:44
openshot::Bars::PropertiesJSON
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Bars.cpp:160
openshot::Bars::JsonValue
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Bars.cpp:108
openshot::Bars::top
Keyframe top
Size of top bar.
Definition: Bars.h:46