OpenShot Library | libopenshot
0.1.9
|
This class uses the ImageMagick++ libraries, to create frames with "Text", and return openshot::Frame objects. More...
#include <TextReader.h>
Public Member Functions | |
void | Close () |
Close Reader. More... | |
CacheMemory * | GetCache () |
Get the cache object used by this reader (always returns NULL for this object) More... | |
std::shared_ptr< Frame > | GetFrame (int64_t requested_frame) |
bool | IsOpen () |
Determine if reader is open or closed. More... | |
string | Json () |
Get and Set JSON methods. More... | |
Json::Value | JsonValue () |
Generate Json::JsonValue for this object. More... | |
string | Name () |
Return the type name of the class. More... | |
void | Open () |
Open Reader - which is called by the constructor automatically. More... | |
void | SetJson (string value) |
Load JSON string into this object. More... | |
void | SetJsonValue (Json::Value root) |
Load Json::JsonValue into this object. More... | |
TextReader () | |
Default constructor (blank text) More... | |
TextReader (int width, int height, int x_offset, int y_offset, GravityType gravity, string text, string font, double size, string text_color, string background_color) | |
Constructor for TextReader with all parameters. More... | |
![]() | |
void | DisplayInfo () |
Display file information in the standard output stream (stdout) More... | |
ReaderBase () | |
Constructor for the base reader, where many things are initialized. More... | |
void | SetMaxSize (int width, int height) |
Set Max Image Size (used for performance optimization) More... | |
Additional Inherited Members | |
![]() | |
ReaderInfo | info |
Information about the current media file. More... | |
![]() | |
CriticalSection | getFrameCriticalSection |
Section lock for multiple threads. 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... | |
CriticalSection | processingCriticalSection |
This class uses the ImageMagick++ libraries, to create frames with "Text", and return openshot::Frame objects.
All system fonts are supported, including many different font properties, such as size, color, alignment, padding, etc...
Definition at line 81 of file TextReader.h.
TextReader::TextReader | ( | ) |
Default constructor (blank text)
Definition at line 33 of file TextReader.cpp.
TextReader::TextReader | ( | int | width, |
int | height, | ||
int | x_offset, | ||
int | y_offset, | ||
GravityType | gravity, | ||
string | text, | ||
string | font, | ||
double | size, | ||
string | text_color, | ||
string | background_color | ||
) |
Constructor for TextReader with all parameters.
width | The width of the requested openshot::Frame (not the size of the text) |
height | The height of the requested openshot::Frame (not the size of the text) |
x_offset | The number of pixels to offset the text on the X axis (horizontal) |
y_offset | The number of pixels to offset the text on the Y axis (vertical) |
gravity | The alignment / gravity of the text |
text | The text you want to generate / display |
font | The font of the text |
size | The size of the text |
text_color | The color of the text |
background_color | The background color of the text (also supports Transparent) |
Definition at line 40 of file TextReader.cpp.
|
virtual |
|
inlinevirtual |
Get the cache object used by this reader (always returns NULL for this object)
Implements openshot::ReaderBase.
Definition at line 120 of file TextReader.h.
|
virtual |
Get an openshot::Frame object for a specific frame number of this reader. All numbers return the same Frame, since they all share the same image data.
requested_frame | The frame number that is requested. |
Implements openshot::ReaderBase.
Definition at line 146 of file TextReader.cpp.
|
inlinevirtual |
Determine if reader is open or closed.
Implements openshot::ReaderBase.
Definition at line 130 of file TextReader.h.
|
virtual |
Get and Set JSON methods.
Generate JSON string of this object
Implements openshot::ReaderBase.
Definition at line 172 of file TextReader.cpp.
|
virtual |
Generate Json::JsonValue for this object.
Implements openshot::ReaderBase.
Definition at line 179 of file TextReader.cpp.
|
inlinevirtual |
Return the type name of the class.
Implements openshot::ReaderBase.
Definition at line 133 of file TextReader.h.
|
virtual |
Open Reader - which is called by the constructor automatically.
Implements openshot::ReaderBase.
Definition at line 49 of file TextReader.cpp.
|
virtual |
Load JSON string into this object.
Implements openshot::ReaderBase.
Definition at line 200 of file TextReader.cpp.
|
virtual |
Load Json::JsonValue into this object.
Implements openshot::ReaderBase.
Definition at line 223 of file TextReader.cpp.