mmmw_plat/voip_audio_services_api/inc/voipdownlinkstream.h
branchRCL_3
changeset 3 4f62049db6ac
parent 0 71ca22bcf22a
equal deleted inserted replaced
0:71ca22bcf22a 3:4f62049db6ac
     1 /*
     1 /*
     2 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
     2  * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     3  * All rights reserved.
     4 * This component and the accompanying materials are made available
     4  * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     5  * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6  * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7  * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     8  *
     9 * Initial Contributors:
     9  * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    10  * Nokia Corporation - initial contribution.
    11 *
    11  *
    12 * Contributors:
    12  * Contributors:
    13 *
    13  *
    14 * Description:  Defines VoIP downlink stream APIs.
    14  * Description:  Defines VoIP downlink stream APIs.
    15 *
    15  *
    16 */
    16  */
    17 
       
    18 
    17 
    19 #ifndef __VOIPDOWNLINKSTREAM_H
    18 #ifndef __VOIPDOWNLINKSTREAM_H
    20 #define __VOIPDOWNLINKSTREAM_H
    19 #define __VOIPDOWNLINKSTREAM_H
    21 
    20 
    22 #include <voipaudiocommon.h>
    21 #include <voipaudiocommon.h>
    23 #include <voipdtmftoneplayer.h>
    22 #include <voipdtmftoneplayer.h>
    24 
       
    25 
    23 
    26 // FORWARD DECLARATIONS
    24 // FORWARD DECLARATIONS
    27 class CVoIPAudioDownlinkStream;
    25 class CVoIPAudioDownlinkStream;
    28 class CVoIPAudioDownlinkStreamImpl;
    26 class CVoIPAudioDownlinkStreamImpl;
    29 class CVoIPDataBuffer;
    27 class CVoIPDataBuffer;
    33  *  MVoIPDownlinkObserver class
    31  *  MVoIPDownlinkObserver class
    34  *
    32  *
    35  *  ?more_complete_description
    33  *  ?more_complete_description
    36  *
    34  *
    37  *  @lib VoIPAudioIntfc.dll
    35  *  @lib VoIPAudioIntfc.dll
    38  *  @since S60 v5.0
    36  *
    39  */
    37  */
    40 class MVoIPDownlinkObserver
    38 class MVoIPDownlinkObserver
    41     {
    39     {
    42 public:
    40 public:
    43     static const TUint KOpenComplete       = 1;
    41     static const TUint KOpenComplete = 1;
    44     static const TUint KDownlinkError      = 2;
    42     static const TUint KDownlinkError = 2;
    45     static const TUint KDownlinkClosed     = 3;
    43     static const TUint KDownlinkClosed = 3;
    46     static const TUint KAudioDeviceChanged = 4;
    44     static const TUint KAudioDeviceChanged = 4;
    47 
    45 
    48 public:
    46 public:
    49     /**
    47     /**
    50      * ?description
    48      * ?description
    53      * @param const CVoIPAudioDownlinkStream&
    51      * @param const CVoIPAudioDownlinkStream&
    54      * @param CVoIPDataBuffer*
    52      * @param CVoIPDataBuffer*
    55      * @return void
    53      * @return void
    56      */
    54      */
    57     virtual void FillBuffer(const CVoIPAudioDownlinkStream& aSrc,
    55     virtual void FillBuffer(const CVoIPAudioDownlinkStream& aSrc,
    58                             CVoIPDataBuffer* aBuffer) = 0;
    56             CVoIPDataBuffer* aBuffer) = 0;
    59     /**
    57     /**
    60      * ?description
    58      * ?description
    61      *
    59      *
    62      * @since S60 v5.0
    60      * @since S60 v5.0
    63      * @param const CVoIPAudioDownlinkStream&
    61      * @param const CVoIPAudioDownlinkStream&
    64      * @param TInt - Event type
    62      * @param TInt - Event type
    65      * @param TInt - Status
    63      * @param TInt - Status
    66      * @return void
    64      * @return void
    67      */
    65      */
    68     virtual void Event(const CVoIPAudioDownlinkStream& aSrc,
    66     virtual void Event(const CVoIPAudioDownlinkStream& aSrc, TInt aEventType,
    69                        TInt aEventType,
    67             TInt aError) = 0;
    70                        TInt aError) = 0;
       
    71     };
    68     };
    72 
       
    73 
    69 
    74 /**
    70 /**
    75  *  CVoIPAudioDownlinkStream class
    71  *  CVoIPAudioDownlinkStream class
    76  *
    72  *
    77  *  ?more_complete_description
    73  *  ?more_complete_description
    78  *
    74  *
    79  *  @lib VoIPAudioIntfc.dll
    75  *  @lib VoIPAudioIntfc.dll
    80  *  @since S60 v5.0
    76  *
    81  */
    77  */
    82 class CVoIPAudioDownlinkStream
    78 class CVoIPAudioDownlinkStream
    83     {
    79     {
    84 public:
    80 public:
    85     /**
    81     /**
    86      *  TVoIPOutputDevice
    82      *  TVoIPOutputDevice
    87      *  ?description
    83      *  ?description
    88      *  @since S60 v5.0
    84  *
    89      */
    85      */
    90     enum TVoIPOutputDevice
    86     enum TVoIPOutputDevice
    91         {
    87         {
    92         EHandset,
    88         EHandset,
    93         ELoudSpeaker,
    89         ELoudSpeaker,
   156      * @param TVoIPCodecFormat
   152      * @param TVoIPCodecFormat
   157      * @param CVoIPFormatIntfc*&
   153      * @param CVoIPFormatIntfc*&
   158      * @return TInt
   154      * @return TInt
   159      */
   155      */
   160     IMPORT_C TInt SetFormat(TVoIPCodecFormat aFormat,
   156     IMPORT_C TInt SetFormat(TVoIPCodecFormat aFormat,
   161                             CVoIPFormatIntfc*& aIntfc);
   157             CVoIPFormatIntfc*& aIntfc);
   162 
   158 
   163     /**
   159     /**
   164      * ?description
   160      * ?description
   165      *
   161      *
   166      * @since S60 v5.0
   162      * @since S60 v5.0
   230      *
   226      *
   231      * @since S60 v5.0
   227      * @since S60 v5.0
   232      * @param none
   228      * @param none
   233      * @return TInt
   229      * @return TInt
   234      */
   230      */
   235      void ConstructL(
   231     void ConstructL(
   236           CVoIPAudioDownlinkStreamImpl* aVoIPAudioDownlinkStreamImpl);
   232             CVoIPAudioDownlinkStreamImpl* aVoIPAudioDownlinkStreamImpl);
   237 
   233 
   238 private:
   234 private:
   239     /**
   235     /**
   240      * For internal use only
   236      * For internal use only
   241      */
   237      */
   247 
   243 
   248     };
   244     };
   249 
   245 
   250 #endif //__VOIPDOWNLINKSTREAM_H
   246 #endif //__VOIPDOWNLINKSTREAM_H
   251 
   247 
   252 
       
   253 // End of file
   248 // End of file