phoneengine/audiohandling/inc/cpeaudiotoneutilityimpl.h
changeset 0 5f000ab63145
equal deleted inserted replaced
-1:000000000000 0:5f000ab63145
       
     1 /*
       
     2 * Copyright (c) 2008-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:  Implements CPEAudioToneUtility interface
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef CPEAUDIOTONEUTILITYIMPL_H
       
    19 #define CPEAUDIOTONEUTILITYIMPL_H
       
    20 
       
    21 #include <e32base.h>
       
    22 
       
    23 #include "cpeaudiotoneutility.h"
       
    24 
       
    25 class MMdaAudioToneObserver;
       
    26 class CMdaAudioToneUtility;
       
    27 
       
    28 /**
       
    29  *  Wraps CMdaAudioToneUtility.
       
    30  *  To ease module testing.
       
    31  *
       
    32  *  @lib AudioHandling
       
    33  *  @since S60 v5.0
       
    34  */
       
    35 NONSHARABLE_CLASS( CPEAudioToneUtilityImpl ) : public CPEAudioToneUtility
       
    36     {
       
    37 public:
       
    38 
       
    39     static CPEAudioToneUtilityImpl* NewL(
       
    40         MMdaAudioToneObserver& aToneObserver );  
       
    41 
       
    42     /**
       
    43     * Destructor.
       
    44     */
       
    45     virtual ~CPEAudioToneUtilityImpl();
       
    46 
       
    47 // from base class CPEAudioToneUtility
       
    48 
       
    49     /**
       
    50      * From CPEAudioToneUtility
       
    51      * @see CMdaAudioToneUtility
       
    52      *
       
    53      * @since S60 5.0
       
    54      */
       
    55     void PrepareToPlayDesSequence( const TDesC8& aSequence );
       
    56     
       
    57     /**
       
    58      * From CPEAudioToneUtility
       
    59      * @see CMdaAudioToneUtility
       
    60      *
       
    61      * @since S60 5.0
       
    62      */
       
    63     TMdaAudioToneUtilityState State();
       
    64     
       
    65     /**
       
    66      * From CPEAudioToneUtility
       
    67      * @see CMdaAudioToneUtility
       
    68      *
       
    69      * @since S60 5.0
       
    70      */
       
    71     void CancelPlay();
       
    72      
       
    73      /**
       
    74      * From CPEAudioToneUtility
       
    75      * @see CMdaAudioToneUtility
       
    76      *
       
    77      * @since S60 5.0
       
    78      */
       
    79     TInt MaxVolume();
       
    80     
       
    81      /**
       
    82      * From CPEAudioToneUtility
       
    83      * @see CMdaAudioToneUtility
       
    84      *
       
    85      * @since S60 5.0
       
    86      */
       
    87     void SetVolume( TInt aVolume );
       
    88      
       
    89      /**
       
    90      * From CPEAudioToneUtility
       
    91      * @see CMdaAudioToneUtility
       
    92      *
       
    93      * @since S60 5.0
       
    94      */
       
    95     void SetRepeats(
       
    96         TInt aRepeatNumberOfTimes, 
       
    97         const TTimeIntervalMicroSeconds& aTrailingSilence );
       
    98         
       
    99     /**
       
   100      * From CPEAudioToneUtility
       
   101      * @see CMdaAudioToneUtility
       
   102      *
       
   103      * @since S60 5.0
       
   104      */
       
   105     void SetPriority(
       
   106         TInt aPriority, 
       
   107         TMdaPriorityPreference aPref);
       
   108     
       
   109     /**
       
   110      * From CPEAudioToneUtility
       
   111      * @see CMdaAudioToneUtility
       
   112      *
       
   113      * @since S60 5.0
       
   114      */
       
   115     void SetVolumeRamp( 
       
   116         const TTimeIntervalMicroSeconds& aRampDuration );
       
   117     
       
   118     /**
       
   119      * From CPEAudioToneUtility
       
   120      * @see CMdaAudioToneUtility
       
   121      *
       
   122      * @since S60 5.0
       
   123      */
       
   124     void Play();
       
   125     
       
   126     /**
       
   127      * From CPEAudioToneUtility
       
   128      * @see CMdaAudioToneUtility
       
   129      */
       
   130     void CancelPrepare();
       
   131     
       
   132 private:
       
   133 
       
   134     CPEAudioToneUtilityImpl();
       
   135 
       
   136     void ConstructL( MMdaAudioToneObserver& aToneObserver );
       
   137 
       
   138 private: // data
       
   139 
       
   140     /**
       
   141      * Own.
       
   142      * For playing tones.
       
   143      */
       
   144     CMdaAudioToneUtility* iToneUtility;
       
   145 
       
   146     };
       
   147 
       
   148 #endif // CPEAUDIOTONEUTILITYIMPL_H