OpenShot Library | libopenshot
0.1.9
|
This abstract class is the base class, used by all clips in libopenshot. More...
#include <ClipBase.h>
Public Member Functions | |
ClipBase () | |
Constructor for the base clip. More... | |
float | Duration () |
Get the length of this clip (in seconds) More... | |
float | End () |
Get end position (in seconds) of clip (trim end of video) More... | |
void | End (float value) |
Set end position (in seconds) of clip (trim end of video) More... | |
string | Id () |
Get basic properties. More... | |
void | Id (string value) |
Set basic properties. More... | |
virtual string | Json ()=0 |
Get and Set JSON methods. More... | |
virtual Json::Value | JsonValue ()=0 |
Generate Json::JsonValue for this object. More... | |
int | Layer () |
Get layer of clip on timeline (lower number is covered by higher numbers) More... | |
void | Layer (int value) |
Set layer of clip on timeline (lower number is covered by higher numbers) More... | |
bool | operator< (ClipBase &a) |
bool | operator<= (ClipBase &a) |
bool | operator> (ClipBase &a) |
bool | operator>= (ClipBase &a) |
float | Position () |
Get position on timeline (in seconds) More... | |
void | Position (float value) |
More... | |
virtual string | PropertiesJSON (int64_t requested_frame)=0 |
virtual void | SetJson (string value)=0 |
Load JSON string into this object. More... | |
virtual void | SetJsonValue (Json::Value root)=0 |
Load Json::JsonValue into this object. More... | |
void | SetMaxSize (int width, int height) |
Set Max Image Size (used for performance optimization) More... | |
float | Start () |
Get start position (in seconds) of clip (trim start of video) More... | |
void | Start (float value) |
Set start position (in seconds) of clip (trim start of video) More... | |
Protected Member Functions | |
Json::Value | add_property_choice_json (string name, int value, int selected_value) |
Generate JSON choice for a property (dropdown properties) More... | |
Json::Value | add_property_json (string name, float value, string type, string memo, Keyframe *keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame) |
Generate JSON for a property. More... | |
Protected Attributes | |
float | end |
The position in seconds to end playing (used to trim the ending of a clip) More... | |
string | id |
ID Property for all derived Clip and Effect classes. More... | |
int | layer |
The layer this clip is on. Lower clips are covered up by higher clips. More... | |
int | max_height |
The maximium image height needed by this clip (used for optimizations) More... | |
int | max_width |
The maximum image width needed by this clip (used for optimizations) More... | |
float | position |
The position on the timeline where this clip should start playing. More... | |
string | previous_properties |
This string contains the previous JSON properties. More... | |
float | start |
The position in seconds to start playing (used to trim the beginning of a clip) More... | |
This abstract class is the base class, used by all clips in libopenshot.
Clips are objects that attach to the timeline and can be layered and positioned together. There are 2 primary types of clips: Effects and Video/Audio Clips.
Definition at line 53 of file ClipBase.h.
|
inline |
Constructor for the base clip.
Definition at line 73 of file ClipBase.h.
|
protected |
Generate JSON choice for a property (dropdown properties)
Definition at line 101 of file ClipBase.cpp.
|
protected |
Generate JSON for a property.
Definition at line 65 of file ClipBase.cpp.
|
inline |
Get the length of this clip (in seconds)
Definition at line 87 of file ClipBase.h.
|
inline |
Get end position (in seconds) of clip (trim end of video)
Definition at line 86 of file ClipBase.h.
|
inline |
Set end position (in seconds) of clip (trim end of video)
Definition at line 94 of file ClipBase.h.
|
inline |
|
inline |
Set basic properties.
Definition at line 90 of file ClipBase.h.
|
pure virtual |
Get and Set JSON methods.
Generate JSON string of this object
Implemented in openshot::Clip, openshot::Mask, openshot::Blur, openshot::EffectBase, openshot::Brightness, openshot::Saturation, openshot::ChromaKey, openshot::Deinterlace, and openshot::Negate.
|
pure virtual |
Generate Json::JsonValue for this object.
Implemented in openshot::Clip, openshot::Mask, openshot::Blur, openshot::EffectBase, openshot::Brightness, openshot::Saturation, openshot::ChromaKey, openshot::Deinterlace, and openshot::Negate.
Definition at line 33 of file ClipBase.cpp.
|
inline |
Get layer of clip on timeline (lower number is covered by higher numbers)
Definition at line 84 of file ClipBase.h.
|
inline |
Set layer of clip on timeline (lower number is covered by higher numbers)
Definition at line 92 of file ClipBase.h.
|
inline |
Definition at line 76 of file ClipBase.h.
|
inline |
Definition at line 77 of file ClipBase.h.
|
inline |
Definition at line 78 of file ClipBase.h.
|
inline |
Definition at line 79 of file ClipBase.h.
|
inline |
Get position on timeline (in seconds)
Definition at line 83 of file ClipBase.h.
|
inline |
Set the Id of this clip object
Set position on timeline (in seconds)
Definition at line 91 of file ClipBase.h.
|
pure virtual |
Get all properties for a specific frame (perfect for a UI to display the current state of all properties at any time)
Implemented in openshot::Clip, openshot::Mask, openshot::Blur, openshot::Brightness, openshot::Saturation, openshot::ChromaKey, openshot::Deinterlace, and openshot::Negate.
|
pure virtual |
Load JSON string into this object.
Implemented in openshot::Clip, openshot::Mask, openshot::Blur, openshot::EffectBase, openshot::Brightness, openshot::Saturation, openshot::ChromaKey, openshot::Deinterlace, and openshot::Negate.
|
pure virtual |
Load Json::JsonValue into this object.
Implemented in openshot::Clip, openshot::Mask, openshot::Blur, openshot::EffectBase, openshot::Brightness, openshot::Saturation, openshot::ChromaKey, openshot::Deinterlace, and openshot::Negate.
Definition at line 49 of file ClipBase.cpp.
|
inline |
Set Max Image Size (used for performance optimization)
Definition at line 97 of file ClipBase.h.
|
inline |
Get start position (in seconds) of clip (trim start of video)
Definition at line 85 of file ClipBase.h.
|
inline |
Set start position (in seconds) of clip (trim start of video)
Definition at line 93 of file ClipBase.h.
|
protected |
The position in seconds to end playing (used to trim the ending of a clip)
Definition at line 59 of file ClipBase.h.
|
protected |
ID Property for all derived Clip and Effect classes.
Definition at line 55 of file ClipBase.h.
|
protected |
The layer this clip is on. Lower clips are covered up by higher clips.
Definition at line 57 of file ClipBase.h.
|
protected |
The maximium image height needed by this clip (used for optimizations)
Definition at line 62 of file ClipBase.h.
|
protected |
The maximum image width needed by this clip (used for optimizations)
Definition at line 61 of file ClipBase.h.
|
protected |
The position on the timeline where this clip should start playing.
Definition at line 56 of file ClipBase.h.
|
protected |
This string contains the previous JSON properties.
Definition at line 60 of file ClipBase.h.
|
protected |
The position in seconds to start playing (used to trim the beginning of a clip)
Definition at line 58 of file ClipBase.h.