1 /** |
|
2 * Copyright (c) 2010 Sasken Communication Technologies Ltd. |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of the "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html" |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution |
|
11 * |
|
12 * Contributors: |
|
13 * Manasij Roy, Nalina Hariharan |
|
14 * |
|
15 * Description: |
|
16 * Interface specification for music track lyrics |
|
17 * |
|
18 */ |
|
19 |
|
20 |
|
21 #ifndef SMFLYRICSSERVICEPLUGIN_H_ |
|
22 #define SMFLYRICSSERVICEPLUGIN_H_ |
|
23 |
|
24 #include <smfpluginbase.h> |
|
25 #include <smftrackinfo.h> |
|
26 #include <QString> |
|
27 #include <smfsubtitle.h> |
|
28 #include <smflyrics.h> |
|
29 |
|
30 // Forward declaration |
|
31 class SmfPluginUtil; |
|
32 |
|
33 /** |
|
34 * @ingroup smf_plugin_group |
|
35 * Interface specification for music track lyrics |
|
36 * |
|
37 * All of the functionality described here should be implemented by a service |
|
38 * specific plug-in. |
|
39 */ |
|
40 class SmfLyricsServicePlugin : public SmfPluginBase |
|
41 { |
|
42 public: |
|
43 /** |
|
44 * Constructor with default argument |
|
45 * @param aUtil The SmfPluginUtil instance. The plugins can |
|
46 * call the method getAuthKeys() of this class, with its pluginID to |
|
47 * get the OAuth keys, keys are returned only if this plugin is |
|
48 * authorised by Smf franework |
|
49 */ |
|
50 SmfLyricsServicePlugin( SmfPluginUtil* aUtil ); |
|
51 |
|
52 /** |
|
53 * Destructor |
|
54 */ |
|
55 ~SmfLyricsServicePlugin( ); |
|
56 |
|
57 /** |
|
58 * Method to get the lyrics |
|
59 * @param aRequest [out] The request data to be sent to network |
|
60 * @param aTrack The track whose lyrics need to be fetched |
|
61 * @param aPageNum The page to be extracted |
|
62 * @param aItemsPerPage Number of items per page |
|
63 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
|
64 */ |
|
65 virtual SmfPluginError lyrics( SmfPluginRequestData &aRequest, |
|
66 const SmfTrackInfo &aTrack, |
|
67 const int aPageNum = SMF_FIRST_PAGE, |
|
68 const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
|
69 |
|
70 /** |
|
71 * Method to get the subtitle |
|
72 * @param aRequest [out] The request data to be sent to network |
|
73 * @param aTrack The track whose subtitle need to be fetched |
|
74 * @param aFilter The subtitle search filter if any |
|
75 * @param aPageNum The page to be extracted |
|
76 * @param aItemsPerPage Number of items per page |
|
77 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone |
|
78 */ |
|
79 virtual SmfPluginError subtitles( SmfPluginRequestData &aRequest, |
|
80 const SmfTrackInfo &aTrack, |
|
81 const SmfSubtitleSearchFilter &aFilter = SubtitleAll, |
|
82 const int aPageNum = SMF_FIRST_PAGE, |
|
83 const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
|
84 |
|
85 }; |
|
86 |
|
87 Q_DECLARE_INTERFACE( SmfLyricsServicePlugin, "org.symbian.smf.plugin.music.lyrics/v1.0" ); |
|
88 |
|
89 #endif /* SMFLYRICSSERVICEPLUGIN_H_ */ |
|