mmmw_plat/telephony_multimedia_service_api/inc/tmsbuffer.h
branchRCL_3
changeset 12 2eb3b066cc7d
parent 0 71ca22bcf22a
equal deleted inserted replaced
11:3570217d8c21 12:2eb3b066cc7d
    33  *
    33  *
    34  */
    34  */
    35 class TMSBuffer
    35 class TMSBuffer
    36     {
    36     {
    37 public:
    37 public:
       
    38     /*
       
    39      * Destructor
       
    40      */
       
    41     virtual ~TMSBuffer() {}
       
    42 
    38     /**
    43     /**
    39      * Return buffer type.
    44      * Return buffer type.
    40      *
    45      *
    41      * @param  buftype
    46      * @param  buftype
    42      *      Type of the buffer object (TMS_BUFFER_MEMORY).
    47      *      Type of the buffer object (TMS_BUFFER_MEMORY).
    43      *
    48      *
    44      * @return
    49      * @return
    45      *      TMS_RESULT_SUCCESS if the operation was successful.
    50      *      TMS_RESULT_SUCCESS if the operation was successful otherwise
       
    51      *      system error.
    46      *
    52      *
    47      */
    53      */
    48     virtual gint GetType(TMSBufferType& buftype) = 0;
    54     virtual gint GetType(TMSBufferType& buftype) = 0;
    49 
    55 
    50     /**
    56     /**
    54      *
    60      *
    55      * @param  ts
    61      * @param  ts
    56      *      Time stamp in microseconds.
    62      *      Time stamp in microseconds.
    57      *
    63      *
    58      * @return
    64      * @return
    59      *      TMS_RESULT_SUCCESS if the operation was successful.
    65      *      TMS_RESULT_SUCCESS if the operation was successful otherwise
       
    66      *      system error.
    60      *
    67      *
    61      */
    68      */
    62     virtual gint GetTimeStamp(guint64& ts) = 0;
    69     virtual gint GetTimeStamp(guint64& ts) = 0;
    63 
    70 
    64     /**
    71     /**
    68      *
    75      *
    69      * @param  ts
    76      * @param  ts
    70      *      Time stamp in microseconds.
    77      *      Time stamp in microseconds.
    71      *
    78      *
    72      * @return
    79      * @return
    73      *      TMS_RESULT_SUCCESS if the operation was successful.
    80      *      TMS_RESULT_SUCCESS if the operation was successful otherwise
       
    81      *      system error.
    74      *
    82      *
    75      */
    83      */
    76     virtual gint SetTimeStamp(const guint64 ts) = 0;
    84     virtual gint SetTimeStamp(const guint64 ts) = 0;
    77 
    85 
    78     /**
    86     /**
    80      *
    88      *
    81      * @param  size
    89      * @param  size
    82      *      Size of data in the buffer.
    90      *      Size of data in the buffer.
    83      *
    91      *
    84      * @return
    92      * @return
    85      *      TMS_RESULT_SUCCESS if the operation was successful.
    93      *      TMS_RESULT_SUCCESS if the operation was successful otherwise
       
    94      *      system error.
    86      *
    95      *
    87      */
    96      */
    88     virtual gint GetDataSize(guint& size) = 0;
    97     virtual gint GetDataSize(guint& size) = 0;
    89 
    98 
    90     /**
    99     /**
    92      *
   101      *
    93      * @param  size
   102      * @param  size
    94      *      Size of data in the buffer.
   103      *      Size of data in the buffer.
    95      *
   104      *
    96      * @return
   105      * @return
    97      *      TMS_RESULT_SUCCESS if the operation was successful.
   106      *      TMS_RESULT_SUCCESS if the operation was successful otherwise
       
   107      *      system error.
    98      *
   108      *
    99      */
   109      */
   100     virtual gint SetDataSize(const guint size) = 0;
   110     virtual gint SetDataSize(const guint size) = 0;
   101 
   111 
   102     /**
   112     /**
   105      *
   115      *
   106      * @param  bufptr
   116      * @param  bufptr
   107      *      Pointer to the data stored in the buffer.
   117      *      Pointer to the data stored in the buffer.
   108      *
   118      *
   109      * @return
   119      * @return
   110      *      TMS_RESULT_SUCCESS if the operation was successful.
   120      *      TMS_RESULT_SUCCESS if the operation was successful otherwise
       
   121      *      system error.
   111      *
   122      *
   112      */
   123      */
   113     virtual gint GetDataPtr(guint8*& bufptr) = 0;
   124     virtual gint GetDataPtr(guint8*& bufptr) = 0;
   114     };
   125     };
   115 
   126