example/clientapi/smf/inc/common/smfmusic/smfsubtitle.h
changeset 1 4b1e636e8a71
child 2 86af6c333601
equal deleted inserted replaced
0:5d2360e70d9f 1:4b1e636e8a71
       
     1 /**
       
     2  * @file	smfsubtitle.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 "{License}" 
       
    12  * which accompanies  this distribution, and is available 
       
    13  * at the URL "{LicenseUrl}".
       
    14  * 
       
    15  * @section DESCRIPTION
       
    16  *
       
    17  * The subtitle class represents information about a track's subtitle
       
    18  */
       
    19 
       
    20 #ifndef SMFSUBTITLE_H_
       
    21 #define SMFSUBTITLE_H_
       
    22 
       
    23 #include <QObject>
       
    24 #include <qdatastream.h>
       
    25 #include <QDateTime>
       
    26 #include "SmfClientGlobal.h"
       
    27 /**
       
    28  * The subtitle class represents information about a track's subtitle
       
    29  */
       
    30 class SMFCLIENT_EXPORT SmfSubtitle : public QObject
       
    31 	{
       
    32 	Q_OBJECT
       
    33 public:
       
    34 	/**
       
    35 	 * Constructor with default argument
       
    36 	 * @param aParent The parent object
       
    37 	 */
       
    38 	SmfSubtitle( QObject *aParent = 0 );
       
    39 	
       
    40 	/**
       
    41 	 * Destructor
       
    42 	 */
       
    43 	~SmfSubtitle( );
       
    44 	
       
    45 
       
    46 	/**
       
    47 	 * Method to get the subtitle as a bytearray
       
    48 	 * @param aSubTitle The subtitle content
       
    49 	 */
       
    50 	void getSubtitle( QByteArray &aSubTitle );
       
    51 	
       
    52 	/**
       
    53 	 * Method to get the language
       
    54 	 * @param aLanguage The language
       
    55 	 */
       
    56 	void getLanguage( QString &aLanguage );
       
    57 	
       
    58 	/**
       
    59 	 * Method to get the frame rate
       
    60 	 * @return the frame rate
       
    61 	 */
       
    62 	double getFrameRate( );
       
    63 	
       
    64 	/**
       
    65 	 * Method to get the duration
       
    66 	 * @return the duration
       
    67 	 */
       
    68 	double getDuration( );
       
    69 	
       
    70 	/**
       
    71 	 * Method to get the release year
       
    72 	 * @param aRelYear The release year
       
    73 	 */
       
    74 	void getReleaseYear( QDateTime &aRelYear );
       
    75 	
       
    76 	/**
       
    77 	 * Method to get the id of the subtitle
       
    78 	 * @param aId The ID value 
       
    79 	 */
       
    80 	void getId( QString &aId );
       
    81 	
       
    82 private:
       
    83 	QByteArray m_subtitle;	// subtitle data
       
    84 	QString m_language;		// language
       
    85 	double m_frameRate;		// frame rate
       
    86 	double m_duration;		// duration
       
    87 	QDateTime m_releaseYr;	// release year
       
    88 	QString m_subtitleId;	// subtitle id
       
    89 	};
       
    90 /**
       
    91  * Externalization
       
    92  */
       
    93 QDataStream &operator<<(QDataStream &, const SmfSubtitle&);
       
    94 	/**
       
    95 	 * Internalization
       
    96 	 */
       
    97 QDataStream &operator>>(QDataStream &, SmfSubtitle&);
       
    98 #endif /* SMFSUBTITLE_H_ */