mmserv/tms/tmsserver/inc/tmsaudiotoneutilityimpl.h
changeset 12 5a06f39ad45b
child 20 b67dd1fc57c5
equal deleted inserted replaced
0:71ca22bcf22a 12:5a06f39ad45b
       
     1 /*
       
     2  * Copyright (c) 2009 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: Telephony Multimedia Service
       
    15  *
       
    16  */
       
    17 
       
    18 #ifndef TMSAUDIOTONEUTILITYIMPL_H
       
    19 #define TMSAUDIOTONEUTILITYIMPL_H
       
    20 
       
    21 #include <e32base.h>
       
    22 #include <mdaaudiotoneplayer.h>
       
    23 #include "tmsaudiotoneutility.h"
       
    24 
       
    25 namespace TMS {
       
    26 
       
    27 /**
       
    28  *  Wraps CMdaAudioToneUtility.
       
    29  *  To ease module testing.
       
    30  *
       
    31  *  @lib AudioHandling
       
    32  */
       
    33 class TMSAudioToneUtilityImpl : public TMSAudioToneUtility
       
    34     {
       
    35 public:
       
    36 
       
    37     static TMSAudioToneUtilityImpl* NewL(
       
    38             MMdaAudioToneObserver& aToneObserver);
       
    39 
       
    40     /**
       
    41      * Destructor.
       
    42      */
       
    43     virtual ~TMSAudioToneUtilityImpl();
       
    44 
       
    45     // from base class TMSAudioToneUtilityImpl
       
    46 
       
    47     /**
       
    48      * From TMSAudioToneUtilityImpl
       
    49      * @see CMdaAudioToneUtility
       
    50      */
       
    51     void PrepareToPlayDesSequence(const TDesC8& aSequence);
       
    52 
       
    53     /**
       
    54      * From TMSAudioToneUtilityImpl
       
    55      * @see CMdaAudioToneUtility
       
    56      */
       
    57     TMdaAudioToneUtilityState State();
       
    58 
       
    59     /**
       
    60      * From TMSAudioToneUtilityImpl
       
    61      * @see CMdaAudioToneUtility
       
    62      */
       
    63     void CancelPlay();
       
    64 
       
    65     /**
       
    66      * From TMSAudioToneUtilityImpl
       
    67      * @see CMdaAudioToneUtility
       
    68      */
       
    69     TInt MaxVolume();
       
    70 
       
    71     /**
       
    72      * From TMSAudioToneUtilityImpl
       
    73      * @see CMdaAudioToneUtility
       
    74      */
       
    75     void SetVolume(TInt aVolume);
       
    76 
       
    77     /**
       
    78      * From TMSAudioToneUtilityImpl
       
    79      * @see CMdaAudioToneUtility
       
    80      */
       
    81     void SetRepeats(TInt aRepeatNumberOfTimes,
       
    82             const TTimeIntervalMicroSeconds& aTrailingSilence);
       
    83 
       
    84     /**
       
    85      * From TMSAudioToneUtilityImpl
       
    86      * @see CMdaAudioToneUtility
       
    87      */
       
    88     void SetPriority(TInt aPriority, TMdaPriorityPreference aPref);
       
    89 
       
    90     /**
       
    91      * From TMSAudioToneUtilityImpl
       
    92      * @see CMdaAudioToneUtility
       
    93      */
       
    94     void SetVolumeRamp(const TTimeIntervalMicroSeconds& aRampDuration);
       
    95 
       
    96     /**
       
    97      * From TMSAudioToneUtilityImpl
       
    98      * @see CMdaAudioToneUtility
       
    99      */
       
   100     void Play();
       
   101 
       
   102     /**
       
   103      * From TMSAudioToneUtilityImpl
       
   104      * @see CMdaAudioToneUtility
       
   105      */
       
   106     void CancelPrepare();
       
   107 
       
   108 private:
       
   109 
       
   110     TMSAudioToneUtilityImpl();
       
   111 
       
   112     void ConstructL(MMdaAudioToneObserver& aToneObserver);
       
   113 
       
   114 private:
       
   115     // data
       
   116 
       
   117     /**
       
   118      * Own.
       
   119      * For playing tones.
       
   120      */
       
   121     CMdaAudioToneUtility* iToneUtility;
       
   122     };
       
   123 } //namespace TMS
       
   124 
       
   125 #endif // TMSAUDIOTONEUTILITYIMPL_H