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: |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef MLCAUDIOCONTROL_H |
|
19 #define MLCAUDIOCONTROL_H |
|
20 |
|
21 // INCLUDES |
|
22 #include <e32std.h> |
|
23 |
|
24 // CLASS DECLARATION |
|
25 /** |
|
26 * Class for adjusting the audio related settings |
|
27 * such as muting and unmuting the audio and changing its volume level. |
|
28 */ |
|
29 class MLcAudioControl |
|
30 { |
|
31 public: |
|
32 |
|
33 /** |
|
34 * Checks whether the local audio has been muted. |
|
35 * @return ETrue if the local audio has been muted, otherwise EFalse. |
|
36 */ |
|
37 virtual TBool IsLcAudioMutedL() = 0; |
|
38 |
|
39 /** |
|
40 * Mutes / unmutes the local audio. |
|
41 * @param aMute ETrue mutes the audio, EFalse unmutes it. |
|
42 */ |
|
43 virtual void MuteLcAudioL( TBool aMute ) = 0; |
|
44 |
|
45 /** |
|
46 * Checks whether the microphone has been muted, |
|
47 * @return ETrue if the microphone has been muted, otherwise EFalse. |
|
48 */ |
|
49 virtual TBool IsLcMicMutedL() = 0; |
|
50 |
|
51 /** |
|
52 * Mutes / unmutes the microphone. |
|
53 * @param aMute ETrue mutes the microphone, EFalse unmutes it. |
|
54 */ |
|
55 virtual void MuteLcMicL( TBool aMute ) = 0; |
|
56 |
|
57 /** |
|
58 * Checks whether it is allowed |
|
59 * to enable the loudspeaker by calling EnableLcLoudspeakerL. |
|
60 * @return ETrue if enabling the loudspeaker is allowed, otherwise EFalse. |
|
61 */ |
|
62 virtual TBool IsEnablingLcLoudspeakerAllowed() = 0; |
|
63 |
|
64 /** |
|
65 * Enables / disables the loudspeaker. |
|
66 * @pre IsEnablingLcLoudspeakerAllowed() == ETrue |
|
67 * @param aEnabled ETrue enables the loudspeaker, EFalse disables it. |
|
68 */ |
|
69 virtual void EnableLcLoudspeakerL( TBool aEnabled ) = 0; |
|
70 |
|
71 /** |
|
72 * Checks whether the loudspeaker has been enabled. |
|
73 * @return ETrue if the loudspeaker has been enabled, otherwise EFalse. |
|
74 */ |
|
75 virtual TBool IsLcLoudspeakerEnabled() = 0; |
|
76 |
|
77 /** |
|
78 * Returns the current volume level. |
|
79 * @return the current volume level |
|
80 */ |
|
81 virtual TInt LcVolumeL() = 0; |
|
82 |
|
83 /** |
|
84 * Sets the volume level. |
|
85 * @param aValue the volume level |
|
86 */ |
|
87 virtual void SetLcVolumeL( TInt aValue ) = 0; |
|
88 |
|
89 /** |
|
90 * Increases the volume level by one step. |
|
91 */ |
|
92 virtual void IncreaseLcVolumeL() = 0; |
|
93 |
|
94 /** |
|
95 * Decreases the volume level by one step. |
|
96 */ |
|
97 virtual void DecreaseLcVolumeL() = 0; |
|
98 }; |
|
99 |
|
100 #endif // MLCAUDIOCONTROL_H |
|
101 |
|
102 // end of file |
|