|
1 /* |
|
2 * Copyright (c) 2006 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: This is the definition of the CAudioOutput class. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef AUDIOOUTPUT_H |
|
21 #define AUDIOOUTPUT_H |
|
22 |
|
23 // INCLUDES |
|
24 #include <e32base.h> |
|
25 #include <mdaaudiotoneplayer.h> |
|
26 #include <mdaaudiooutputstream.h> |
|
27 #include <midiclientutility.h> |
|
28 #include <MCustomInterface.h> |
|
29 |
|
30 // FORWARD DECLARATIONS |
|
31 class MAudioOutputObserver; |
|
32 class MCustomCommand; |
|
33 class CMdaAudioPlayerUtility; |
|
34 class CMdaAudioRecorderUtility; |
|
35 class CMMFDevSound; |
|
36 class CDrmPlayerUtility; |
|
37 class CVideoPlayerUtility; |
|
38 // CLASS DECLARATION |
|
39 |
|
40 /** |
|
41 * ?one_line_short_description. |
|
42 * ?other_description_lines |
|
43 */ |
|
44 class CAudioOutput : public CBase |
|
45 { |
|
46 public: // DATA TYPES |
|
47 enum TAudioOutputPreference |
|
48 { |
|
49 ENoPreference, |
|
50 EAll, |
|
51 ENoOutput, |
|
52 EPrivate, |
|
53 EPublic |
|
54 }; |
|
55 |
|
56 public: // Constructors and destructor |
|
57 |
|
58 /** |
|
59 * Two-phased constructor. |
|
60 */ |
|
61 IMPORT_C static CAudioOutput* NewL(CMdaAudioPlayerUtility& aUtility); |
|
62 /** |
|
63 * Factory function for creating audio output object. |
|
64 * @since 3.0 |
|
65 * @param CMdaAudioRecorderUtility& - a reference to CMdaAudioRecorderUtility object |
|
66 * @return pointer to CAudioOutput object |
|
67 */ |
|
68 IMPORT_C static CAudioOutput* CAudioOutput::NewL(CMdaAudioRecorderUtility& aUtility, TBool aRecordStream); |
|
69 /** |
|
70 * Factory function for creating audio output object. |
|
71 * @since 3.0 |
|
72 * @param CMdaAudioOutputStream& - a reference to CMdaAudioOutputStream object |
|
73 * @return pointer to CAudioOutput object |
|
74 */ |
|
75 IMPORT_C static CAudioOutput* CAudioOutput::NewL(CMdaAudioOutputStream& aUtility); |
|
76 /** |
|
77 * Factory function for creating audio output object. |
|
78 * @since 3.0 |
|
79 * @param CMdaAudioToneUtility& - a reference to CMdaAudioToneUtility object |
|
80 * @return pointer to CAudioOutput object |
|
81 */ |
|
82 IMPORT_C static CAudioOutput* CAudioOutput::NewL(CMdaAudioToneUtility& aUtility); |
|
83 /** |
|
84 * Factory function for creating audio output object. |
|
85 * @since 3.0 |
|
86 * @param CMMFDevSound& - a reference to CMMFDevSound object |
|
87 * @return pointer to CAudioOutput object |
|
88 */ |
|
89 IMPORT_C static CAudioOutput* CAudioOutput::NewL(CMMFDevSound& aDevSound); |
|
90 /** |
|
91 * Factory function for creating audio output object. |
|
92 * @since 3.0 |
|
93 * @param MCustomInterface& - a reference to MCustomInterface object |
|
94 * @return pointer to CAudioOutput object |
|
95 */ |
|
96 IMPORT_C static CAudioOutput* CAudioOutput::NewL(MCustomInterface& aUtility); |
|
97 /** |
|
98 * Factory function for creating audio output object. |
|
99 * @since 3.0 |
|
100 * @param MCustomCommand& - a reference to MCustomCommand object |
|
101 * @return pointer to CAudioOutput object |
|
102 */ |
|
103 IMPORT_C static CAudioOutput* CAudioOutput::NewL(MCustomCommand& aUtility); |
|
104 /** |
|
105 * Factory function for creating audio output object. |
|
106 * @since 3.0 |
|
107 * @param CMidiClientUtility& - a reference to CMidiClientUtility object |
|
108 * @return pointer to CAudioOutput object |
|
109 */ |
|
110 IMPORT_C static CAudioOutput* CAudioOutput::NewL(CMidiClientUtility& aUtility); |
|
111 /** |
|
112 * Factory function for creating audio output object. |
|
113 * @since 3.0 |
|
114 * @param CDrmPlayerUtility& - a reference to CDrmPlayerUtility object |
|
115 * @return pointer to CAudioOutput object |
|
116 */ |
|
117 IMPORT_C static CAudioOutput* /*CAudioOutput::*/NewL(CDrmPlayerUtility& aUtility); |
|
118 |
|
119 /** |
|
120 * Factory function for creating audio output object. |
|
121 * @since 3.2 |
|
122 * @param CVideoPlayerUtility& - a reference to CVideoPlayerUtility object |
|
123 * @return pointer to CAudioOutput object |
|
124 */ |
|
125 IMPORT_C static CAudioOutput* /*CAudioOutput::*/NewL(CVideoPlayerUtility& aUtility); |
|
126 |
|
127 /** |
|
128 * ?member_description. |
|
129 * @param ?arg1 ?description |
|
130 * @return ?description |
|
131 */ |
|
132 virtual TAudioOutputPreference AudioOutput() = 0; |
|
133 |
|
134 /** |
|
135 * ?member_description. |
|
136 * @param ?arg1 ?description |
|
137 * @return ?description |
|
138 */ |
|
139 virtual TAudioOutputPreference DefaultAudioOutput() = 0; |
|
140 |
|
141 /** |
|
142 * ?member_description. |
|
143 * @param ?arg1 ?description |
|
144 * @return ?description |
|
145 */ |
|
146 virtual void RegisterObserverL( MAudioOutputObserver& aObserver ) = 0; |
|
147 |
|
148 /** |
|
149 * ?member_description. |
|
150 * @param ?arg1 ?description |
|
151 * @return ?description |
|
152 */ |
|
153 virtual TBool SecureOutput() = 0; |
|
154 |
|
155 /** |
|
156 * ?member_description. |
|
157 * @param ?arg1 ?description |
|
158 * @return ?description |
|
159 */ |
|
160 virtual void SetAudioOutputL( TAudioOutputPreference aAudioOutput = ENoPreference ) = 0; |
|
161 |
|
162 /** |
|
163 * ?member_description. |
|
164 * @param ?arg1 ?description |
|
165 * @return ?description |
|
166 */ |
|
167 virtual void SetSecureOutputL( TBool aSecure = EFalse ) = 0; |
|
168 |
|
169 /** |
|
170 * ?member_description. |
|
171 * @param ?arg1 ?description |
|
172 * @return ?description |
|
173 */ |
|
174 virtual void UnregisterObserver( MAudioOutputObserver& aObserver ) = 0; |
|
175 |
|
176 }; |
|
177 |
|
178 #endif // CAUDIOOUTPUT_H |
|
179 |
|
180 // End of File |