18
|
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 |
* Private implementation of music related services
|
|
17 |
*
|
|
18 |
*/
|
|
19 |
|
|
20 |
#ifndef SMFMUSICPRIVATE_H_
|
|
21 |
#define SMFMUSICPRIVATE_H_
|
|
22 |
|
|
23 |
#include <qcontactgeolocation.h>
|
|
24 |
#include <smfglobal.h>
|
|
25 |
#include <smfobserver.h>
|
|
26 |
#include <smfevent.h>
|
|
27 |
#include <smfsubtitle.h>
|
|
28 |
#include <smfmusicprofile.h>
|
|
29 |
#include <smflyrics.h>
|
|
30 |
#include <smfplaylist.h>
|
|
31 |
#include <smftrackinfo.h>
|
|
32 |
#include <smflocation.h>
|
|
33 |
#include <smfprovider.h>
|
25
|
34 |
#include <smfartists.h>
|
|
35 |
#include <smfalbum.h>
|
18
|
36 |
|
|
37 |
#ifdef Q_OS_SYMBIAN
|
|
38 |
class CSmfClientSymbian;
|
|
39 |
#else
|
|
40 |
class SmfClientQt;
|
|
41 |
#endif
|
|
42 |
class SmfMusicService;
|
|
43 |
class SmfMusicSearch;
|
|
44 |
class SmfPlaylistService;
|
|
45 |
class SmfLyricsService;
|
|
46 |
class SmfMusicFingerPrint;
|
|
47 |
class SmfMusicRating;
|
|
48 |
class SmfComment;
|
25
|
49 |
class SmfContact;
|
18
|
50 |
|
|
51 |
|
|
52 |
class SmfMusicServicePrivate : public smfObserver
|
|
53 |
{
|
|
54 |
Q_OBJECT
|
|
55 |
public:
|
|
56 |
/**
|
|
57 |
* Constructor
|
|
58 |
*/
|
|
59 |
SmfMusicServicePrivate(SmfMusicService* aMusicService);
|
|
60 |
|
|
61 |
/**
|
|
62 |
* Destructor
|
|
63 |
*/
|
|
64 |
~SmfMusicServicePrivate();
|
|
65 |
|
|
66 |
/**
|
25
|
67 |
* Gets self profile information (e.g. music likings, feavorites etc) asynchronously.
|
|
68 |
* userMusicInfoAvailable() signal is emitted with SmfMusicProfile when the info is arrived
|
|
69 |
* @return SmfError. SmfNoError if success, else appropriate error code
|
|
70 |
*/
|
|
71 |
SmfError userMusicInfo ( );
|
|
72 |
|
|
73 |
/**
|
|
74 |
* Asynchronously searches information about artisits in this service. All information
|
|
75 |
* in SmfArtists is not required, however more available the better
|
|
76 |
* searchArtistInfoAvailable() signal is emitted when the info is arrived.
|
|
77 |
* @param artist The search criteria
|
|
78 |
* @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
|
|
79 |
* @param perPage Item per page, default is SMF_ITEMS_PER_PAGE
|
|
80 |
* @return SmfError, SmfNoError if success, else appropriate error value
|
|
81 |
*/
|
|
82 |
SmfError searchArtist ( SmfArtists artist, int pageNum = SMF_FIRST_PAGE,
|
|
83 |
int perPage = SMF_ITEMS_PER_PAGE );
|
|
84 |
|
|
85 |
/**
|
|
86 |
* Asynchronously searches information about albums in this service. All information
|
|
87 |
* in SmfAlbum is not required, however more available the better
|
|
88 |
* searchAlbumInfoAvailable() signal is emitted when the info is arrived.
|
|
89 |
* @param album The search criteria
|
|
90 |
* @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
|
|
91 |
* @param perPage Item per page, default is SMF_ITEMS_PER_PAGE
|
|
92 |
* @return SmfError, SmfNoError if success, else appropriate error value
|
18
|
93 |
*/
|
25
|
94 |
SmfError searchAlbum ( SmfAlbum album, int pageNum = SMF_FIRST_PAGE,
|
|
95 |
int perPage = SMF_ITEMS_PER_PAGE );
|
|
96 |
|
|
97 |
/**
|
|
98 |
* Asynchronously searches information about events in this service. All information
|
|
99 |
* in SmfEvents is not required, however more available the better
|
|
100 |
* searchEventsInfoAvailable() signal is emitted when the info is arrived.
|
|
101 |
* @param event The search criteria
|
|
102 |
* @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
|
|
103 |
* @param perPage Item per page, default is SMF_ITEMS_PER_PAGE
|
|
104 |
* @return SmfError, SmfNoError if success, else appropriate error value
|
|
105 |
*/
|
|
106 |
SmfError searchEvents ( SmfEvent event, int pageNum = SMF_FIRST_PAGE,
|
|
107 |
int perPage = SMF_ITEMS_PER_PAGE );
|
|
108 |
|
|
109 |
/**
|
|
110 |
* Asynchronously searches information about venue in this service. All information
|
|
111 |
* in SmfVenue is not required, however more available the better
|
|
112 |
* searchVenueInfoAvailable() signal is emitted when the info is arrived.
|
|
113 |
* @param location The search criteria
|
|
114 |
* @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
|
|
115 |
* @param perPage Item per page, default is SMF_ITEMS_PER_PAGE
|
|
116 |
* @return SmfError, SmfNoError if success, else appropriate error value
|
|
117 |
*/
|
|
118 |
SmfError searchVenue ( SmfLocation location, int pageNum = SMF_FIRST_PAGE,
|
|
119 |
int perPage = SMF_ITEMS_PER_PAGE );
|
18
|
120 |
|
|
121 |
/**
|
|
122 |
* Asynchronously searches information about other service users for a particular venue
|
25
|
123 |
* searchUserInfoAvailable() signal is emitted with SmfMusicProfileList when the info is arrived.
|
18
|
124 |
* When the list is big user can specify the page number and per page item data.
|
|
125 |
* If not supplied by the user default values are used.
|
25
|
126 |
* @param location The search criteria
|
18
|
127 |
* @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
|
|
128 |
* @param perPage Item per page, default is SMF_ITEMS_PER_PAGE
|
25
|
129 |
* @return SmfError, SmfNoError if success, else appropriate error value
|
18
|
130 |
*/
|
25
|
131 |
SmfError searchUser ( SmfLocation venue, int pageNum = SMF_FIRST_PAGE,
|
18
|
132 |
int perPage = SMF_ITEMS_PER_PAGE);
|
|
133 |
|
|
134 |
/**
|
25
|
135 |
* Posts currently playing track.
|
|
136 |
* Success can be checked by checking the signal postFinished()
|
|
137 |
* @param track Track to post
|
|
138 |
* @return SmfError, SmfNoError if success, else appropriate error value
|
|
139 |
*/
|
|
140 |
SmfError postCurrentPlaying ( SmfTrackInfo track);
|
|
141 |
|
|
142 |
/**
|
|
143 |
* Rate a music via this API
|
|
144 |
* Success can be checked by checking the signal postFinished()
|
|
145 |
* @param track Track on which rating should be posted
|
|
146 |
* @param rate Rating value
|
|
147 |
* @return SmfError, SmfNoError if success, else appropriate error value
|
|
148 |
*/
|
|
149 |
SmfError postRating ( SmfTrackInfo track, SmfMusicRating rate);
|
|
150 |
|
|
151 |
/**
|
|
152 |
* Comment on a track via this API
|
|
153 |
* Success can be checked by checking the signal postFinished()
|
|
154 |
* @param track Track on which comment should be posted
|
|
155 |
* @param comment The comemnt to be posted
|
|
156 |
* @return SmfError, SmfNoError if success, else appropriate error value
|
|
157 |
*/
|
|
158 |
SmfError postComments ( SmfTrackInfo track, SmfComment comment);
|
|
159 |
|
|
160 |
/**
|
18
|
161 |
* Request for a custom operation. The signal customDataAvailable() is emitted
|
|
162 |
* when the result is available.
|
|
163 |
* @param operationId OperationId
|
|
164 |
* @param customData Custom data to be sent
|
25
|
165 |
* @return SmfError. SmfNoError if success, else appropriate error code
|
18
|
166 |
* Note:-Interpretation of operationId and customData is upto the concerned
|
|
167 |
* plugin and client application. service provider should provide some
|
|
168 |
* serializing-deserializing utilities for these custom data
|
|
169 |
*/
|
25
|
170 |
SmfError customRequest ( const int& operationId, QByteArray* customData );
|
18
|
171 |
|
25
|
172 |
/**
|
|
173 |
* Cancels a request generated due to the call to any API which results
|
|
174 |
* into http request. Might return error if no request is currently pending.
|
|
175 |
* Please note that there can be only one request pending at any point of time
|
|
176 |
* @return Appropriate SmfError value
|
|
177 |
*/
|
|
178 |
SmfError cancelRequest ();
|
18
|
179 |
|
|
180 |
public: // from smfObserver
|
|
181 |
/**
|
|
182 |
* To notify availibility of asynchronous requests.
|
|
183 |
* @param result Requested result, before using must check error param.
|
|
184 |
* @param opcode Requested opcode, for which the result has arrived.
|
|
185 |
* @param error Error
|
|
186 |
*/
|
|
187 |
void resultsAvailable(QByteArray result,SmfRequestTypeID opcode, SmfError error);
|
|
188 |
|
|
189 |
private:
|
|
190 |
SmfMusicService* m_musicService;
|
|
191 |
//serialized byte array of provider+other info to be sent to the server
|
|
192 |
//The order:- SmfProvider then params in order of their appearance in fn
|
|
193 |
QByteArray m_serializedDataToServer;
|
|
194 |
#ifdef Q_OS_SYMBIAN
|
|
195 |
CSmfClientSymbian* m_SmfClientPrivate;
|
|
196 |
friend class CSmfClientSymbian;
|
|
197 |
#else
|
|
198 |
SmfClientQt* m_SmfClientPrivate;
|
|
199 |
friend class SmfClientQt;
|
|
200 |
#endif
|
25
|
201 |
quint8 m_argFlag;
|
18
|
202 |
|
|
203 |
};
|
|
204 |
|
|
205 |
|
|
206 |
//SmfMusicSearch
|
|
207 |
class SmfMusicSearchPrivate : public smfObserver
|
|
208 |
{
|
|
209 |
Q_OBJECT
|
|
210 |
public:
|
|
211 |
/**
|
|
212 |
* Constructor
|
|
213 |
*/
|
|
214 |
SmfMusicSearchPrivate(SmfMusicSearch* aMusicSearch);
|
|
215 |
|
|
216 |
/**
|
|
217 |
* Constructor
|
|
218 |
*/
|
|
219 |
~SmfMusicSearchPrivate();
|
|
220 |
|
|
221 |
public:
|
|
222 |
/**
|
|
223 |
* Searches for music recommendations similar to a particulartrack asynchronously.
|
|
224 |
* The signal trackSearchAvailable() is emitted with SmfTrackInfoList
|
|
225 |
* once its arrived.
|
|
226 |
* When the list is big user can specify the page number and per page item data.
|
|
227 |
* If not supplied by the user default values are used.
|
|
228 |
* @param track The track for which similar recommendations need to be fetched.
|
|
229 |
* @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
|
|
230 |
* @param perPage Item per page, default is SMF_ITEMS_PER_PAGE
|
25
|
231 |
* @return SmfNoError if success, else appropriate error value
|
18
|
232 |
*/
|
25
|
233 |
SmfError recommendations ( SmfTrackInfo track, int pageNum = SMF_FIRST_PAGE,
|
18
|
234 |
int perPage = SMF_ITEMS_PER_PAGE);
|
|
235 |
|
|
236 |
/**
|
|
237 |
* Searches for tracks similar to a given track asynchronously.
|
|
238 |
* The signal trackSearchAvailable() is emitted with SmfTrackInfoList
|
|
239 |
* once its arrived.
|
|
240 |
* When the list is big user can specify the page number and per page item data.
|
|
241 |
* If not supplied by the user default values are used.
|
|
242 |
* @param track The search criteria, similar tracks are searched
|
|
243 |
* @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
|
|
244 |
* @param perPage Item per page, default is SMF_ITEMS_PER_PAGE
|
25
|
245 |
* @return SmfNoError if success, else appropriate error value
|
18
|
246 |
*/
|
25
|
247 |
SmfError tracksSimilar ( SmfTrackInfo track, int pageNum = SMF_FIRST_PAGE,
|
|
248 |
int perPage = SMF_ITEMS_PER_PAGE);
|
|
249 |
|
|
250 |
/**
|
|
251 |
* Searches for tracks for a given album asynchronously.
|
|
252 |
* The signal trackSearchAvailable() is emitted with SmfTrackInfoList
|
|
253 |
* once its arrived.
|
|
254 |
* When the list is big user can specify the page number and per page item data.
|
|
255 |
* If not supplied by the user default values are used.
|
|
256 |
* @param album The album containing the id
|
|
257 |
* @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
|
|
258 |
* @param perPage Item per page, default is SMF_ITEMS_PER_PAGE
|
|
259 |
* @return SmfNoError if success, else appropriate error value
|
|
260 |
*/
|
|
261 |
SmfError tracksOfAlbum ( SmfAlbum album, int pageNum = SMF_FIRST_PAGE,
|
|
262 |
int perPage = SMF_ITEMS_PER_PAGE);
|
|
263 |
|
|
264 |
/**
|
|
265 |
* Searches for tracks for a given artist(s) asynchronously.
|
|
266 |
* The signal trackSearchAvailable() is emitted with SmfTrackInfoList
|
|
267 |
* once its arrived.
|
|
268 |
* When the list is big user can specify the page number and per page item data.
|
|
269 |
* If not supplied by the user default values are used.
|
|
270 |
* @param artists The artists list
|
|
271 |
* @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
|
|
272 |
* @param perPage Item per page, default is SMF_ITEMS_PER_PAGE
|
|
273 |
* @return SmfNoError if success, else appropriate error value
|
|
274 |
*/
|
|
275 |
SmfError tracksOfArtist ( SmfArtists artists, int pageNum = SMF_FIRST_PAGE,
|
18
|
276 |
int perPage = SMF_ITEMS_PER_PAGE);
|
|
277 |
|
|
278 |
/**
|
|
279 |
* Searches for a track having similar finger print asynchronously.
|
|
280 |
* The signal trackSearchAvailable() is emitted with SmfTrackInfoList
|
|
281 |
* once its arrived.
|
|
282 |
* @param signature The search criteria,signature to be searched for
|
|
283 |
* @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
|
|
284 |
* @param perPage Item per page, default is SMF_ITEMS_PER_PAGE
|
25
|
285 |
* @return SmfNoError if success, else appropriate error value
|
18
|
286 |
*/
|
25
|
287 |
SmfError trackInfo ( SmfMusicFingerPrint signature, int pageNum = SMF_FIRST_PAGE,
|
18
|
288 |
int perPage = SMF_ITEMS_PER_PAGE);
|
|
289 |
|
|
290 |
/**
|
|
291 |
* Search information about where to buy this song from asynchronously.
|
|
292 |
* The signal storeSearchAvailable() is emitted with SmfProviderList once its arrived.
|
|
293 |
* @param track The search criteria for stores
|
|
294 |
* @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
|
|
295 |
* @param perPage Item per page, default is SMF_ITEMS_PER_PAGE
|
25
|
296 |
* @return SmfNoError if success, else appropriate error value
|
18
|
297 |
*/
|
25
|
298 |
SmfError stores ( SmfTrackInfo track, int pageNum = SMF_FIRST_PAGE,
|
18
|
299 |
int perPage = SMF_ITEMS_PER_PAGE);
|
|
300 |
|
|
301 |
/**
|
|
302 |
* Request for a custom operation. The signal customDataAvailable() is emitted
|
|
303 |
* when the result is available.
|
|
304 |
* @param operationId OperationId
|
|
305 |
* @param customData Custom data to be sent
|
25
|
306 |
* @return SmfNoError if success, else appropriate error value
|
18
|
307 |
* Note:-Interpretation of operationId and customData is upto the concerned
|
|
308 |
* plugin and client application. service provider should provide some
|
|
309 |
* serializing-deserializing utilities for these custom data
|
|
310 |
*/
|
25
|
311 |
SmfError customRequest ( const int& operationId, QByteArray* customData );
|
|
312 |
|
|
313 |
/**
|
|
314 |
* Cancels a request generated due to the call to any API which results
|
|
315 |
* into http request. Might return error if no request is currently pending.
|
|
316 |
* Please note that there can be only one request pending at any point of time
|
|
317 |
* @return Appropriate SmfError value
|
|
318 |
*/
|
|
319 |
SmfError cancelRequest ();
|
18
|
320 |
|
|
321 |
public: //From smfObserver
|
|
322 |
/**
|
|
323 |
* To notify availibility of asynchronous requests.
|
|
324 |
* @param result Requested result, before using must check error param.
|
|
325 |
* @param opcode Requested opcode, for which the result has arrived.
|
|
326 |
* @param error Error
|
|
327 |
*/
|
|
328 |
void resultsAvailable(QByteArray result,SmfRequestTypeID opcode, SmfError error);
|
|
329 |
|
|
330 |
private:
|
|
331 |
SmfMusicSearch *m_musicSearch;
|
|
332 |
//serialized byte array of provider+other info to be sent to the server
|
|
333 |
//The order:- SmfProvider then params in order of their appearance in fn
|
|
334 |
QByteArray m_serializedDataToServer;
|
|
335 |
#ifdef Q_OS_SYMBIAN
|
|
336 |
CSmfClientSymbian* m_SmfClientPrivate;
|
|
337 |
friend class CSmfClientSymbian;
|
|
338 |
#else
|
|
339 |
SmfClientQt* m_SmfClientPrivate;
|
|
340 |
friend class SmfClientQt;
|
|
341 |
#endif
|
25
|
342 |
quint8 m_argFlag;
|
18
|
343 |
|
|
344 |
};
|
|
345 |
|
|
346 |
|
|
347 |
class SmfPlaylistServicePrivate : public smfObserver
|
|
348 |
{
|
|
349 |
Q_OBJECT
|
|
350 |
|
|
351 |
public:
|
|
352 |
/**
|
|
353 |
* Constructs SmfPlaylistService with base provider info
|
|
354 |
*/
|
|
355 |
SmfPlaylistServicePrivate(SmfPlaylistService* aPlayLstSrvc);
|
|
356 |
|
|
357 |
/**
|
|
358 |
* Destructor
|
|
359 |
*/
|
|
360 |
~SmfPlaylistServicePrivate();
|
|
361 |
|
|
362 |
public:
|
|
363 |
/**
|
|
364 |
* Gets the list playlists for the logged-in user asynchronously.
|
|
365 |
* The signal playlistsListAvailable() signal is emitted with
|
|
366 |
* SmfPlaylistList once its arrived .
|
|
367 |
* When the list is big user can specify the page number and per page item data.
|
|
368 |
* If not supplied by the user default values are used.
|
|
369 |
* @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
|
|
370 |
* @param perPage Item per page, default is SMF_ITEMS_PER_PAGE
|
25
|
371 |
* @return SmfNoError if success, else appropriate error value
|
18
|
372 |
*/
|
25
|
373 |
SmfError playlists ( int pageNum = SMF_FIRST_PAGE,
|
18
|
374 |
int perPage = SMF_ITEMS_PER_PAGE);
|
|
375 |
|
|
376 |
/**
|
|
377 |
* Gets the list playlists for the given user asynchronously.
|
|
378 |
* The signal playlistsListAvailable() signal is emitted with
|
|
379 |
* SmfPlaylistList once its arrived.
|
|
380 |
* When the list is big user can specify the page number and per page item data.
|
|
381 |
* If not supplied by the user default values are used.
|
|
382 |
* @param user User for which to get the playlists
|
|
383 |
* @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
|
|
384 |
* @param perPage Item per page, default is SMF_ITEMS_PER_PAGE
|
25
|
385 |
* @return SmfNoError if success, else appropriate error value
|
18
|
386 |
*/
|
25
|
387 |
SmfError playlistsOf ( SmfContact* user, int pageNum = SMF_FIRST_PAGE,
|
18
|
388 |
int perPage = SMF_ITEMS_PER_PAGE);
|
|
389 |
|
|
390 |
/**
|
|
391 |
* Upload currently playing track to a playlist. Signal
|
|
392 |
* playlistUpdated() can be checked for success value
|
|
393 |
* @param plst The playlist to be added in
|
|
394 |
* @param tracks The list of tracks to uploaded
|
25
|
395 |
* @return SmfNoError if success, else appropriate error value
|
18
|
396 |
*/
|
25
|
397 |
SmfError addToPlaylist ( SmfPlaylist plst, SmfTrackInfoList* tracks );
|
18
|
398 |
|
|
399 |
/**
|
|
400 |
* Upload currently playing playlist . Signal
|
|
401 |
* playlistUpdated() can be checked for success value
|
|
402 |
* @param plst The playlist to be uploaded
|
25
|
403 |
* @return SmfNoError if success, else appropriate error value
|
18
|
404 |
*/
|
25
|
405 |
SmfError postCurrentPlayingPlaylist ( SmfPlaylist plst );
|
18
|
406 |
|
|
407 |
/**
|
|
408 |
* Request for a custom operation. The signal customDataAvailable() is emitted
|
|
409 |
* when the result is available.
|
|
410 |
* @param operationId OperationId
|
|
411 |
* @param customData Custom data to be sent
|
25
|
412 |
* @return SmfNoError if success, else appropriate error value
|
18
|
413 |
* Note:-Interpretation of operationId and customData is upto the concerned
|
|
414 |
* plugin and client application. service provider should provide some
|
|
415 |
* serializing-deserializing utilities for these custom data
|
|
416 |
*/
|
25
|
417 |
SmfError customRequest ( const int& operationId, QByteArray* customData );
|
|
418 |
|
|
419 |
/**
|
|
420 |
* Cancels a request generated due to the call to any API which results
|
|
421 |
* into http request. Might return error if no request is currently pending.
|
|
422 |
* Please note that there can be only one request pending at any point of time
|
|
423 |
* @return Appropriate SmfError value
|
|
424 |
*/
|
|
425 |
SmfError cancelRequest ();
|
18
|
426 |
|
|
427 |
public: //From smfObserver
|
|
428 |
/**
|
|
429 |
* To notify availibility of asynchronous requests.
|
|
430 |
* @param result Requested result, before using must check error param.
|
|
431 |
* @param opcode Requested opcode, for which the result has arrived.
|
|
432 |
* @param error Error
|
|
433 |
*/
|
|
434 |
void resultsAvailable(QByteArray result,SmfRequestTypeID opcode, SmfError error);
|
|
435 |
|
|
436 |
private:
|
|
437 |
SmfPlaylistService* m_playlstSrvc;
|
|
438 |
//serialized byte array of provider+other info to be sent to the server
|
|
439 |
//The order:- SmfProvider then params in order of their appearance in fn
|
|
440 |
QByteArray m_serializedDataToServer;
|
|
441 |
|
|
442 |
#ifdef Q_OS_SYMBIAN
|
|
443 |
CSmfClientSymbian* m_SmfClientPrivate;
|
|
444 |
friend class CSmfClientSymbian;
|
|
445 |
#else
|
|
446 |
SmfClientQt* m_SmfClientPrivate;
|
|
447 |
friend class SmfClientQt;
|
|
448 |
#endif
|
25
|
449 |
quint8 m_argFlag;
|
18
|
450 |
|
|
451 |
};
|
|
452 |
|
|
453 |
|
|
454 |
|
|
455 |
/**
|
|
456 |
* provides service ("org.symbian.smf.client.music.lyrics")
|
|
457 |
*/
|
|
458 |
class SmfLyricsServicePrivate : public smfObserver
|
|
459 |
{
|
|
460 |
Q_OBJECT
|
|
461 |
|
|
462 |
public:
|
|
463 |
/**
|
|
464 |
* Constructs SmfLyricsService with base provider info.
|
|
465 |
*/
|
|
466 |
SmfLyricsServicePrivate(SmfLyricsService* aLyricsSrvc);
|
|
467 |
|
|
468 |
/**
|
|
469 |
* Destructor
|
|
470 |
*/
|
|
471 |
~SmfLyricsServicePrivate();
|
|
472 |
|
|
473 |
public:
|
|
474 |
/**
|
|
475 |
* Get the lyrics lists asynchrnously, it fetches texts without time info.
|
|
476 |
* lyricsAvailable() notification comes SmfLyricsList with when the data is available
|
|
477 |
* @param track Track for which lyrics needs to be fetched.
|
|
478 |
* @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
|
|
479 |
* @param perPage Item per page, default is SMF_ITEMS_PER_PAGE
|
25
|
480 |
* @return SmfNoError if success, else appropriate error value
|
18
|
481 |
*/
|
25
|
482 |
SmfError lyrics ( SmfTrackInfo track, int pageNum = SMF_FIRST_PAGE,
|
18
|
483 |
int perPage = SMF_ITEMS_PER_PAGE);
|
|
484 |
|
|
485 |
/**
|
|
486 |
* Get the lyrics lists asynchrnously, it fetches texts with time info.
|
|
487 |
* Subtitle search filter can be applied
|
|
488 |
* subtitleAvailable() notification comes SmfSubtitleList with when the data is available
|
|
489 |
* @param track Track for which subtitle needs to be fetched.
|
|
490 |
* @param filter Subtitle search filter
|
|
491 |
* @param pageNum Page number to download, SMF_FIRST_PAGE denotes fresh query.
|
|
492 |
* @param perPage Item per page, default is SMF_ITEMS_PER_PAGE
|
25
|
493 |
* @return SmfNoError if success, else appropriate error value
|
18
|
494 |
*/
|
25
|
495 |
SmfError subtitles ( SmfTrackInfo track, SmfSubtitleSearchFilter filter,
|
18
|
496 |
int pageNum = SMF_FIRST_PAGE, int perPage = SMF_ITEMS_PER_PAGE);
|
|
497 |
|
|
498 |
/**
|
|
499 |
* Request for a custom operation. The signal customDataAvailable() is emitted
|
|
500 |
* when the result is available.
|
|
501 |
* @param operationId OperationId
|
|
502 |
* @param customData Custom data to be sent
|
25
|
503 |
* @return SmfNoError if success, else appropriate error value
|
18
|
504 |
* Note:-Interpretation of operationId and customData is upto the concerned
|
|
505 |
* plugin and client application. service provider should provide some
|
|
506 |
* serializing-deserializing utilities for these custom data
|
|
507 |
*/
|
25
|
508 |
SmfError customRequest ( const int& operationId, QByteArray* customData );
|
|
509 |
|
|
510 |
/**
|
|
511 |
* Cancels a request generated due to the call to any API which results
|
|
512 |
* into http request. Might return error if no request is currently pending.
|
|
513 |
* Please note that there can be only one request pending at any point of time
|
|
514 |
* @return Appropriate SmfError value
|
|
515 |
*/
|
|
516 |
SmfError cancelRequest ();
|
18
|
517 |
|
|
518 |
public: //From smfObserver
|
|
519 |
/**
|
|
520 |
* To notify availibility of asynchronous requests.
|
|
521 |
* @param result Requested result, before using must check error param.
|
|
522 |
* @param opcode Requested opcode, for which the result has arrived.
|
|
523 |
* @param error Error
|
|
524 |
*/
|
|
525 |
void resultsAvailable(QByteArray result,SmfRequestTypeID opcode, SmfError error);
|
|
526 |
|
|
527 |
private:
|
|
528 |
SmfLyricsService *m_lyricsSrvc;
|
|
529 |
//serialized byte array of provider+other info to be sent to the server
|
|
530 |
//The order:- SmfProvider then params in order of their appearance in fn
|
|
531 |
QByteArray m_serializedDataToServer;
|
|
532 |
#ifdef Q_OS_SYMBIAN
|
|
533 |
CSmfClientSymbian* m_SmfClientPrivate;
|
|
534 |
friend class CSmfClientSymbian;
|
|
535 |
#else
|
|
536 |
SmfClientQt* m_SmfClientPrivate;
|
|
537 |
friend class SmfClientQt;
|
|
538 |
#endif
|
25
|
539 |
quint8 m_argFlag;
|
18
|
540 |
|
|
541 |
};
|
|
542 |
|
|
543 |
#endif
|