1 /*

     2 * Copyright (c) 2002-2005 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:  Client interface for phone ringing tone server.

    15 *

    16 */

    17 

    18 

    19 #ifndef RPHONERINGINGTONEPLAYER_H

    20 #define RPHONERINGINGTONEPLAYER_H

    21 

    22 // INCLUDES

    23 #include <Profile.hrh>

    24 

    25 // FORWARD DECLARATIONS

    26 class TPhoneCommandParam;

    27 

    28 // CLASS DECLARATION

    29 

    30 class RPhoneRingingTonePlayer : public RSessionBase

    31     {

    32 public:

    33     /**

    34     * C++ default constructor.

    35     */

    36     RPhoneRingingTonePlayer();

    37     

    38     /**

    39     * Destructor.

    40     */

    41     ~RPhoneRingingTonePlayer();

    42 

    43     // Tone settings

    44     

    45     /**

    46     * Sets extended security required flag.

    47     * @param aNeeded Extended security required.

    48     */

    49     void SetExtendedSecurityNeeded( TBool aNeeded );

    50     

    51     /**

    52     * Sets extended security required flag.

    53     * @param aLimit Extended security required.

    54     */

    55     void SetToneFileSizeLimit( TInt aLimit );

    56     

    57     /**

    58     * Sets ringing tone.

    59     * @param aFilename Ringing tone.

    60     */

    61     void SetRingingToneL( const TDesC& aFilename );

    62     

    63     /**

    64     * Sets default ringing tone.

    65     * @param aFilename Ringing tone.

    66     */

    67     void SetDefaultRingingToneL( const TDesC& aFilename );

    68 

    69     // Playback control

    70     

    71     /**

    72     * Play audio ring tone 

    73     * @param aVolume Volume used to play the ringing tone.

    74     * @param aRingingType Ringing type.

    75     */

    76     void PlayAudioRingTone( TInt aVolume, TProfileRingingType aRingingType );

    77 

    78     /**

    79     * Play TTS tone simultaneously with Personal or Default tones.

    80     * This method does not command phone to play TTS immediately. Instead 

    81     * it registers a request to play TTS, when Personal or default tones 

    82     * are played.

    83     * @param aTextToSay Text, that should be pronounced by the Text-To-Speech 

    84     * engine. This is normal descriptor, no UTF-8 and no "(tts)" prefix

    85     * @param aVolume Volume for the TTS-tone, Does not effect the volume 

    86     * of the normal tone, that will be played simulteneously with the TTS

    87     * @param aRingingType ringing type.

    88     */

    89     void PlayTtsTone( const TDesC& aTextToSay, TInt aVolume, TProfileRingingType aRingingType );

    90 

    91     /**

    92     * Play default tone.

    93     * @param aVolume volume used for the playing.

    94     * @param aRingingType ringing type.

    95     */

    96     void PlayDefaultTone( TInt aVolume, TProfileRingingType aRingingType );

    97 

    98     /**

    99     * Play backup tone.

   100     * @param aVolume volume used for the playing.

   101     * @param aRingingType ringing type.

   102     */

   103     void PlayBackupTone( TInt aVolume, TProfileRingingType aRingingType );

   104 

   105     /**

   106     * Play silent tone. No_sound.wav will be played. If vibration alert

   107     * is ON, it will vibrate.

   108     */

   109     void PlaySilentTone();

   110 

   111     /**

   112     * Playing the Beep once.

   113     * @param aVolume volume used to play the ringing tone.

   114     */

   115     void BeepOnce( TInt aVolume );

   116 

   117     /**

   118     * Play unsecure VoIP tone.

   119     * Play tone if secure call fails and call is changed to unsecure call

   120     */

   121     void PlayUnsecureVoIPTone();

   122 

   123     /**

   124     * Continues video playback with muted audio.

   125     * Ringing tone is stopped.

   126     */

   127     void MuteRingingTone();

   128 

   129     /**

   130     * Stops playing the ringing tone.

   131     * Method does not do anything if ringing tone is not playing.

   132     */

   133     void StopPlaying();

   134 

   135 

   136 public:

   137     /**

   138     * Establishes a connection with Server.

   139     * @return Result code indicating the success of operation.

   140     */

   141     TInt Connect();

   142     };

   143 

   144 #endif // CPHONERINGINGTONEPLAYERAO_H

   145 

   146 // End of file