OpenShot Library | libopenshot  0.1.9
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

string class_name
 The class name of the effect. More...
 
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_video
 Determines if this effect manipulates the image of a frame. More...
 
string name
 The name of the effect. More...
 
string short_name
 A short name of the effect, commonly used for icon names, etc... 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 49 of file EffectBase.h.

Member Data Documentation

◆ class_name

string openshot::EffectInfoStruct::class_name

The class name of the effect.

Definition at line 51 of file EffectBase.h.

◆ description

string openshot::EffectInfoStruct::description

The description of this effect and what it does.

Definition at line 54 of file EffectBase.h.

◆ has_audio

bool openshot::EffectInfoStruct::has_audio

Determines if this effect manipulates the audio of a frame.

Definition at line 56 of file EffectBase.h.

◆ has_video

bool openshot::EffectInfoStruct::has_video

Determines if this effect manipulates the image of a frame.

Definition at line 55 of file EffectBase.h.

◆ name

string openshot::EffectInfoStruct::name

The name of the effect.

Definition at line 53 of file EffectBase.h.

◆ short_name

string openshot::EffectInfoStruct::short_name

A short name of the effect, commonly used for icon names, etc...

Definition at line 52 of file EffectBase.h.


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