MaeLyrica/How to write plugins
(→How to write a plugin for MaeLyrica?: info about toProviderCode) |
(added parse() doc) |
||
| Line 1: | Line 1: | ||
== How to write a plugin for MaeLyrica? == | == How to write a plugin for MaeLyrica? == | ||
| + | === What is a MaeLyrica plugin? === | ||
| + | A MaeLyrica plug-in is a class inheriting a lyricsDownloader class | ||
| + | |||
=== Which data should be provided? === | === Which data should be provided? === | ||
A MaeLyrica plug-in is just a class containing these functions and variables: | A MaeLyrica plug-in is just a class containing these functions and variables: | ||
| Line 13: | Line 16: | ||
The toProviderCode function should return the URL as std::string, from which data should be downloaded. The default download function will follow any redirects. | The toProviderCode function should return the URL as std::string, from which data should be downloaded. The default download function will follow any redirects. | ||
| + | |||
| + | The parse function should save the plain text lyrics to variable | ||
| + | QString lyrics_qstr; | ||
| + | which is a member of lyricsDownloader | ||
| + | |||
| + | The non-parsed text downloaded by the default download function is available in a variable, a member of lyricsDownloader | ||
| + | std::ostringstream buff | ||
Revision as of 13:03, 19 August 2012
Contents |
How to write a plugin for MaeLyrica?
What is a MaeLyrica plugin?
A MaeLyrica plug-in is a class inheriting a lyricsDownloader class
Which data should be provided?
A MaeLyrica plug-in is just a class containing these functions and variables:
virtual std::string toProviderCode(string artist, string track) const; virtual bool parse();
The following function can be provided too:
virtual short perform(string a, string t); virtual CURLcode download(string a, string t);
Requirements for functions
The toProviderCode function should return the URL as std::string, from which data should be downloaded. The default download function will follow any redirects.
The parse function should save the plain text lyrics to variable
QString lyrics_qstr;
which is a member of lyricsDownloader
The non-parsed text downloaded by the default download function is available in a variable, a member of lyricsDownloader
std::ostringstream buff