author | cgandhi |
Thu, 23 Sep 2010 17:43:31 +0530 | |
changeset 25 | a180113055cb |
parent 18 | 013a02bf2bb0 |
permissions | -rw-r--r-- |
7
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
1 |
/** |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
2 |
* Copyright (c) 2010 Sasken Communication Technologies Ltd. |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
3 |
* All rights reserved. |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
4 |
* This component and the accompanying materials are made available |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
5 |
* under the terms of the "Eclipse Public License v1.0" |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
6 |
* which accompanies this distribution, and is available |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html" |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
8 |
* |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
9 |
* Initial Contributors: |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
10 |
* Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
11 |
* |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
12 |
* Contributors: |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
13 |
* Manasij Roy, Nalina Hariharan |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
14 |
* |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
15 |
* Description: |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
16 |
* Interface specification for music services |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
17 |
* |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
18 |
*/ |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
19 |
|
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
20 |
|
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
21 |
#ifndef SMFMUSICSERVICEPLUGIN_H_ |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
22 |
#define SMFMUSICSERVICEPLUGIN_H_ |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
23 |
|
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
24 |
#include <smfpluginbase.h> |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
25 |
#include <smfmusicprofile.h> |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
26 |
#include <smflocation.h> |
18 | 27 |
#include <smftrackinfo.h> |
28 |
#include <smfmusicrating.h> |
|
29 |
#include <smfcomment.h> |
|
7
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
30 |
|
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
31 |
/** |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
32 |
* @ingroup smf_plugin_group |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
33 |
* Interface specification for music services. This class provides basic |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
34 |
* functionality to allow application to search for a user or check for |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
35 |
* user information etc. |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
36 |
* |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
37 |
* All of the functionality described here should be implemented by a service |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
38 |
* specific plug-in. |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
39 |
*/ |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
40 |
class SmfMusicServicePlugin : public SmfPluginBase |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
41 |
{ |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
42 |
public: |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
43 |
|
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
44 |
/** |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
45 |
* Destructor |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
46 |
*/ |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
47 |
virtual ~SmfMusicServicePlugin( ) {} |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
48 |
|
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
49 |
/** |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
50 |
* Method to get self profile information |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
51 |
* @param aRequest [out] The request data to be sent to network |
25 | 52 |
* @return Appropriate value of the enum SmfPluginError. |
53 |
* Plugin error if any, else SmfPluginErrNone for success |
|
54 |
*/ |
|
55 |
virtual SmfPluginError userMusicInfo( SmfPluginRequestData &aRequest ) = 0; |
|
56 |
||
57 |
/** |
|
58 |
* Method to search information about artists. All information |
|
59 |
* in SmfArtists is not required, however more available the better |
|
60 |
* @param aRequest [out] The request data to be sent to network |
|
61 |
* @param aArtist The artist which is the search criteria |
|
62 |
* @param aPageNum The page to be extracted |
|
63 |
* @param aItemsPerPage Number of items per page |
|
64 |
* @return Appropriate value of the enum SmfPluginError. |
|
65 |
* Plugin error if any, else SmfPluginErrNone for success |
|
66 |
*/ |
|
67 |
virtual SmfPluginError searchArtist( SmfPluginRequestData &aRequest, |
|
68 |
const SmfArtists &aArtist, |
|
69 |
const int aPageNum = SMF_FIRST_PAGE, |
|
70 |
const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
|
71 |
||
72 |
/** |
|
73 |
* Method to search information about album. All information |
|
74 |
* in SmfAlbum is not required, however more available the better |
|
75 |
* @param aRequest [out] The request data to be sent to network |
|
76 |
* @param aAlbum [in] The album which is the search criteria |
|
77 |
* @param aPageNum [in] The page to be extracted |
|
78 |
* @param aItemsPerPage [in] Number of items per page |
|
79 |
* @return Appropriate value of the enum SmfPluginError. |
|
80 |
* Plugin error if any, else SmfPluginErrNone for success |
|
7
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
81 |
*/ |
25 | 82 |
virtual SmfPluginError searchAlbum( SmfPluginRequestData &aRequest, |
83 |
const SmfAlbum &aAlbum, |
|
84 |
const int aPageNum = SMF_FIRST_PAGE, |
|
85 |
const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
|
86 |
||
87 |
/** |
|
88 |
* Method to search information about events. All information |
|
89 |
* in SmfEvent is not required, however more available the better |
|
90 |
* @param aRequest [out] The request data to be sent to network |
|
91 |
* @param aEvent [in] The event which is the search criteria |
|
92 |
* @param aPageNum [in] The page to be extracted |
|
93 |
* @param aItemsPerPage [in] Number of items per page |
|
94 |
* @return Appropriate value of the enum SmfPluginError. |
|
95 |
* Plugin error if any, else SmfPluginErrNone for success |
|
96 |
*/ |
|
97 |
virtual SmfPluginError searchEvents( SmfPluginRequestData &aRequest, |
|
98 |
const SmfEvent &aEvent, |
|
99 |
const int aPageNum = SMF_FIRST_PAGE, |
|
100 |
const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
|
101 |
||
102 |
/** |
|
103 |
* Method to search information about venue. All information |
|
104 |
* in SmfLocation is not required, however more available the better |
|
105 |
* @param aRequest [out] The request data to be sent to network |
|
106 |
* @param aVenue [in] The venue which is the search criteria |
|
107 |
* @param aPageNum [in] The page to be extracted |
|
108 |
* @param aItemsPerPage [in] Number of items per page |
|
109 |
* @return Appropriate value of the enum SmfPluginError. |
|
110 |
* Plugin error if any, else SmfPluginErrNone for success |
|
111 |
*/ |
|
112 |
virtual SmfPluginError searchVenue( SmfPluginRequestData &aRequest, |
|
113 |
const SmfLocation &aVenue, |
|
114 |
const int aPageNum = SMF_FIRST_PAGE, |
|
115 |
const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
|
7
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
116 |
|
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
117 |
/** |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
118 |
* Method to search information about other service users for a |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
119 |
* particular place |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
120 |
* @param aRequest [out] The request data to be sent to network |
25 | 121 |
* @param aPlace [in] The place which is the search criteria |
122 |
* @param aPageNum [in] The page to be extracted |
|
123 |
* @param aItemsPerPage [in] Number of items per page |
|
124 |
* @return Appropriate value of the enum SmfPluginError. |
|
125 |
* Plugin error if any, else SmfPluginErrNone for success |
|
7
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
126 |
*/ |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
127 |
virtual SmfPluginError searchUser( SmfPluginRequestData &aRequest, |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
128 |
const SmfLocation &aPlace, |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
129 |
const int aPageNum = SMF_FIRST_PAGE, |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
130 |
const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0; |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
131 |
|
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
132 |
/** |
18 | 133 |
* Method to post the currently playing track |
134 |
* @param aRequest [out] The request data to be sent to network |
|
25 | 135 |
* @param aTrack [in] The current playing track, that should be posted |
136 |
* @return Appropriate value of the enum SmfPluginError. |
|
137 |
* Plugin error if any, else SmfPluginErrNone for success |
|
18 | 138 |
*/ |
139 |
virtual SmfPluginError postCurrentPlaying( |
|
140 |
SmfPluginRequestData &aRequest, |
|
141 |
const SmfTrackInfo &aTrack ) = 0; |
|
142 |
||
143 |
/** |
|
144 |
* Method to post the rating on a track |
|
145 |
* @param aRequest [out] The request data to be sent to network |
|
25 | 146 |
* @param aTrack [in] The track on which rating should be posted |
147 |
* @param aRating [in] The rating values |
|
148 |
* @return Appropriate value of the enum SmfPluginError. |
|
149 |
* Plugin error if any, else SmfPluginErrNone for success |
|
18 | 150 |
*/ |
151 |
virtual SmfPluginError postRating( |
|
152 |
SmfPluginRequestData &aRequest, |
|
153 |
const SmfTrackInfo &aTrack, |
|
154 |
const SmfMusicRating &aRating ) = 0; |
|
155 |
||
156 |
/** |
|
157 |
* Method to post comment on a track |
|
158 |
* @param aRequest [out] The request data to be sent to network |
|
25 | 159 |
* @param aTrack [in] The track on which comment should be posted |
160 |
* @param aComment [in] The comment content |
|
161 |
* @return Appropriate value of the enum SmfPluginError. |
|
162 |
* Plugin error if any, else SmfPluginErrNone for success |
|
18 | 163 |
*/ |
164 |
virtual SmfPluginError postComments( |
|
165 |
SmfPluginRequestData &aRequest, |
|
166 |
const SmfTrackInfo &aTrack, |
|
167 |
const SmfComment &aComment ) = 0; |
|
168 |
||
169 |
/** |
|
7
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
170 |
* Customised method for SmfMusicServicePlugin interface |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
171 |
* @param aRequest [out] The request data to be sent to network |
25 | 172 |
* @param aOperation [in] The operation type (should be known between |
7
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
173 |
* the client interface and the plugin) |
25 | 174 |
* @param aData [in] The data required to form the request (The type |
7
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
175 |
* of data should be known between client and the plugin) |
25 | 176 |
* @return Appropriate value of the enum SmfPluginError. |
177 |
* Plugin error if any, else SmfPluginErrNone for success |
|
7
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
178 |
*/ |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
179 |
virtual SmfPluginError customRequest( SmfPluginRequestData &aRequest, |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
180 |
const int &aOperation, QByteArray *aData ) = 0; |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
181 |
|
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
182 |
}; |
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
183 |
|
14
a469c0e6e7fb
changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
7
diff
changeset
|
184 |
Q_DECLARE_INTERFACE( SmfMusicServicePlugin, "org.symbian.smf.plugin.music.service/v0.2" ); |
7
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
185 |
|
be09cf1f39dd
Updating the source code for plugin manager, transport manager, smfserver and smf client.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
186 |
#endif /* SMFMUSICSERVICEPLUGIN_H_ */ |