1 /*

     2 * Copyright (c) 2002-2004,2007 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:  Interface class for Audiohandling

    15 *

    16 */

    17 

    18 

    19 #ifndef MPEAUDIODATA_H

    20 #define MPEAUDIODATA_H

    21 

    22 //  INCLUDES

    23 #include <pevirtualengine.h>

    24 #include <e32base.h>

    25 

    26 // CONSTANTS

    27 // None.

    28 

    29 // MACROS

    30 // None.

    31 

    32 // DATA TYPES

    33 // None

    34 

    35 // FUNCTION PROTOTYPES

    36 // None.

    37 

    38 // FORWARD DECLARATIONS

    39 // None.

    40 

    41 // CLASS DECLARATION

    42 /**

    43 *  Interface class for audiohandling

    44 *  

    45 *  @lib audiohandling.lib

    46 *  @since S60_5.0

    47 */

    48 class MPEAudioData 

    49     {

    50     public: // New functions

    51         

    52         /**

    53         * Retrieves Audio mute synchronously.

    54         * @param  aAudioMute, audio mute is returned in this parameter.

    55         */

    56         virtual void GetAudioMuteSync( TBool& aAudioMute ) const = 0;

    57 

    58         /**

    59         * Retrieves Audio volume synchronously.

    60         * @param  aAudioVolume, audio volume is returned in this parameter.

    61         */

    62         virtual void GetAudioVolumeSync( TInt& aAudioVolume ) const = 0;

    63       

    64         /**

    65         * Handles call audio route preference changed

    66         */

    67         virtual TInt CallAudioRoutePreferenceChanged() = 0;

    68  

    69         /**

    70         * Stops the playing of dtmf tone

    71         */

    72         virtual void StopDtmfTonePlay() = 0; 

    73 

    74         /**

    75         * Makes synchronous request to set Audio Mute.

    76         * @param  aAudioMute, mute to be set.

    77         */

    78         virtual void SetAudioMuteSync( const TBool aAudioMute ) = 0;

    79 

    80         /**

    81         * Makes synchronous request to set Audio Volume.

    82         * @param  aAudioVolume, volume to be set.

    83         */

    84         virtual void SetAudioVolumeSync( const TInt aAudioVolume ) = 0;

    85         

    86         /**

    87         * Makes request to Telephony Audio Routing to set audio output path

    88         * @param aOutput, audio output path

    89         * @param aShowNote, Show note status

    90         * @return KErrNone or possible errorcode.

    91         */

    92         virtual TInt SetAudioOutput( const TPEAudioOutput aAudioMute,

    93                                      TBool aShowNote ) = 0;

    94         

    95          /**

    96         * Gets volume levels at startup.

    97         */

    98         virtual void StartUp() = 0;

    99         

   100         /**

   101         * Initialises call audio route when call is alerting or answered

   102         */

   103         virtual TInt HandleCallStarting( TBool aVideoCall ) = 0;

   104         

   105         /**

   106         * Initialises energency call audio route

   107         */

   108         virtual TInt HandleEnergencyCallStarting() = 0;

   109         

   110         /**

   111         * Ends call audio route when call disconnected

   112         */

   113         virtual void HandleCallEnding() = 0;

   114 

   115     };

   116 

   117 #endif    // MPEAUDIODATA_H     

   118             

   119 // End of File