OpenShot Library | libopenshot  0.3.2
Public Attributes | List of all members
openshot::EffectInfoStruct Struct Reference

This struct contains info about an effect, such as the name, video or audio effect, etc... More...

#include <EffectBase.h>

Public Attributes

bool apply_before_clip
 Apply effect before we evaluate the clip's keyframes. More...
 
std::string class_name
 The class name of the effect. More...
 
std::string description
 The description of this effect and what it does. More...
 
bool has_audio
 Determines if this effect manipulates the audio of a frame. More...
 
bool has_tracked_object
 Determines if this effect track objects through the clip. More...
 
bool has_video
 Determines if this effect manipulates the image of a frame. More...
 
std::string name
 The name of the effect. More...
 
std::string parent_effect_id
 Id of the parent effect (if there is one) More...
 

Detailed Description

This struct contains info about an effect, such as the name, video or audio effect, etc...

Each derived class of EffectBase is responsible for updating this struct to reflect accurate information about the underlying effect. Derived classes of EffectBase should call the InitEffectInfo() method to initialize the default values of this struct.

Definition at line 34 of file EffectBase.h.

Member Data Documentation

◆ apply_before_clip

bool openshot::EffectInfoStruct::apply_before_clip

◆ class_name

std::string openshot::EffectInfoStruct::class_name

◆ description

std::string openshot::EffectInfoStruct::description

◆ has_audio

bool openshot::EffectInfoStruct::has_audio

Determines if this effect manipulates the audio of a frame.

Definition at line 41 of file EffectBase.h.

Referenced by openshot::EffectBase::DisplayInfo(), openshot::EffectBase::InitEffectInfo(), openshot::EffectBase::JsonInfo(), openshot::EffectBase::JsonValue(), and openshot::Negate::Negate().

◆ has_tracked_object

bool openshot::EffectInfoStruct::has_tracked_object

Determines if this effect track objects through the clip.

Definition at line 42 of file EffectBase.h.

Referenced by openshot::Clip::AddEffect(), openshot::EffectBase::InitEffectInfo(), and openshot::EffectBase::JsonValue().

◆ has_video

bool openshot::EffectInfoStruct::has_video

Determines if this effect manipulates the image of a frame.

Definition at line 40 of file EffectBase.h.

Referenced by openshot::EffectBase::DisplayInfo(), openshot::EffectBase::InitEffectInfo(), openshot::EffectBase::JsonInfo(), openshot::EffectBase::JsonValue(), and openshot::Negate::Negate().

◆ name

std::string openshot::EffectInfoStruct::name

◆ parent_effect_id

std::string openshot::EffectInfoStruct::parent_effect_id

The documentation for this struct was generated from the following file: