mmappfw_plat/qt_telephony_multimedia_service_api/inc/qtmsbuffer.h
changeset 44 d141fc1ad77b
parent 32 edd273b3192a
child 50 762d760dcfdf
equal deleted inserted replaced
43:7b58e65d61ee 44:d141fc1ad77b
    17 
    17 
    18 #ifndef QTMS_BUFFER_H
    18 #ifndef QTMS_BUFFER_H
    19 #define QTMS_BUFFER_H
    19 #define QTMS_BUFFER_H
    20 
    20 
    21 #include <qtms.h>
    21 #include <qtms.h>
    22 #include <QObject>
       
    23 
    22 
    24 namespace QTMS {
    23 namespace QTMS {
    25 
    24 
    26 /**
    25 /**
    27  * QTMSBuffer class
    26  * QTMSBuffer class
    31  * buffer from the factory.
    30  * buffer from the factory.
    32  *
    31  *
    33  * @lib QTMSapi.lib
    32  * @lib QTMSapi.lib
    34  *
    33  *
    35  */
    34  */
    36 class QTMSBuffer : public QObject
    35 class QTMSBuffer
    37     {
    36     {
    38     Q_OBJECT
       
    39 public:
    37 public:
       
    38     /*
       
    39      * Destructor
       
    40      */
       
    41     virtual ~QTMSBuffer() {}
       
    42 
    40     /**
    43     /**
    41      * Return buffer type.
    44      * Return buffer type.
    42      *
    45      *
    43      * @param  buftype
    46      * @param  buftype
    44      *      Type of the buffer object (QTMS_BUFFER_MEMORY).
    47      *      Type of the buffer object (QTMS_BUFFER_MEMORY).
    45      *
    48      *
    46      * @return
    49      * @return
    47      *      QTMS_RESULT_SUCCESS if the operation was successful.
    50      *      QTMS_RESULT_SUCCESS if the operation was successful otherwise
       
    51      *      system error.
    48      *
    52      *
    49      */
    53      */
    50     virtual gint GetType(QTMSBufferType& buftype) = 0;
    54     virtual gint GetType(QTMSBufferType& buftype) = 0;
    51 
    55 
    52     /**
    56     /**
    56      *
    60      *
    57      * @param  ts
    61      * @param  ts
    58      *      Time stamp in microseconds.
    62      *      Time stamp in microseconds.
    59      *
    63      *
    60      * @return
    64      * @return
    61      *      QTMS_RESULT_SUCCESS if the operation was successful.
    65      *      QTMS_RESULT_SUCCESS if the operation was successful otherwise
       
    66      *      system error.
    62      *
    67      *
    63      */
    68      */
    64     virtual gint GetTimeStamp(guint64& ts) = 0;
    69     virtual gint GetTimeStamp(guint64& ts) = 0;
    65 
    70 
    66     /**
    71     /**
    70      *
    75      *
    71      * @param  ts
    76      * @param  ts
    72      *      Time stamp in microseconds.
    77      *      Time stamp in microseconds.
    73      *
    78      *
    74      * @return
    79      * @return
    75      *      QTMS_RESULT_SUCCESS if the operation was successful.
    80      *      QTMS_RESULT_SUCCESS if the operation was successful otherwise
       
    81      *      system error.
    76      *
    82      *
    77      */
    83      */
    78     virtual gint SetTimeStamp(const guint64 ts) = 0;
    84     virtual gint SetTimeStamp(const guint64 ts) = 0;
    79 
    85 
    80     /**
    86     /**
    82      *
    88      *
    83      * @param  size
    89      * @param  size
    84      *      Size of data in the buffer.
    90      *      Size of data in the buffer.
    85      *
    91      *
    86      * @return
    92      * @return
    87      *      QTMS_RESULT_SUCCESS if the operation was successful.
    93      *      QTMS_RESULT_SUCCESS if the operation was successful otherwise
       
    94      *      system error.
    88      *
    95      *
    89      */
    96      */
    90     virtual gint GetDataSize(guint& size) = 0;
    97     virtual gint GetDataSize(guint& size) = 0;
    91 
    98 
    92     /**
    99     /**
    94      *
   101      *
    95      * @param  size
   102      * @param  size
    96      *      Size of data in the buffer.
   103      *      Size of data in the buffer.
    97      *
   104      *
    98      * @return
   105      * @return
    99      *      QTMS_RESULT_SUCCESS if the operation was successful.
   106      *      QTMS_RESULT_SUCCESS if the operation was successful otherwise
       
   107      *      system error.
   100      *
   108      *
   101      */
   109      */
   102     virtual gint SetDataSize(const guint size) = 0;
   110     virtual gint SetDataSize(const guint size) = 0;
   103 
   111 
   104     /**
   112     /**
   107      *
   115      *
   108      * @param  bufptr
   116      * @param  bufptr
   109      *      Pointer to the data stored in the buffer.
   117      *      Pointer to the data stored in the buffer.
   110      *
   118      *
   111      * @return
   119      * @return
   112      *      QTMS_RESULT_SUCCESS if the operation was successful.
   120      *      QTMS_RESULT_SUCCESS if the operation was successful otherwise
       
   121      *      system error.
   113      *
   122      *
   114      */
   123      */
   115     virtual gint GetDataPtr(guint8*& bufptr) = 0;
   124     virtual gint GetDataPtr(guint8*& bufptr) = 0;
   116     };
   125     };
   117 
   126