1 /**

     2  * @file	smflyricsserviceplugin.h

     3  * @author  Nalina Hariharan, Sasken Communication Technologies Ltd - Initial contribution

     4  * @version 1.0

     5  *

     6  * @section LICENSE

     7  *

     8  * Copyright (c) 2010 Sasken Communication Technologies Ltd. 

     9  * All rights reserved.

    10  * This component and the accompanying materials are made available 

    11  * under the terms of the "Eclipse Public License v1.0"

    12  * which accompanies  this distribution, and is available 

    13  * at the URL "http://www.eclipse.org/legal/epl-v10.html"

    14  * 

    15  * @section DESCRIPTION

    16  *

    17  * Interface specification for music track lyrics

    18  */

    19 

    20 #ifndef SMFLYRICSSERVICEPLUGIN_H_

    21 #define SMFLYRICSSERVICEPLUGIN_H_

    22 

    23 #include <smfpluginbase.h>

    24 #include <smftrackinfo.h>

    25 #include <QString>

    26 #include <smfsubtitle.h>

    27 #include <smflyrics.h>

    28 

    29 /**

    30  * @ingroup smf_plugin_group

    31  * Interface specification for music track lyrics

    32  *

    33  * All of the functionality described here should be implemented by a service

    34  * specific plug-in.

    35  */

    36 class SmfLyricsServicePlugin : public SmfPluginBase

    37 	{

    38 	Q_OBJECT

    39 public:

    40 	/**

    41 	 * Constructor with default argument

    42 	 * @param aParent The parent object

    43 	 */

    44 	SmfLyricsServicePlugin( QObject* aParent = 0 );

    45 	

    46 	/**

    47 	 * Destructor

    48 	 */

    49 	~SmfLyricsServicePlugin( );

    50 	

    51 	/**

    52 	 * Method to get the lyrics

    53 	 * @param aRequest [out] The request data to be sent to network

    54 	 * @param aTrack The track whose lyrics need to be fetched

    55 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone

    56 	 */

    57 	virtual SmfPluginError lyrics( SmfPluginRequestData *aRequest, 

    58 			const SmfTrackInfo aTrack ) = 0;

    59 	

    60 	/**

    61 	 * Method to get the subtitle

    62 	 * @param aRequest [out] The request data to be sent to network

    63 	 * @param aTrack The track whose subtitle need to be fetched

    64 	 * @param aFilter The subtitle search filter if any

    65 	 * @return SmfPluginError Plugin error if any, else SmfPluginErrNone

    66 	 */

    67 	virtual SmfPluginError subtitles( SmfPluginRequestData *aRequest, 

    68 			const SmfTrackInfo aTrack,

    69 			const SmfSubtitleSearchFilter aFilter = SubtitleAll ) = 0;

    70 	

    71 	};

    72 

    73 Q_DECLARE_INTERFACE( SmfLyricsServicePlugin, "org.symbian.smf.plugin.music.lyrics/v1.0" );

    74 

    75 #endif /* SMFLYRICSSERVICEPLUGIN_H_ */