mmserv/tms/tmsserver/inc/tmsaudiotoneutility.h
branchRCL_3
changeset 20 0ac9a5310753
parent 19 095bea5f582e
child 21 999b2818a0eb
equal deleted inserted replaced
19:095bea5f582e 20:0ac9a5310753
     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 TMSAUDIOTONEUTILITY_H
       
    19 #define TMSAUDIOTONEUTILITY_H
       
    20 
       
    21 #include <mdaaudiotoneplayer.h>
       
    22 
       
    23 namespace TMS {
       
    24 
       
    25 /**
       
    26  *  Interface to wrap CMdaAudioToneUtility.
       
    27  *
       
    28  */
       
    29 class TMSAudioToneUtility
       
    30     {
       
    31 public:
       
    32 
       
    33     virtual ~TMSAudioToneUtility() {}
       
    34 
       
    35     /**
       
    36      * See CMdaAudioToneUtility::PrepareToPlayDesSequence.
       
    37      */
       
    38     virtual void PrepareToPlayDesSequence(const TDesC8& aSequence) = 0;
       
    39 
       
    40     /**
       
    41      * See CMdaAudioToneUtility::State.
       
    42      */
       
    43     virtual TMdaAudioToneUtilityState State() = 0;
       
    44 
       
    45     /**
       
    46      * See CMdaAudioToneUtility::CancelPlay.
       
    47      */
       
    48     virtual void CancelPlay() = 0;
       
    49 
       
    50     /**
       
    51      * See CMdaAudioToneUtility::MaxVolume.
       
    52      */
       
    53     virtual TInt MaxVolume() = 0;
       
    54 
       
    55     /**
       
    56      * See CMdaAudioToneUtility::SetVolume.
       
    57      */
       
    58     virtual void SetVolume(TInt aVolume) = 0;
       
    59 
       
    60     /**
       
    61      * See CMdaAudioToneUtility::SetRepeats.
       
    62      */
       
    63     virtual void SetRepeats(TInt aRepeatNumberOfTimes,
       
    64             const TTimeIntervalMicroSeconds& aTrailingSilence) = 0;
       
    65 
       
    66     /**
       
    67      * See CMdaAudioToneUtility::SetPriority.
       
    68      */
       
    69     virtual void SetPriority(TInt aPriority, TMdaPriorityPreference aPref) = 0;
       
    70 
       
    71     /**
       
    72      * See CMdaAudioToneUtility::SetVolumeRamp.
       
    73      */
       
    74     virtual void SetVolumeRamp(
       
    75             const TTimeIntervalMicroSeconds& aRampDuration) = 0;
       
    76 
       
    77     /**
       
    78      * See CMdaAudioToneUtility::Play.
       
    79      */
       
    80     virtual void Play() = 0;
       
    81 
       
    82     /**
       
    83      * See CMdaAudioToneUtility::CancelPrepare.
       
    84      */
       
    85     virtual void CancelPrepare() = 0;
       
    86 
       
    87     };
       
    88 
       
    89 } //namespace TMS
       
    90 
       
    91 #endif // TMSAUDIOTONEUTILITY_H