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:  Interface for playing audio tones.

    15 *

    16 */

    17 

    18 

    19 #ifndef CPEAUDIOTONEUTILITY_H

    20 #define CPEAUDIOTONEUTILITY_H

    21 

    22 #include <e32base.h>

    23 #include <mdaaudiotoneplayer.h>

    24 

    25 /**

    26  *  Interface to wrap CMdaAudioToneUtility.

    27  *  

    28  *  @lib AudioHandling

    29  *  @since S60 5.0

    30  */

    31 class CPEAudioToneUtility : public CBase

    32     {

    33 

    34 public:

    35     /**

    36      * See CMdaAudioToneUtility::PrepareToPlayDesSequence.

    37      */

    38     virtual void PrepareToPlayDesSequence( 

    39         const TDesC8& aSequence ) = 0;

    40     

    41     /**

    42      * See CMdaAudioToneUtility::State.

    43      */

    44     virtual TMdaAudioToneUtilityState State() = 0;

    45     

    46     /**

    47      * See CMdaAudioToneUtility::CancelPlay.

    48      */

    49     virtual void CancelPlay() = 0;

    50     

    51     /**

    52      * See CMdaAudioToneUtility::MaxVolume.

    53      */

    54     virtual TInt MaxVolume() = 0;

    55     

    56     /**

    57      * See CMdaAudioToneUtility::SetVolume.

    58      */

    59     virtual void SetVolume( TInt aVolume ) = 0;

    60     

    61     /**

    62      * See CMdaAudioToneUtility::SetRepeats.

    63      */

    64     virtual void SetRepeats(

    65         TInt aRepeatNumberOfTimes, 

    66         const TTimeIntervalMicroSeconds& aTrailingSilence ) = 0;

    67     

    68     /**

    69      * See CMdaAudioToneUtility::SetPriority.

    70      */    

    71     virtual void SetPriority(

    72         TInt aPriority, 

    73         TMdaPriorityPreference aPref) = 0;

    74     

    75     /**

    76      * See CMdaAudioToneUtility::SetVolumeRamp.

    77      */ 

    78     virtual void SetVolumeRamp( 

    79         const TTimeIntervalMicroSeconds& aRampDuration) = 0;

    80     

    81     /**

    82      * See CMdaAudioToneUtility::SetVolumeRamp.

    83      */

    84     virtual void Play() = 0;

    85 

    86     /**

    87      * See CMdaAudioToneUtility::CancelPrepare.

    88      */

    89     virtual void CancelPrepare() = 0;

    90 

    91     };

    92     

    93 #endif // CPEAUDIOTONEUTILITY_H