mmmw_plat/voip_audio_services_api/inc/voipdatabuffer.h
changeset 0 71ca22bcf22a
child 3 4f62049db6ac
equal deleted inserted replaced
-1:000000000000 0:71ca22bcf22a
       
     1 /*
       
     2 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Defines buffer type for VoIP data streaming.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef __VOIPDATABUFFER_H
       
    20 #define __VOIPDATABUFFER_H
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 
       
    25 // FORWARD DECLARATIONS
       
    26 class CVoIPDataBufferImpl;
       
    27 class CVoIPJBDataBufferImpl;
       
    28 
       
    29 
       
    30 /**
       
    31  *  CVoIPDataBuffer
       
    32  *  ?description
       
    33  *  @since S60 v5.0
       
    34  */
       
    35 class CVoIPDataBuffer
       
    36     {
       
    37 public:
       
    38     /**
       
    39     * Buffer types
       
    40     */
       
    41     enum TVoIPBufferType
       
    42         {
       
    43         EStandard,
       
    44         EJitterBuffer
       
    45         };
       
    46 
       
    47 public:
       
    48     /**
       
    49      * Destructor
       
    50      *
       
    51      * @since S60 v5.0
       
    52      * @param none
       
    53      * @return none
       
    54      */
       
    55     IMPORT_C virtual ~CVoIPDataBuffer();
       
    56 
       
    57     /**
       
    58      * SetPayloadPtr
       
    59      *
       
    60      * @since S60 v5.0
       
    61      * @param TPtr8
       
    62      * @return none
       
    63      */
       
    64     IMPORT_C void SetPayloadPtr(TPtr8 aPayloadPtr);
       
    65 
       
    66     /**
       
    67      * GetPayloadPtr
       
    68      *
       
    69      * @since S60 v5.0
       
    70      * @param TPtr8&
       
    71      * @return none
       
    72      */
       
    73     IMPORT_C void GetPayloadPtr(TPtr8& aPayloadPtr);
       
    74 
       
    75     /**
       
    76      * GetBufferType
       
    77      *
       
    78      * @since S60 v5.0
       
    79      * @param TVoIPBufferType&
       
    80      * @return none
       
    81      */
       
    82     IMPORT_C void GetBufferType(TVoIPBufferType& aType);
       
    83 
       
    84 protected:
       
    85     /**
       
    86      * Constructor
       
    87      *
       
    88      * @since S60 v5.0
       
    89      * @param none
       
    90      * @return none
       
    91      */
       
    92     CVoIPDataBuffer();
       
    93 
       
    94     /**
       
    95      * 2nd phase constructor
       
    96      *
       
    97      * @since S60 v5.0
       
    98      * @param CVoIPDataBufferImpl*
       
    99      * @return void
       
   100      */
       
   101     void ConstructL(CVoIPDataBufferImpl* aVoIPDataBufferImpl);
       
   102 
       
   103 private:
       
   104     CVoIPDataBufferImpl* iVoIPDataBufferImpl;
       
   105 
       
   106     };
       
   107 
       
   108 
       
   109 /**
       
   110  *  CVoIPJBDataBuffer
       
   111  *  ?description
       
   112  *  @since S60 v5.0
       
   113  */
       
   114 class CVoIPJBDataBuffer : public CVoIPDataBuffer
       
   115     {
       
   116 public:
       
   117     /**
       
   118      * Destructor
       
   119      *
       
   120      * @since S60 v5.0
       
   121      * @param none
       
   122      * @return none
       
   123      */
       
   124     IMPORT_C virtual ~CVoIPJBDataBuffer();
       
   125 
       
   126     /**
       
   127      * SetBufferSequence
       
   128      *
       
   129      * @since S60 v5.0
       
   130      * @param const TUint - between 0 and 0xFFFF
       
   131      * @return none
       
   132      */
       
   133     IMPORT_C void SetBufferSequence(const TUint aBufferSeq);
       
   134 
       
   135     /**
       
   136      * GetBufferSequence
       
   137      *
       
   138      * @since S60 v5.0
       
   139      * @param TUint& - between 0 and 0xFFFF
       
   140      * @return none
       
   141      */
       
   142     IMPORT_C void GetBufferSequence(TUint& aBufferSeq);
       
   143 
       
   144 protected:
       
   145     /**
       
   146      * Constructor
       
   147      *
       
   148      * @since S60 v5.0
       
   149      * @param none
       
   150      * @return none
       
   151      */
       
   152     CVoIPJBDataBuffer();
       
   153 
       
   154     /**
       
   155      * 2nd phase constructor
       
   156      *
       
   157      * @since S60 v5.0
       
   158      * @param CVoIPJBDataBufferImpl*
       
   159      * @return void
       
   160      */
       
   161     void ConstructL(CVoIPJBDataBufferImpl* aVoIPJBDataBufferImpl);
       
   162 
       
   163 private:
       
   164     CVoIPJBDataBufferImpl* iVoIPJBDataBufferImpl;
       
   165 
       
   166     };
       
   167 
       
   168 #endif //__VOIPDATABUFFER_H
       
   169 
       
   170 
       
   171 // End of file