smf/smfservermodule/smfserver/smfplugins/smflyricsserviceplugin.h
changeset 25 a180113055cb
parent 14 a469c0e6e7fb
equal deleted inserted replaced
24:1cee9f1b95e0 25:a180113055cb
    44 	virtual ~SmfLyricsServicePlugin( ) {}
    44 	virtual ~SmfLyricsServicePlugin( ) {}
    45 	
    45 	
    46 	/**
    46 	/**
    47 	 * Method to get the lyrics
    47 	 * Method to get the lyrics
    48 	 * @param aRequest [out] The request data to be sent to network
    48 	 * @param aRequest [out] The request data to be sent to network
    49 	 * @param aTrack The track whose lyrics need to be fetched
    49 	 * @param aTrack [in] The track whose lyrics need to be fetched
    50 	 * @param aPageNum The page to be extracted
    50 	 * @param aPageNum [in] The page to be extracted
    51 	 * @param aItemsPerPage Number of items per page
    51 	 * @param aItemsPerPage [in] Number of items per page
    52 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
    52 	 * @return Appropriate value of the enum SmfPluginError.
       
    53 	 * Plugin error if any, else SmfPluginErrNone for success
    53 	 */
    54 	 */
    54 	virtual SmfPluginError lyrics( SmfPluginRequestData &aRequest, 
    55 	virtual SmfPluginError lyrics( SmfPluginRequestData &aRequest, 
    55 			const SmfTrackInfo &aTrack,
    56 			const SmfTrackInfo &aTrack,
    56 			const int aPageNum = SMF_FIRST_PAGE, 
    57 			const int aPageNum = SMF_FIRST_PAGE, 
    57 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    58 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    58 	
    59 	
    59 	/**
    60 	/**
    60 	 * Method to get the subtitle
    61 	 * Method to get the subtitle
    61 	 * @param aRequest [out] The request data to be sent to network
    62 	 * @param aRequest [out] The request data to be sent to network
    62 	 * @param aTrack The track whose subtitle need to be fetched
    63 	 * @param aTrack [in] The track whose subtitle need to be fetched
    63 	 * @param aFilter The subtitle search filter if any
    64 	 * @param aFilter [in] The subtitle search filter if any
    64 	 * @param aPageNum The page to be extracted
    65 	 * @param aPageNum [in] The page to be extracted
    65 	 * @param aItemsPerPage Number of items per page
    66 	 * @param aItemsPerPage [in] Number of items per page
    66 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
    67 	 * @return Appropriate value of the enum SmfPluginError.
       
    68 	 * Plugin error if any, else SmfPluginErrNone for success
    67 	 */
    69 	 */
    68 	virtual SmfPluginError subtitles( SmfPluginRequestData &aRequest, 
    70 	virtual SmfPluginError subtitles( SmfPluginRequestData &aRequest, 
    69 			const SmfTrackInfo &aTrack,
    71 			const SmfTrackInfo &aTrack,
    70 			const SmfSubtitleSearchFilter &aFilter = SubtitleAll,
    72 			const SmfSubtitleSearchFilter &aFilter = SubtitleAll,
    71 			const int aPageNum = SMF_FIRST_PAGE, 
    73 			const int aPageNum = SMF_FIRST_PAGE, 
    72 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    74 			const int aItemsPerPage = SMF_ITEMS_PER_PAGE ) = 0;
    73 	
    75 	
    74 	/**
    76 	/**
    75 	 * Customised method for SmfLyricsServicePlugin interface
    77 	 * Customised method for SmfLyricsServicePlugin interface
    76 	 * @param aRequest [out] The request data to be sent to network
    78 	 * @param aRequest [out] The request data to be sent to network
    77 	 * @param aOperation The operation type (should be known between 
    79 	 * @param aOperation [in] The operation type (should be known between 
    78 	 * the client interface and the plugin)
    80 	 * the client interface and the plugin)
    79 	 * @param aData The data required to form the request (The type 
    81 	 * @param aData [in] The data required to form the request (The type 
    80 	 * of data should be known between client and the plugin)
    82 	 * of data should be known between client and the plugin)
    81 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone
    83 	 * @return Appropriate value of the enum SmfPluginError.
       
    84 	 * Plugin error if any, else SmfPluginErrNone for success
    82 	 */
    85 	 */
    83 	virtual SmfPluginError customRequest( SmfPluginRequestData &aRequest, 
    86 	virtual SmfPluginError customRequest( SmfPluginRequestData &aRequest, 
    84 			const int &aOperation, QByteArray *aData ) = 0;
    87 			const int &aOperation, QByteArray *aData ) = 0;
    85 	
    88 	
    86 	};
    89 	};