LeechCraft
0.6.70-13729-g7046a9d2a7
Modular cross-platform feature rich live environment.
ilyricsfinder.h
Go to the documentation of this file.
1
/**********************************************************************
2
* LeechCraft - modular cross-platform feature rich internet client.
3
* Copyright (C) 2006-2014 Georg Rudoy
4
*
5
* Boost Software License - Version 1.0 - August 17th, 2003
6
*
7
* Permission is hereby granted, free of charge, to any person or organization
8
* obtaining a copy of the software and accompanying documentation covered by
9
* this license (the "Software") to use, reproduce, display, distribute,
10
* execute, and transmit the Software, and to prepare derivative works of the
11
* Software, and to permit third-parties to whom the Software is furnished to
12
* do so, all subject to the following:
13
*
14
* The copyright notices in the Software and this entire statement, including
15
* the above license grant, this restriction and the following disclaimer,
16
* must be included in all copies of the Software, in whole or in part, and
17
* all derivative works of the Software, unless such copies or derivative
18
* works are solely in the form of machine-executable object code generated by
19
* a source language processor.
20
*
21
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23
* FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24
* SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25
* FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27
* DEALINGS IN THE SOFTWARE.
28
**********************************************************************/
29
30
#pragma once
31
32
#include <boost/optional.hpp>
33
#include <QStringList>
34
#include <
util/sll/eitherfwd.h
>
35
36
template
<
typename
>
37
class
QFuture
;
38
39
namespace
Media
40
{
45
struct
LyricsQuery
46
{
49
QString
Artist_
;
50
53
QString
Album_
;
54
57
QString
Title_
;
58
61
boost::optional<int>
Year_
;
62
65
boost::optional<int>
Track_
;
66
};
67
75
struct
LyricsResultItem
76
{
79
QString
ProviderName_
;
80
83
QString
Lyrics_
;
84
};
85
90
using
LyricsResults
=
QList<LyricsResultItem>
;
91
97
class
Q_DECL_EXPORT
ILyricsFinder
98
{
99
public
:
100
virtual
~ILyricsFinder
() {}
101
109
using
LyricsQueryResult_t
=
LC::Util::Either<QString, LyricsResults>
;
110
119
virtual
QFuture<LyricsQueryResult_t>
RequestLyrics (
const
LyricsQuery
& query) = 0;
120
};
121
}
122
123
Q_DECLARE_INTERFACE (
Media::ILyricsFinder
,
"org.LeechCraft.Media.ILyricsFinder/1.0"
)
Media::LyricsResultItem::ProviderName_
QString ProviderName_
The name of the provider lyrics were fetched from.
Definition:
ilyricsfinder.h:79
Media::LyricsQuery::Album_
QString Album_
The album this track is on.
Definition:
ilyricsfinder.h:53
Media::LyricsQuery::Title_
QString Title_
The title of the track.
Definition:
ilyricsfinder.h:57
Media::LyricsQuery::Year_
boost::optional< int > Year_
The year of the album the track is on.
Definition:
ilyricsfinder.h:61
Media::LyricsQuery
Describes a lyrics search request.
Definition:
ilyricsfinder.h:45
Media::ILyricsFinder
Interface for plugins supporting finding lyrics.
Definition:
ilyricsfinder.h:97
Media
Definition:
audiostructs.h:37
eitherfwd.h
QFuture
Definition:
idownload.h:39
Media::ILyricsFinder::~ILyricsFinder
virtual ~ILyricsFinder()
Definition:
ilyricsfinder.h:100
Media::LyricsQuery::Track_
boost::optional< int > Track_
The track number.
Definition:
ilyricsfinder.h:65
QList
Definition:
ianrulesstorage.h:35
LC::Util::Either
Definition:
either.h:45
Media::LyricsResultItem
Describes a single lyrics result item.
Definition:
ilyricsfinder.h:75
Media::LyricsResultItem::Lyrics_
QString Lyrics_
The HTML-formatted lyrics string.
Definition:
ilyricsfinder.h:83
Media::LyricsQuery::Artist_
QString Artist_
The artist preforming the track.
Definition:
ilyricsfinder.h:49
src
interfaces
media
ilyricsfinder.h
Generated by
1.8.14