|
62
|
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: Interface class for phone ringing tone server.
|
|
|
15 |
*
|
|
|
16 |
*/
|
|
|
17 |
|
|
|
18 |
|
|
|
19 |
#ifndef __MPHONERINGINGTONESRV_H
|
|
|
20 |
#define __MPHONERINGINGTONESRV_H
|
|
|
21 |
|
|
|
22 |
// CLASS DECLARATION
|
|
|
23 |
class MPhoneRingingToneServer
|
|
|
24 |
{
|
|
|
25 |
public:
|
|
|
26 |
/**
|
|
|
27 |
* Start session.
|
|
|
28 |
*/
|
|
|
29 |
virtual TInt StartSession() = 0;
|
|
|
30 |
|
|
|
31 |
/**
|
|
|
32 |
* Close session.
|
|
|
33 |
*/
|
|
|
34 |
virtual void CloseSession() = 0;
|
|
|
35 |
|
|
|
36 |
// Ringing tone settings
|
|
|
37 |
|
|
|
38 |
/**
|
|
|
39 |
* Sets extended security required flag.
|
|
|
40 |
* @param aNeeded Extended security required.
|
|
|
41 |
*/
|
|
|
42 |
virtual void SetExtendedSecurityNeeded( TBool aNeeded ) = 0;
|
|
|
43 |
|
|
|
44 |
/**
|
|
|
45 |
* Sets extended security required flag.
|
|
|
46 |
* @param aLimit Extended security required.
|
|
|
47 |
*/
|
|
|
48 |
virtual void SetToneFileSizeLimit( TInt aLimit ) = 0;
|
|
|
49 |
|
|
|
50 |
/**
|
|
|
51 |
* Sets ringing tone.
|
|
|
52 |
*/
|
|
|
53 |
virtual void SetRingingToneL( const RMessage2& aMessage ) = 0;
|
|
|
54 |
|
|
|
55 |
/**
|
|
|
56 |
* Sets default ringing tone.
|
|
|
57 |
* @param aMessage Message from Client.
|
|
|
58 |
*/
|
|
|
59 |
virtual void SetDefaultRingingToneL( const RMessage2& aMessage ) = 0;
|
|
|
60 |
|
|
|
61 |
// Playback control
|
|
|
62 |
|
|
|
63 |
/**
|
|
|
64 |
* Play audio ring tone.
|
|
|
65 |
* @return True if the client message should not be completed.
|
|
|
66 |
* @param aMessage Message from Client.
|
|
|
67 |
*/
|
|
|
68 |
virtual TBool PlayAudioRingTone( const RMessage2& aMessage ) = 0;
|
|
|
69 |
|
|
|
70 |
/**
|
|
|
71 |
* Play TTS tone simultaneously with Personal or Default tones.
|
|
|
72 |
* This method does not command phone to play TTS immediately. Instead
|
|
|
73 |
* it registers a request to play TTS, when Personal or default tones
|
|
|
74 |
* are played.
|
|
|
75 |
* @param aMessage Message from Client.
|
|
|
76 |
*/
|
|
|
77 |
virtual void PlayTtsTone( const RMessage2& aMessage ) = 0;
|
|
|
78 |
|
|
|
79 |
/**
|
|
|
80 |
* Play default tone.
|
|
|
81 |
* @param aMessage Message from Client.
|
|
|
82 |
*/
|
|
|
83 |
virtual void PlayDefaultTone( const RMessage2& aMessage ) = 0;
|
|
|
84 |
|
|
|
85 |
/**
|
|
|
86 |
* Play backup tone.
|
|
|
87 |
* @param aMessage Message from Client.
|
|
|
88 |
*/
|
|
|
89 |
virtual void PlayBackupTone( const RMessage2& aMessage ) = 0;
|
|
|
90 |
|
|
|
91 |
/**
|
|
|
92 |
* Play silent tone. No_sound.wav will be played. If vibration alert
|
|
|
93 |
* is ON, it will vibrate.
|
|
|
94 |
*/
|
|
|
95 |
virtual void PlaySilentTone() = 0;
|
|
|
96 |
|
|
|
97 |
/**
|
|
|
98 |
* Playing the Beep once.
|
|
|
99 |
* @param aMessage Message from Client.
|
|
|
100 |
*/
|
|
|
101 |
virtual void BeepOnce( const RMessage2& aMessage ) = 0;
|
|
|
102 |
|
|
|
103 |
/**
|
|
|
104 |
* Play unsecure VoIP tone.
|
|
|
105 |
* Play tone if secure call fails and call is changed to unsecure call.
|
|
|
106 |
*/
|
|
|
107 |
virtual void PlayUnsecureVoIPTone() = 0;
|
|
|
108 |
|
|
|
109 |
/**
|
|
|
110 |
* Mutes ringing tone.
|
|
|
111 |
*/
|
|
|
112 |
virtual void MuteRingingTone() = 0;
|
|
|
113 |
|
|
|
114 |
/**
|
|
|
115 |
* Stops playing the ringing tone.
|
|
|
116 |
* Method does not do anything if ringing tone is not playing.
|
|
|
117 |
*/
|
|
|
118 |
virtual void StopPlaying() = 0;
|
|
|
119 |
|
|
|
120 |
};
|
|
|
121 |
|
|
|
122 |
#endif // __MPHONERINGINGTONESRV_H
|