|
1 /* |
|
2 * Copyright (c) 2007-2007 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "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 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: header for the songhistory information class |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef C_CIRSONGHISTORYINFO_H |
|
20 #define C_CIRSONGHISTORYINFO_H |
|
21 |
|
22 #include <s32mem.h> |
|
23 |
|
24 /** |
|
25 * SongHistory meta data information wrapper. |
|
26 */ |
|
27 NONSHARABLE_CLASS( CIRSongHistoryInfo ) : public CBase |
|
28 { |
|
29 |
|
30 public: |
|
31 |
|
32 /** |
|
33 *Function : NewL |
|
34 *Function returns an instance of CIRSongHistoryInfo |
|
35 *Two phase constructor |
|
36 *@return instance of CIRSongHistoryInfo |
|
37 */ |
|
38 IMPORT_C static CIRSongHistoryInfo * NewL(); |
|
39 |
|
40 /** |
|
41 *CIRSongHistoryInfo::NewLC() |
|
42 *Static function |
|
43 *standard two phased constructor |
|
44 *@return *CIRSongHistoryInfo |
|
45 */ |
|
46 IMPORT_C static CIRSongHistoryInfo* NewLC(); |
|
47 |
|
48 /** |
|
49 *CIRSongHistoryInfo::~CIRSongHistoryInfo() |
|
50 *standard C++ destructor |
|
51 */ |
|
52 IMPORT_C ~CIRSongHistoryInfo(); |
|
53 |
|
54 /** |
|
55 *CIRSongHistoryInfo::SetHistoryInfoL() |
|
56 *Function to set songhistory ingo from a RBuf |
|
57 */ |
|
58 |
|
59 IMPORT_C void SetHistoryInfo(RBuf& aSongName, |
|
60 RBuf& aArtist, |
|
61 RBuf& aStreamUrl, |
|
62 RBuf& aChannelName, |
|
63 TInt aChannelType , |
|
64 TInt aChannelId, |
|
65 TInt aBitrate, |
|
66 RBuf& aChannelDesc, |
|
67 RBuf& aImageUrl, |
|
68 RBuf& aMusicStoreStatus ); |
|
69 |
|
70 /** |
|
71 *CIRSongHistoryInfo::SetChannelName() |
|
72 *Function to set channel name from a RBuf |
|
73 *@param RBuf aChannelName |
|
74 */ |
|
75 |
|
76 void SetChannelName(RBuf& aChannelName); |
|
77 |
|
78 /** |
|
79 *CIRSongHistoryInfo::SetArtist() |
|
80 *Function to set artist name from a RBuf |
|
81 *@param RBuf aArtist |
|
82 */ |
|
83 |
|
84 void SetArtist(RBuf& aArtist); |
|
85 |
|
86 /** |
|
87 *CIRSongHistoryInfo::SetSongName() |
|
88 *Function to set song name from a RBuf |
|
89 *@param RBuf aSongName |
|
90 */ |
|
91 |
|
92 void SetSongName (RBuf& aSongName); |
|
93 |
|
94 /** |
|
95 *CIRSongHistoryInfo::SetStreamUrl() |
|
96 *Function to set stream url from a RBuf |
|
97 *@param RBuf aStreamUrl |
|
98 */ |
|
99 |
|
100 void SetStreamUrl(RBuf& aStreamUrl); |
|
101 |
|
102 /** |
|
103 *CIRSongHistoryInfo::GetSongInfo() |
|
104 *Function to get song name from a TDesC |
|
105 *@return RBuf& instance |
|
106 */ |
|
107 |
|
108 IMPORT_C const RBuf& GetSongInfo() const; |
|
109 |
|
110 /** |
|
111 *CIRSongHistoryInfo::GetArtistName() |
|
112 *Function to get artist name from a TDesC |
|
113 *@return RBuf& instance |
|
114 */ |
|
115 |
|
116 IMPORT_C const RBuf& GetArtistInfo() const; |
|
117 |
|
118 /** |
|
119 *CIRSongHistoryInfo::GetStreamUrl() |
|
120 *Function to get url name from a TDesC |
|
121 *@return RBuf& instance |
|
122 */ |
|
123 |
|
124 IMPORT_C const RBuf& GetStreamUrl() const; |
|
125 |
|
126 /** |
|
127 *CIRSongHistoryInfo::GetChannelName() |
|
128 *Function to get channel name from a TDesC |
|
129 *@return RBuf& instance |
|
130 */ |
|
131 |
|
132 IMPORT_C const RBuf& GetChannelName() const; |
|
133 |
|
134 /** |
|
135 *CIRSongHistoryInfo::GetChannelType() |
|
136 *Function to get channel Type |
|
137 *@return TInt channeltype |
|
138 */ |
|
139 IMPORT_C TInt GetChannelType() const; |
|
140 |
|
141 /** |
|
142 *CIRSongHistoryInfo::SetChannelType() |
|
143 *Function to set channel Type |
|
144 *@param TInt aChannelImgUrl |
|
145 */ |
|
146 void SetChannelType(TInt aChannelImgUrl); |
|
147 /** |
|
148 *CIRSongHistoryInfo::SetChannelId() |
|
149 *Function to set channel Id |
|
150 *@param TInt aChannelId |
|
151 */ |
|
152 void SetChannelId(TInt aChannelId); |
|
153 /** |
|
154 *CIRSongHistoryInfo::GetChannelId() |
|
155 *Function to get channel Id |
|
156 *@return TInt channelId |
|
157 */ |
|
158 IMPORT_C TInt GetChannelId() const; |
|
159 /** |
|
160 *CIRSongHistoryInfo::SetBitrate() |
|
161 *Function to set bitrate |
|
162 *@param TInt aBitrate |
|
163 */ |
|
164 void SetBitrate(TInt aBitrate); |
|
165 /** |
|
166 *CIRSongHistoryInfo::GetBitrate() |
|
167 *Function to get bitrate |
|
168 *@return TInt aBitrate |
|
169 */ |
|
170 IMPORT_C TInt GetBitrate() const; |
|
171 /** |
|
172 *CIRSongHistoryInfo::GetChannelDesc() |
|
173 *Function to get channel Description |
|
174 *@return RBuf& instance |
|
175 */ |
|
176 IMPORT_C const RBuf& GetChannelDesc() const ; |
|
177 /** |
|
178 *CIRSongHistoryInfo::SetChannelDesc() |
|
179 *Function to set channel Description |
|
180 * @param RBuf aChannelDesc |
|
181 */ |
|
182 void SetChannelDesc(RBuf& aChannelDesc) ; |
|
183 /** |
|
184 *CIRSongHistoryInfo::GetImageUrl() |
|
185 *Function to get channel image Url |
|
186 *@return RBuf& instance |
|
187 */ |
|
188 IMPORT_C const RBuf& GetImageUrl() const ; |
|
189 /** |
|
190 *CIRSongHistoryInfo::SetImageUrl() |
|
191 *Function to set channel image Url |
|
192 * @param RBuf aImageUrl |
|
193 */ |
|
194 void SetImageUrl(RBuf& aImageUrl) ; |
|
195 /** |
|
196 *CIRSongHistoryInfo::SetChannelMusicStatus() |
|
197 *Function to set Channel MusicStoreStatus |
|
198 *@param RBuf aChannelMusicStatus |
|
199 */ |
|
200 void SetChannelMusicStatus(RBuf& aChannelMusicStatus) ; |
|
201 /** |
|
202 *CIRSongHistoryInfo::GetChannelMusicStatus() |
|
203 *Function to get channel MusicStoreStatus |
|
204 *@return RBuf& instance |
|
205 */ |
|
206 IMPORT_C const RBuf& GetChannelMusicStatus() const ; |
|
207 private: |
|
208 |
|
209 /** |
|
210 * Default constructor. |
|
211 */ |
|
212 |
|
213 CIRSongHistoryInfo(); |
|
214 |
|
215 |
|
216 private: //data |
|
217 |
|
218 /** |
|
219 * The name of the artist. |
|
220 */ |
|
221 RBuf iArtistInfo; |
|
222 |
|
223 /** |
|
224 * The name of the song. |
|
225 */ |
|
226 RBuf iSongInfo; |
|
227 |
|
228 /** |
|
229 * The stream URL. |
|
230 */ |
|
231 RBuf iStreamUrlInfo; |
|
232 |
|
233 /** |
|
234 * Channel Name. |
|
235 */ |
|
236 RBuf iChannelInfo; |
|
237 |
|
238 /** |
|
239 * Channel Type. |
|
240 */ |
|
241 TInt iChannelType; |
|
242 |
|
243 |
|
244 /** |
|
245 * Channel Description. |
|
246 */ |
|
247 RBuf iChannelDescription; |
|
248 /** |
|
249 * Channel Description. |
|
250 */ |
|
251 RBuf iImageUrl; |
|
252 /** |
|
253 * Channel Id. |
|
254 */ |
|
255 TInt iChannelId; |
|
256 |
|
257 /** |
|
258 * Channel bitrate. |
|
259 */ |
|
260 TInt iBitrate; |
|
261 |
|
262 /** |
|
263 * Channel's MusicStoreStatus. |
|
264 */ |
|
265 RBuf iMusicStoreStatus; |
|
266 |
|
267 }; |
|
268 |
|
269 #endif // C_CIRSONGHISTORYINFO_H |