mmserv/tms/tmsserver/inc/tmsaudiotoneutilityimpl.h
branchRCL_3
changeset 19 095bea5f582e
equal deleted inserted replaced
18:a36789189b53 19:095bea5f582e
       
     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 <glib.h>
       
    24 #include "tmsaudiotoneutility.h"
       
    25 
       
    26 namespace TMS {
       
    27 
       
    28 /**
       
    29  *  Wraps CMdaAudioToneUtility.
       
    30  *  To ease module testing.
       
    31  *
       
    32  *  @lib AudioHandling
       
    33  */
       
    34 class TMSAudioToneUtilityImpl : public TMSAudioToneUtility
       
    35     {
       
    36 public:
       
    37 
       
    38     static TMSAudioToneUtilityImpl* NewL(
       
    39             MMdaAudioToneObserver& toneObserver);
       
    40 
       
    41     /**
       
    42      * Destructor.
       
    43      */
       
    44     virtual ~TMSAudioToneUtilityImpl();
       
    45 
       
    46     // from base class TMSAudioToneUtilityImpl
       
    47 
       
    48     /**
       
    49      * From TMSAudioToneUtilityImpl
       
    50      * @see CMdaAudioToneUtility
       
    51      */
       
    52     void PrepareToPlayDesSequence(const TDesC8& sequence);
       
    53 
       
    54     /**
       
    55      * From TMSAudioToneUtilityImpl
       
    56      * @see CMdaAudioToneUtility
       
    57      */
       
    58     TMdaAudioToneUtilityState State();
       
    59 
       
    60     /**
       
    61      * From TMSAudioToneUtilityImpl
       
    62      * @see CMdaAudioToneUtility
       
    63      */
       
    64     void CancelPlay();
       
    65 
       
    66     /**
       
    67      * From TMSAudioToneUtilityImpl
       
    68      * @see CMdaAudioToneUtility
       
    69      */
       
    70     gint MaxVolume();
       
    71 
       
    72     /**
       
    73      * From TMSAudioToneUtilityImpl
       
    74      * @see CMdaAudioToneUtility
       
    75      */
       
    76     void SetVolume(gint volume);
       
    77 
       
    78     /**
       
    79      * From TMSAudioToneUtilityImpl
       
    80      * @see CMdaAudioToneUtility
       
    81      */
       
    82     void SetRepeats(gint repeatNumberOfTimes,
       
    83             const TTimeIntervalMicroSeconds& trailingSilence);
       
    84 
       
    85     /**
       
    86      * From TMSAudioToneUtilityImpl
       
    87      * @see CMdaAudioToneUtility
       
    88      */
       
    89     void SetPriority(gint priority, TMdaPriorityPreference pref);
       
    90 
       
    91     /**
       
    92      * From TMSAudioToneUtilityImpl
       
    93      * @see CMdaAudioToneUtility
       
    94      */
       
    95     void SetVolumeRamp(const TTimeIntervalMicroSeconds& rampDuration);
       
    96 
       
    97     /**
       
    98      * From TMSAudioToneUtilityImpl
       
    99      * @see CMdaAudioToneUtility
       
   100      */
       
   101     void Play();
       
   102 
       
   103     /**
       
   104      * From TMSAudioToneUtilityImpl
       
   105      * @see CMdaAudioToneUtility
       
   106      */
       
   107     void CancelPrepare();
       
   108 
       
   109 private:
       
   110 
       
   111     TMSAudioToneUtilityImpl();
       
   112 
       
   113     void ConstructL(MMdaAudioToneObserver& toneObserver);
       
   114 
       
   115 private:
       
   116     // data
       
   117 
       
   118     /**
       
   119      * Own.
       
   120      * For playing tones.
       
   121      */
       
   122     CMdaAudioToneUtility* iToneUtility;
       
   123     };
       
   124 } //namespace TMS
       
   125 
       
   126 #endif // TMSAUDIOTONEUTILITYIMPL_H