internetradio2.0/irsonghistory/inc/irsonghistoryinfo.h
changeset 17 38bbf2dcd608
parent 16 5723da102db1
equal deleted inserted replaced
16:5723da102db1 17:38bbf2dcd608
     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 SetHistoryInfoL(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& aGenreName,
       
    69                                      RBuf& aCountryName,
       
    70                                      RBuf& aLanguageName,									 
       
    71 									 RBuf& aMusicStoreStatus );
       
    72 
       
    73 	/**
       
    74 	*CIRSongHistoryInfo::SetChannelNameL()
       
    75 	*Function to set channel name from a RBuf
       
    76 	*@param RBuf aChannelName
       
    77 	*/
       
    78 
       
    79 		void SetChannelNameL(RBuf& aChannelName);
       
    80 
       
    81 	/**
       
    82 	*CIRSongHistoryInfo::SetArtistL()
       
    83 	*Function to set artist name from a RBuf
       
    84 	*@param RBuf aArtist
       
    85 	*/
       
    86 
       
    87 		void SetArtistL(RBuf& aArtist);
       
    88 
       
    89 	/**
       
    90 	*CIRSongHistoryInfo::SetSongNameL()
       
    91 	*Function to set song name from a RBuf
       
    92 	*@param RBuf aSongName
       
    93 	*/
       
    94 
       
    95   		void SetSongNameL (RBuf& aSongName);
       
    96 
       
    97 	/**
       
    98 	*CIRSongHistoryInfo::SetStreamUrlL()
       
    99 	*Function to set stream url from a RBuf
       
   100 	*@param RBuf aStreamUrl
       
   101 	*/
       
   102 
       
   103 		void SetStreamUrlL(RBuf& aStreamUrl);
       
   104 
       
   105 	/**
       
   106 	*CIRSongHistoryInfo::GetSongInfo()
       
   107 	*Function to get song name from a TDesC
       
   108 	*@return RBuf& instance 
       
   109 	*/
       
   110 
       
   111 		IMPORT_C const RBuf& GetSongInfo() const;
       
   112 
       
   113 	/**
       
   114 	*CIRSongHistoryInfo::GetArtistName()
       
   115 	*Function to get artist name from a TDesC
       
   116 	*@return RBuf& instance
       
   117 	*/
       
   118 
       
   119 		IMPORT_C const RBuf& GetArtistInfo() const;
       
   120 
       
   121 	/**
       
   122 	*CIRSongHistoryInfo::GetStreamUrl()
       
   123 	*Function to get url name from a TDesC
       
   124 	*@return RBuf& instance
       
   125 	*/
       
   126 
       
   127 		 IMPORT_C const RBuf& GetStreamUrl() const;
       
   128 
       
   129 	/**
       
   130 	*CIRSongHistoryInfo::GetChannelName()
       
   131 	*Function to get channel name from a TDesC
       
   132 	*@return RBuf& instance
       
   133 	*/
       
   134 
       
   135 		IMPORT_C const RBuf& GetChannelName() const;
       
   136 		
       
   137 	/**
       
   138 	*CIRSongHistoryInfo::GetChannelType()
       
   139 	*Function to get channel Type
       
   140 	*@return TInt channeltype
       
   141 	*/
       
   142 	    IMPORT_C  TInt GetChannelType() const;
       
   143 	    
       
   144 	/**
       
   145 	*CIRSongHistoryInfo::SetChannelType()
       
   146 	*Function to set channel Type
       
   147 	*@param TInt aChannelImgUrl
       
   148 	*/
       
   149 	    void SetChannelType(TInt aChannelImgUrl);
       
   150 	/**
       
   151 	*CIRSongHistoryInfo::SetChannelId()
       
   152 	*Function to set channel Id
       
   153 	*@param TInt aChannelId
       
   154 	*/
       
   155 	    void SetChannelId(TInt aChannelId);
       
   156 	/**
       
   157 	*CIRSongHistoryInfo::GetChannelId()
       
   158 	*Function to get channel Id
       
   159 	*@return TInt channelId
       
   160 	*/
       
   161 	    IMPORT_C  TInt GetChannelId() const;
       
   162 	/**
       
   163 	*CIRSongHistoryInfo::SetBitrate()
       
   164 	*Function to set bitrate
       
   165 	*@param TInt aBitrate
       
   166 	*/
       
   167         void SetBitrate(TInt aBitrate);
       
   168     /**
       
   169     *CIRSongHistoryInfo::GetBitrate()
       
   170     *Function to get bitrate
       
   171     *@return TInt aBitrate
       
   172     */
       
   173         IMPORT_C  TInt GetBitrate() const;
       
   174 	/**
       
   175 	*CIRSongHistoryInfo::GetChannelDesc()
       
   176 	*Function to get channel Description
       
   177 	*@return RBuf& instance
       
   178 	*/
       
   179         IMPORT_C const RBuf& GetChannelDesc() const ;
       
   180 	/**
       
   181 	*CIRSongHistoryInfo::SetChannelDescL()
       
   182 	*Function to set channel Description
       
   183 	* @param RBuf aChannelDesc
       
   184 	*/
       
   185         void SetChannelDescL(RBuf& aChannelDesc) ;
       
   186     /**
       
   187     *CIRSongHistoryInfo::GetImageUrl()
       
   188     *Function to get channel image Url
       
   189     *@return RBuf& instance
       
   190     */
       
   191         IMPORT_C const RBuf& GetImageUrl() const ;
       
   192     /**
       
   193     *CIRSongHistoryInfo::SetImageUrlL()
       
   194     *Function to set channel image Url
       
   195     * @param RBuf aImageUrl
       
   196     */        
       
   197         void SetImageUrlL(RBuf& aImageUrl) ;
       
   198     /**
       
   199     *IRQSongHistoryInfo::GetGenreName()
       
   200     *Function to get channel genre name
       
   201     *@return RBuf& instance
       
   202     */
       
   203         IMPORT_C const RBuf& GetGenreName() const;
       
   204     /**
       
   205     *CIRSongHistoryInfo::SetGenreNameL()
       
   206     *Function to set channel genre name
       
   207     * @param RBuf aGenreName
       
   208     */        
       
   209         void SetGenreNameL(const RBuf& aGenreName);
       
   210     /**
       
   211     *IRQSongHistoryInfo::GetCountryName()
       
   212     *Function to get channel country name
       
   213     *@return RBuf& instance
       
   214     */
       
   215         IMPORT_C const RBuf& GetCountryName() const;
       
   216     /**
       
   217     *CIRSongHistoryInfo::SetCountryNameL()
       
   218     *Function to set channel country name
       
   219     * @param RBuf& aCountryName
       
   220     */        
       
   221         void SetCountryNameL(const RBuf& aCountryName);
       
   222     /**
       
   223     *IRQSongHistoryInfo::getLanguageName()
       
   224     *Function to get channel language name
       
   225     *@return RBuf& instance
       
   226     */
       
   227         IMPORT_C const RBuf& GetLanguageName() const;
       
   228     /**
       
   229     *CIRSongHistoryInfo::SetLanguageNameL()
       
   230     *Function to set channel language name
       
   231     * @param RBuf aLanguageName
       
   232     */        
       
   233         void SetLanguageNameL(const RBuf& aLanguageName);        
       
   234 	/**
       
   235 	*CIRSongHistoryInfo::SetChannelMusicStatusL()
       
   236 	*Function to set Channel MusicStoreStatus
       
   237 	*@param RBuf aChannelMusicStatus
       
   238 	*/
       
   239         void SetChannelMusicStatusL(RBuf& aChannelMusicStatus) ;
       
   240 	/**
       
   241 	*CIRSongHistoryInfo::GetChannelMusicStatus()
       
   242 	*Function to get channel MusicStoreStatus
       
   243 	*@return RBuf& instance
       
   244 	*/
       
   245         IMPORT_C const RBuf& GetChannelMusicStatus() const ;
       
   246 private:
       
   247 
       
   248     /**
       
   249      * Default constructor.
       
   250      */
       
   251 
       
   252 		CIRSongHistoryInfo();
       
   253 
       
   254 
       
   255 private: //data
       
   256 
       
   257 	/**
       
   258      * The name of the artist.
       
   259      */
       
   260 		RBuf iArtistInfo;
       
   261 
       
   262     /**
       
   263      * The name of the song.
       
   264      */
       
   265 		RBuf iSongInfo;
       
   266 
       
   267     /**
       
   268      * The stream URL.
       
   269 	 */
       
   270 		RBuf iStreamUrlInfo;
       
   271 
       
   272     /**
       
   273      * Channel Name.
       
   274      */
       
   275 		RBuf iChannelInfo;
       
   276 		
       
   277     /**
       
   278      * Channel Type.
       
   279      */
       
   280 		TInt iChannelType;
       
   281 		
       
   282 		
       
   283     /**
       
   284      * Channel Description.
       
   285      */
       
   286 		RBuf iChannelDescription;
       
   287     /**
       
   288 	 * Channel Description.
       
   289      */
       
   290         RBuf iImageUrl;
       
   291         RBuf iGenreName;
       
   292         RBuf iCountryName;
       
   293         RBuf iLanguageName;
       
   294     /**
       
   295      * Channel Id.
       
   296      */
       
   297 		TInt iChannelId;
       
   298 
       
   299 	/**
       
   300 	 * Channel bitrate.
       
   301 	 */
       
   302 	TInt iBitrate;
       
   303 		
       
   304     /**
       
   305      * Channel's MusicStoreStatus.
       
   306      */
       
   307 		RBuf iMusicStoreStatus;
       
   308 
       
   309     };
       
   310 
       
   311 #endif // C_CIRSONGHISTORYINFO_H