|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2002-2006 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description: This class is the main interface to FMRadioTunerControl Adaptation API.
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
#ifndef C_FMRADIOTUNERCONTROL_H
|
|
sl@0
|
21 |
#define C_FMRADIOTUNERCONTROL_H
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
#include <e32base.h>
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
class MRdsControl;
|
|
sl@0
|
26 |
class MRdsControlObserver;
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
/**
|
|
sl@0
|
29 |
* FM tuner error definitions.
|
|
sl@0
|
30 |
* In addition to the standard system error code, the following error codes may
|
|
sl@0
|
31 |
* be returned.
|
|
sl@0
|
32 |
*/
|
|
sl@0
|
33 |
typedef TInt TFMRadioTunerError;
|
|
sl@0
|
34 |
const TFMRadioTunerError KFMRadioErrHardwareFaulty = -12050;
|
|
sl@0
|
35 |
const TFMRadioTunerError KFMRadioErrTuning = -12051;
|
|
sl@0
|
36 |
const TFMRadioTunerError KFMRadioErrFrequencyOutOfBandRange = -12052;
|
|
sl@0
|
37 |
const TFMRadioTunerError KFMRadioErrFrequencyNotValid = -12053;
|
|
sl@0
|
38 |
const TFMRadioTunerError KFMRadioErrNotPermittedInCurrentState = -12054;
|
|
sl@0
|
39 |
const TFMRadioTunerError KFMRadioErrDuplicateRequest = -12055;
|
|
sl@0
|
40 |
const TFMRadioTunerError KFMRadioErrAntennaNotConnected = -12056;
|
|
sl@0
|
41 |
const TFMRadioTunerError KFMRadioErrFmTransmitterActive = -12057;
|
|
sl@0
|
42 |
|
|
sl@0
|
43 |
|
|
sl@0
|
44 |
/** FM radio frequency range */
|
|
sl@0
|
45 |
enum TFMRadioFrequencyRange
|
|
sl@0
|
46 |
{
|
|
sl@0
|
47 |
EFMRadioFrequencyEuroAmerica = 0x01, // European and American FM frequency range
|
|
sl@0
|
48 |
EFMRadioFrequencyJapan = 0x02, // Japanese FM frequency range
|
|
sl@0
|
49 |
EFMRadioFrequencyAmericaNarrow = 0x04 // North American band (87.9-108 Mhz)
|
|
sl@0
|
50 |
};
|
|
sl@0
|
51 |
|
|
sl@0
|
52 |
|
|
sl@0
|
53 |
/** FM radio seek direction */
|
|
sl@0
|
54 |
enum TFMRadioSeekDirection
|
|
sl@0
|
55 |
{
|
|
sl@0
|
56 |
EFMRadioSeekUp,
|
|
sl@0
|
57 |
EFMRadioSeekDown
|
|
sl@0
|
58 |
};
|
|
sl@0
|
59 |
|
|
sl@0
|
60 |
|
|
sl@0
|
61 |
/** FM radio audio mode */
|
|
sl@0
|
62 |
enum TFMRadioAudioMode
|
|
sl@0
|
63 |
{
|
|
sl@0
|
64 |
EFMRadioAudioMono = 0x01,
|
|
sl@0
|
65 |
EFMRadioAudioStereo = 0x02
|
|
sl@0
|
66 |
};
|
|
sl@0
|
67 |
|
|
sl@0
|
68 |
/** FM radio sample rates */
|
|
sl@0
|
69 |
enum TFMRadioSampleRate
|
|
sl@0
|
70 |
{
|
|
sl@0
|
71 |
EFMRadioSampleRate8000Hz = 0x0001,
|
|
sl@0
|
72 |
EFMRadioSampleRate11025Hz = 0x0002,
|
|
sl@0
|
73 |
EFMRadioSampleRate12000Hz = 0x0004,
|
|
sl@0
|
74 |
EFMRadioSampleRate16000Hz = 0x0008,
|
|
sl@0
|
75 |
EFMRadioSampleRate22050Hz = 0x0010,
|
|
sl@0
|
76 |
EFMRadioSampleRate24000Hz = 0x0020,
|
|
sl@0
|
77 |
EFMRadioSampleRate32000Hz = 0x0040,
|
|
sl@0
|
78 |
EFMRadioSampleRate44100Hz = 0x0080,
|
|
sl@0
|
79 |
EFMRadioSampleRate48000Hz = 0x0100,
|
|
sl@0
|
80 |
EFMRadioSampleRate64000Hz = 0x0200,
|
|
sl@0
|
81 |
EFMRadioSampleRate88200Hz = 0x0400,
|
|
sl@0
|
82 |
EFMRadioSampleRate96000Hz = 0x0800
|
|
sl@0
|
83 |
};
|
|
sl@0
|
84 |
|
|
sl@0
|
85 |
|
|
sl@0
|
86 |
/**
|
|
sl@0
|
87 |
* The FM Tuner Capabilities class defines the capabilities of the FM tuner on the
|
|
sl@0
|
88 |
* device, as retrieved using the function GetCapabilities. Adaptation can utilize this
|
|
sl@0
|
89 |
* class to indicate the hardware limitations.
|
|
sl@0
|
90 |
*
|
|
sl@0
|
91 |
* @since S60 3.0
|
|
sl@0
|
92 |
*/
|
|
sl@0
|
93 |
class TFMRadioCapabilities
|
|
sl@0
|
94 |
{
|
|
sl@0
|
95 |
|
|
sl@0
|
96 |
#ifdef RD_FM_RADIO_ENHANCEMENTS
|
|
sl@0
|
97 |
|
|
sl@0
|
98 |
// Tuner Features bit flags - may be extended in future
|
|
sl@0
|
99 |
enum TFMTunerFeatures
|
|
sl@0
|
100 |
{
|
|
sl@0
|
101 |
// This bit is set if the tuner can be used even when the device is in
|
|
sl@0
|
102 |
// offline mode. Some tuner may not allow this due to hw conflict.
|
|
sl@0
|
103 |
ETunerAvailableInOfflineMode = 0x01,
|
|
sl@0
|
104 |
// This bit is set if the tuner has RDS support.
|
|
sl@0
|
105 |
ETunerRdsSupport = 0x02,
|
|
sl@0
|
106 |
// This bit is set when the device supports dual tuner, which allows
|
|
sl@0
|
107 |
// more extensive RDS feature support.
|
|
sl@0
|
108 |
ETunerDualTunerSupport = 0x04
|
|
sl@0
|
109 |
};
|
|
sl@0
|
110 |
#endif
|
|
sl@0
|
111 |
|
|
sl@0
|
112 |
public:
|
|
sl@0
|
113 |
// Bitmask using TFMRadioSampleRate
|
|
sl@0
|
114 |
TUint iSampleRate;
|
|
sl@0
|
115 |
// Bitmask using TFMRadioAudioMode
|
|
sl@0
|
116 |
TUint iChannels;
|
|
sl@0
|
117 |
// Encodings supported - FourCC
|
|
sl@0
|
118 |
TUint32 iEncoding ;
|
|
sl@0
|
119 |
|
|
sl@0
|
120 |
// Bitmask using TFMRadioFrequencyRange; used to indicate supported ranges.
|
|
sl@0
|
121 |
TUint32 iTunerBands;
|
|
sl@0
|
122 |
// Bitmask using TFMTunerFeatures; used to indicate supported tuner features.
|
|
sl@0
|
123 |
TUint32 iTunerFunctions;
|
|
sl@0
|
124 |
// Reserved for future
|
|
sl@0
|
125 |
TUint32 iAdditionalFunctions1;
|
|
sl@0
|
126 |
// Reserved for future
|
|
sl@0
|
127 |
TUint32 iAdditionalFunctions2;
|
|
sl@0
|
128 |
|
|
sl@0
|
129 |
};
|
|
sl@0
|
130 |
|
|
sl@0
|
131 |
|
|
sl@0
|
132 |
/**
|
|
sl@0
|
133 |
* This class provides the interface class to be implemented by object receiving request
|
|
sl@0
|
134 |
* complete notification from FM tuner control. These functions are called once the asynchronous
|
|
sl@0
|
135 |
* request completes successfully or with an error.
|
|
sl@0
|
136 |
*
|
|
sl@0
|
137 |
* In addition, this class provides the interface for receiving events from FM tuner control.
|
|
sl@0
|
138 |
*
|
|
sl@0
|
139 |
* @since S60 3.0
|
|
sl@0
|
140 |
*/
|
|
sl@0
|
141 |
class MFMRadioTunerControlObserver
|
|
sl@0
|
142 |
{
|
|
sl@0
|
143 |
public:
|
|
sl@0
|
144 |
|
|
sl@0
|
145 |
/**
|
|
sl@0
|
146 |
* Notification mechanism provided to inform client that TunerOn request has completed.
|
|
sl@0
|
147 |
*
|
|
sl@0
|
148 |
* @since S60 3.0
|
|
sl@0
|
149 |
* @param aError The result of the request indicating whether the operation was
|
|
sl@0
|
150 |
* successful or not.
|
|
sl@0
|
151 |
*/
|
|
sl@0
|
152 |
virtual void TunerOnComplete( TFMRadioTunerError aError ) = 0;
|
|
sl@0
|
153 |
|
|
sl@0
|
154 |
/**
|
|
sl@0
|
155 |
* Notification mechanism provided to inform client that TunerOff request has completed.
|
|
sl@0
|
156 |
*
|
|
sl@0
|
157 |
* @since S60 3.0
|
|
sl@0
|
158 |
* @param aError The result of the request indicating whether the operation was
|
|
sl@0
|
159 |
* successful or not.
|
|
sl@0
|
160 |
*/
|
|
sl@0
|
161 |
virtual void TunerOffComplete( TFMRadioTunerError aError ) = 0;
|
|
sl@0
|
162 |
|
|
sl@0
|
163 |
/**
|
|
sl@0
|
164 |
* Notification mechanism provided to inform client that SetFrequencyRange request has completed.
|
|
sl@0
|
165 |
*
|
|
sl@0
|
166 |
* @since S60 3.0
|
|
sl@0
|
167 |
* @param aError The result of the request indicating whether the operation was
|
|
sl@0
|
168 |
* successful or not.
|
|
sl@0
|
169 |
*/
|
|
sl@0
|
170 |
virtual void SetFrequencyRangeComplete( TFMRadioTunerError aError ) = 0;
|
|
sl@0
|
171 |
|
|
sl@0
|
172 |
/**
|
|
sl@0
|
173 |
* Notification mechanism provided to inform client that SetFrequency request has completed.
|
|
sl@0
|
174 |
*
|
|
sl@0
|
175 |
* @since S60 3.0
|
|
sl@0
|
176 |
* @param aError The result of the request indicating whether the operation was
|
|
sl@0
|
177 |
* successful or not.
|
|
sl@0
|
178 |
*/
|
|
sl@0
|
179 |
virtual void SetFrequencyComplete( TFMRadioTunerError aError ) = 0;
|
|
sl@0
|
180 |
|
|
sl@0
|
181 |
/**
|
|
sl@0
|
182 |
* Notification mechanism provided to inform client that StationSeek request has completed.
|
|
sl@0
|
183 |
*
|
|
sl@0
|
184 |
* @since S60 3.0
|
|
sl@0
|
185 |
* @param aError The result of the request indicating whether the operation was
|
|
sl@0
|
186 |
* successful or not.
|
|
sl@0
|
187 |
* @param aFrequency The frequency(Hz) of the radio station that was found.
|
|
sl@0
|
188 |
*/
|
|
sl@0
|
189 |
virtual void StationSeekComplete( TFMRadioTunerError aError, TInt aFrequency ) = 0;
|
|
sl@0
|
190 |
|
|
sl@0
|
191 |
/**
|
|
sl@0
|
192 |
* Notification mechanism provided to inform client that AudioMode request has completed.
|
|
sl@0
|
193 |
*
|
|
sl@0
|
194 |
* @since S60 3.0
|
|
sl@0
|
195 |
* @param aError The result of the request indicating whether the operation was
|
|
sl@0
|
196 |
* successful or not.
|
|
sl@0
|
197 |
* @param aMode The audio mode of the radio.
|
|
sl@0
|
198 |
*/
|
|
sl@0
|
199 |
virtual void AudioModeComplete( TFMRadioTunerError aError, TFMRadioAudioMode aMode ) = 0;
|
|
sl@0
|
200 |
|
|
sl@0
|
201 |
/**
|
|
sl@0
|
202 |
* Notification mechanism provided to inform client that SetAudioMode request has completed.
|
|
sl@0
|
203 |
*
|
|
sl@0
|
204 |
* @since S60 3.0
|
|
sl@0
|
205 |
* @param aError The result of the request indicating whether the operation was
|
|
sl@0
|
206 |
* successful or not.
|
|
sl@0
|
207 |
*/
|
|
sl@0
|
208 |
virtual void SetAudioModeComplete( TFMRadioTunerError aError ) = 0;
|
|
sl@0
|
209 |
|
|
sl@0
|
210 |
/**
|
|
sl@0
|
211 |
* Notification mechanism provided to inform client that MaxSignalStrength request has completed.
|
|
sl@0
|
212 |
*
|
|
sl@0
|
213 |
* @since S60 3.0
|
|
sl@0
|
214 |
* @param aError The result of the request indicating whether the operation was
|
|
sl@0
|
215 |
* successful or not.
|
|
sl@0
|
216 |
* @param aStrength The maximum possible signal strength of a tuned signal.
|
|
sl@0
|
217 |
*/
|
|
sl@0
|
218 |
virtual void MaxSignalStrengthComplete( TFMRadioTunerError aError, TInt aStrength ) = 0;
|
|
sl@0
|
219 |
|
|
sl@0
|
220 |
/**
|
|
sl@0
|
221 |
* Notification mechanism provided to inform client that SignalStrength request has completed.
|
|
sl@0
|
222 |
*
|
|
sl@0
|
223 |
* @since S60 3.0
|
|
sl@0
|
224 |
* @param aError The result of the request indicating whether the operation was
|
|
sl@0
|
225 |
* successful or not.
|
|
sl@0
|
226 |
* @param aStrength The signal strength of the currently tuned frequency.
|
|
sl@0
|
227 |
*/
|
|
sl@0
|
228 |
virtual void SignalStrengthComplete( TFMRadioTunerError aError, TInt aStrength ) = 0;
|
|
sl@0
|
229 |
|
|
sl@0
|
230 |
/**
|
|
sl@0
|
231 |
* Notification mechanism provided to inform client that Squelch request has completed.
|
|
sl@0
|
232 |
*
|
|
sl@0
|
233 |
* @since S60 3.0
|
|
sl@0
|
234 |
* @param aError The result of the request indicating whether the operation was
|
|
sl@0
|
235 |
* successful or not.
|
|
sl@0
|
236 |
* @param aEnabled ETrue if squelching is enabled, EFalse if disabled.
|
|
sl@0
|
237 |
*/
|
|
sl@0
|
238 |
virtual void SquelchComplete( TFMRadioTunerError aError, TBool aEnabled ) = 0;
|
|
sl@0
|
239 |
|
|
sl@0
|
240 |
/**
|
|
sl@0
|
241 |
* Notification mechanism provided to inform client that SetSquelch request has completed.
|
|
sl@0
|
242 |
*
|
|
sl@0
|
243 |
* @since S60 3.0
|
|
sl@0
|
244 |
* @param aError The result of the request indicating whether the operation was
|
|
sl@0
|
245 |
* successful or not.
|
|
sl@0
|
246 |
*/
|
|
sl@0
|
247 |
virtual void SetSquelchComplete( TFMRadioTunerError aError ) = 0;
|
|
sl@0
|
248 |
|
|
sl@0
|
249 |
/**
|
|
sl@0
|
250 |
* Notification mechanism provided to inform client that BufferToBeFilled request has completed.
|
|
sl@0
|
251 |
*
|
|
sl@0
|
252 |
* @since S60 3.0
|
|
sl@0
|
253 |
* @param aBuffer Buffer with data to be played.
|
|
sl@0
|
254 |
*/
|
|
sl@0
|
255 |
virtual void BufferFilled( TDes8& aBuffer ) = 0;
|
|
sl@0
|
256 |
|
|
sl@0
|
257 |
/**
|
|
sl@0
|
258 |
* Notification mechanism provided to inform that the antenna status has changed.
|
|
sl@0
|
259 |
*
|
|
sl@0
|
260 |
* @since S60 3.0
|
|
sl@0
|
261 |
* @param aAttached ETrue if antenna is attached.
|
|
sl@0
|
262 |
*/
|
|
sl@0
|
263 |
virtual void RadioEventAntennaStatusChange( TBool aAttached ) = 0;
|
|
sl@0
|
264 |
|
|
sl@0
|
265 |
#ifdef RD_FM_RADIO_ENHANCEMENTS
|
|
sl@0
|
266 |
/**
|
|
sl@0
|
267 |
* Notification mechanism indicating tuner control change. When tuner receiver is
|
|
sl@0
|
268 |
* forced to be turned off due to hardware conflict such as a FM transmitter, this
|
|
sl@0
|
269 |
* event is sent with an error code.
|
|
sl@0
|
270 |
* NOTE: Once the tuner control is restored, this event is sent again with KErrNone
|
|
sl@0
|
271 |
* and the client can re-issue TunerOn.
|
|
sl@0
|
272 |
*
|
|
sl@0
|
273 |
* @since S60 3.2
|
|
sl@0
|
274 |
* @param aError A standard system error code or FM tuner error (TFMRadioTunerError).
|
|
sl@0
|
275 |
*/
|
|
sl@0
|
276 |
virtual void RadioEventTunerControlChange( TInt aError ) = 0;
|
|
sl@0
|
277 |
#endif
|
|
sl@0
|
278 |
|
|
sl@0
|
279 |
};
|
|
sl@0
|
280 |
|
|
sl@0
|
281 |
/**
|
|
sl@0
|
282 |
* This class provides an interface to allow clients to control the FM tuner hardware
|
|
sl@0
|
283 |
* present on a device.
|
|
sl@0
|
284 |
*
|
|
sl@0
|
285 |
* @lib FMRadioTunerControl.lib
|
|
sl@0
|
286 |
* @since S60 3.0
|
|
sl@0
|
287 |
*/
|
|
sl@0
|
288 |
class CFMRadioTunerControl : public CBase
|
|
sl@0
|
289 |
{
|
|
sl@0
|
290 |
public: // Constructors
|
|
sl@0
|
291 |
|
|
sl@0
|
292 |
/**
|
|
sl@0
|
293 |
* Factory function to create a new instance of the tuner control.
|
|
sl@0
|
294 |
*
|
|
sl@0
|
295 |
* @since S60 3.0
|
|
sl@0
|
296 |
* @param aObserver The observer object
|
|
sl@0
|
297 |
* @return A pointer to a new instance of this class
|
|
sl@0
|
298 |
*/
|
|
sl@0
|
299 |
IMPORT_C static CFMRadioTunerControl* NewL( MFMRadioTunerControlObserver& aObserver );
|
|
sl@0
|
300 |
|
|
sl@0
|
301 |
public: // New functions
|
|
sl@0
|
302 |
|
|
sl@0
|
303 |
/**
|
|
sl@0
|
304 |
* Turns on the tuner. The method does not block, but returns immediately
|
|
sl@0
|
305 |
* and once the tuner is actually turned on the calling client will receive
|
|
sl@0
|
306 |
* a notification via the callback mechanism.
|
|
sl@0
|
307 |
*
|
|
sl@0
|
308 |
* @since S60 3.0
|
|
sl@0
|
309 |
* @param aRange The frequency range the tuner should be set to.
|
|
sl@0
|
310 |
* @param aFrequency The frequency (Hz) the tuner should be tuned to.
|
|
sl@0
|
311 |
*/
|
|
sl@0
|
312 |
virtual void TunerOn( TFMRadioFrequencyRange aRange, TInt aFrequency ) = 0;
|
|
sl@0
|
313 |
|
|
sl@0
|
314 |
/**
|
|
sl@0
|
315 |
* Cancels an outstanding TunerOn request. The method blocks while cancelling
|
|
sl@0
|
316 |
* the outstanding request. It is possible that the outstanding request may
|
|
sl@0
|
317 |
* complete normally before the cancel request can be processed.
|
|
sl@0
|
318 |
*
|
|
sl@0
|
319 |
* @since S60 3.0
|
|
sl@0
|
320 |
*/
|
|
sl@0
|
321 |
virtual void CancelTunerOn() = 0;
|
|
sl@0
|
322 |
|
|
sl@0
|
323 |
/**
|
|
sl@0
|
324 |
* Turns off the tuner. The method does not block, but returns immediately and
|
|
sl@0
|
325 |
* once the tuner is actually turned off the calling client will receive a
|
|
sl@0
|
326 |
* notification via the callback mechanism.
|
|
sl@0
|
327 |
* @since S60 3.0
|
|
sl@0
|
328 |
*/
|
|
sl@0
|
329 |
virtual void TunerOff() = 0;
|
|
sl@0
|
330 |
|
|
sl@0
|
331 |
/**
|
|
sl@0
|
332 |
* Cancels an outstanding TunerOff request. The method blocks while cancelling
|
|
sl@0
|
333 |
* the outstanding request. It is possible that the outstanding request may
|
|
sl@0
|
334 |
* complete normally before the cancel request can be processed.
|
|
sl@0
|
335 |
*
|
|
sl@0
|
336 |
* @since S60 3.0
|
|
sl@0
|
337 |
*/
|
|
sl@0
|
338 |
virtual void CancelTunerOff() = 0;
|
|
sl@0
|
339 |
|
|
sl@0
|
340 |
/**
|
|
sl@0
|
341 |
* Sets the tuner to the specified frequency range. The method does not block,
|
|
sl@0
|
342 |
* but returns immediately and once the frequency range has been set the calling
|
|
sl@0
|
343 |
* client will receive a notification via the callback mechanism.
|
|
sl@0
|
344 |
*
|
|
sl@0
|
345 |
* When not set, default to EFMRadioFrequencyEuroAmerica.
|
|
sl@0
|
346 |
*
|
|
sl@0
|
347 |
* This method can only be called when tuner is off. Otherwise, KErrInUse will be
|
|
sl@0
|
348 |
* returned in callback method.
|
|
sl@0
|
349 |
*
|
|
sl@0
|
350 |
* @since S60 3.0
|
|
sl@0
|
351 |
* @param aRange The frequency range the tuner should be set to.
|
|
sl@0
|
352 |
*/
|
|
sl@0
|
353 |
virtual void SetFrequencyRange( TFMRadioFrequencyRange aRange ) = 0;
|
|
sl@0
|
354 |
|
|
sl@0
|
355 |
/**
|
|
sl@0
|
356 |
* Cancels an outstanding SetFrequencyRange request. The method blocks while
|
|
sl@0
|
357 |
* cancelling the outstanding request. It is possible that the outstanding
|
|
sl@0
|
358 |
* request may complete normally before the cancel request can be processed.
|
|
sl@0
|
359 |
*
|
|
sl@0
|
360 |
* @since S60 3.0
|
|
sl@0
|
361 |
*/
|
|
sl@0
|
362 |
virtual void CancelSetFrequencyRange() = 0;
|
|
sl@0
|
363 |
|
|
sl@0
|
364 |
/**
|
|
sl@0
|
365 |
* Tunes the tuner to the specified frequency. The method does not block,
|
|
sl@0
|
366 |
* but returns immediately and once the tuner has been tuned the calling
|
|
sl@0
|
367 |
* client will receive a notification via the callback mechanism.
|
|
sl@0
|
368 |
*
|
|
sl@0
|
369 |
* @since S60 3.0
|
|
sl@0
|
370 |
* @param aFrequency The frequency (Hz) the tuner should be tuned to.
|
|
sl@0
|
371 |
*/
|
|
sl@0
|
372 |
virtual void SetFrequency( TInt aFrequency ) = 0;
|
|
sl@0
|
373 |
|
|
sl@0
|
374 |
/**
|
|
sl@0
|
375 |
* Cancels an outstanding SetFrequency request. The method blocks while
|
|
sl@0
|
376 |
* cancelling the outstanding request. It is possible that the outstanding
|
|
sl@0
|
377 |
* request may complete normally before the cancel request can be processed.
|
|
sl@0
|
378 |
*
|
|
sl@0
|
379 |
* @since S60 3.0
|
|
sl@0
|
380 |
*/
|
|
sl@0
|
381 |
virtual void CancelSetFrequency() = 0;
|
|
sl@0
|
382 |
|
|
sl@0
|
383 |
/**
|
|
sl@0
|
384 |
* Finds a station, starting at the currently tuned frequency and searches in
|
|
sl@0
|
385 |
* the direction specified (i.e. up or down). The method does not block, but
|
|
sl@0
|
386 |
* returns immediately and once a station is found the calling client will
|
|
sl@0
|
387 |
* receive a notification via the callback mechanism. The station found is
|
|
sl@0
|
388 |
* returned in the callback.
|
|
sl@0
|
389 |
*
|
|
sl@0
|
390 |
* @since S60 3.0
|
|
sl@0
|
391 |
* @param aDirection The direction to search in.
|
|
sl@0
|
392 |
*/
|
|
sl@0
|
393 |
virtual void StationSeek( TFMRadioSeekDirection aDirection ) = 0;
|
|
sl@0
|
394 |
|
|
sl@0
|
395 |
/**
|
|
sl@0
|
396 |
* Cancels an outstanding StationSeek request. The method blocks while
|
|
sl@0
|
397 |
* cancelling the outstanding request. It is possible that the outstanding
|
|
sl@0
|
398 |
* request may complete normally before the cancel request can be processed.
|
|
sl@0
|
399 |
*
|
|
sl@0
|
400 |
* @since S60 3.0
|
|
sl@0
|
401 |
*/
|
|
sl@0
|
402 |
virtual void CancelStationSeek() = 0;
|
|
sl@0
|
403 |
|
|
sl@0
|
404 |
/**
|
|
sl@0
|
405 |
* Retrieves the tuner’s current audio mode (i.e. stereo or mono). The
|
|
sl@0
|
406 |
* method does not block, but returns immediately and once the request
|
|
sl@0
|
407 |
* is completed the calling client will receive a notification via the
|
|
sl@0
|
408 |
* callback mechanism. Audio mode is returned in the callback.
|
|
sl@0
|
409 |
*
|
|
sl@0
|
410 |
* @since S60 3.0
|
|
sl@0
|
411 |
*/
|
|
sl@0
|
412 |
virtual void AudioMode() = 0;
|
|
sl@0
|
413 |
|
|
sl@0
|
414 |
/**
|
|
sl@0
|
415 |
* Cancels an outstanding AudioMode request. The method blocks while cancelling
|
|
sl@0
|
416 |
* the outstanding request. It is possible that the outstanding request may
|
|
sl@0
|
417 |
* complete normally before the cancel request can be processed.
|
|
sl@0
|
418 |
*
|
|
sl@0
|
419 |
* @since S60 3.0
|
|
sl@0
|
420 |
*/
|
|
sl@0
|
421 |
virtual void CancelAudioMode() = 0;
|
|
sl@0
|
422 |
|
|
sl@0
|
423 |
/**
|
|
sl@0
|
424 |
* Sets the tuner’s audio mode (i.e. stereo or mono). The method does not block,
|
|
sl@0
|
425 |
* but returns immediately and once the audio mode is actually set the calling
|
|
sl@0
|
426 |
* client will receive a notification via the callback mechanism.
|
|
sl@0
|
427 |
*
|
|
sl@0
|
428 |
* When not set, default to EFMRadioAudioStereo.
|
|
sl@0
|
429 |
*
|
|
sl@0
|
430 |
* @since S60 3.0
|
|
sl@0
|
431 |
* @param aMode The audio mode the tuner should be set to.
|
|
sl@0
|
432 |
*/
|
|
sl@0
|
433 |
virtual void SetAudioMode( TFMRadioAudioMode aMode ) = 0;
|
|
sl@0
|
434 |
|
|
sl@0
|
435 |
/**
|
|
sl@0
|
436 |
* Cancels an outstanding SetAudioMode request. The method blocks while cancelling
|
|
sl@0
|
437 |
* the outstanding request. It is possible that the outstanding request may
|
|
sl@0
|
438 |
* complete normally before the cancel request can be processed.
|
|
sl@0
|
439 |
*
|
|
sl@0
|
440 |
* @since S60 3.0
|
|
sl@0
|
441 |
*/
|
|
sl@0
|
442 |
virtual void CancelSetAudioMode() = 0;
|
|
sl@0
|
443 |
|
|
sl@0
|
444 |
/**
|
|
sl@0
|
445 |
* Retrieves the maximum possible signal strength (RSSI) of a tuned signal.
|
|
sl@0
|
446 |
* The method does not block, but returns immediately and once the request
|
|
sl@0
|
447 |
* is completed the calling client will receive a notification via the callback
|
|
sl@0
|
448 |
* mechanism. Maximun signal strength is returned in the callback.
|
|
sl@0
|
449 |
*
|
|
sl@0
|
450 |
* @since S60 3.0
|
|
sl@0
|
451 |
*/
|
|
sl@0
|
452 |
virtual void MaxSignalStrength() = 0;
|
|
sl@0
|
453 |
|
|
sl@0
|
454 |
/**
|
|
sl@0
|
455 |
* Cancels an outstanding MaxSignalStrength request. The method blocks while
|
|
sl@0
|
456 |
* cancelling the outstanding request. It is possible that the outstanding
|
|
sl@0
|
457 |
* request may complete normally before the cancel request can be processed.
|
|
sl@0
|
458 |
*
|
|
sl@0
|
459 |
* @since S60 3.0
|
|
sl@0
|
460 |
*/
|
|
sl@0
|
461 |
virtual void CancelMaxSignalStrength() = 0;
|
|
sl@0
|
462 |
|
|
sl@0
|
463 |
/**
|
|
sl@0
|
464 |
* Retrieves the signal strength (RSSI) of the currently tuned frequency.
|
|
sl@0
|
465 |
* The method does not block, but returns immediately and once the request
|
|
sl@0
|
466 |
* is completed the calling client will receive a notification via the callback
|
|
sl@0
|
467 |
* mechanism. Signal strength is returned in the callback.
|
|
sl@0
|
468 |
*
|
|
sl@0
|
469 |
* @since S60 3.0
|
|
sl@0
|
470 |
*/
|
|
sl@0
|
471 |
virtual void SignalStrength() = 0;
|
|
sl@0
|
472 |
|
|
sl@0
|
473 |
/**
|
|
sl@0
|
474 |
* Cancels an outstanding SignalStrength request. The method blocks while
|
|
sl@0
|
475 |
* cancelling the outstanding request. It is possible that the outstanding
|
|
sl@0
|
476 |
* request may complete normally before the cancel request can be processed.
|
|
sl@0
|
477 |
*
|
|
sl@0
|
478 |
* @since S60 3.0
|
|
sl@0
|
479 |
*/
|
|
sl@0
|
480 |
virtual void CancelSignalStrength() = 0;
|
|
sl@0
|
481 |
|
|
sl@0
|
482 |
/**
|
|
sl@0
|
483 |
* Retrieves the current squelching (muting in frequencies without reception)
|
|
sl@0
|
484 |
* setting. The method does not block, but returns immediately and once the
|
|
sl@0
|
485 |
* request is completed the calling client will receive a notification via
|
|
sl@0
|
486 |
* the callback mechanism. Squelch setting is returned in the callback.
|
|
sl@0
|
487 |
*
|
|
sl@0
|
488 |
* @since S60 3.0
|
|
sl@0
|
489 |
*/
|
|
sl@0
|
490 |
virtual void Squelch() = 0;
|
|
sl@0
|
491 |
|
|
sl@0
|
492 |
/**
|
|
sl@0
|
493 |
* Cancels an outstanding Squelch request. The method blocks while cancelling
|
|
sl@0
|
494 |
* the outstanding request. It is possible that the outstanding request may
|
|
sl@0
|
495 |
* complete normally before the cancel request can be processed.
|
|
sl@0
|
496 |
*
|
|
sl@0
|
497 |
* @since S60 3.0
|
|
sl@0
|
498 |
*/
|
|
sl@0
|
499 |
virtual void CancelSquelch() = 0;
|
|
sl@0
|
500 |
|
|
sl@0
|
501 |
/**
|
|
sl@0
|
502 |
* Sets the current squelching (muting in frequencies without reception) setting.
|
|
sl@0
|
503 |
* The method does not block, but returns immediately and once the squelch setting
|
|
sl@0
|
504 |
* is actually set the calling client will receive a notification via the callback
|
|
sl@0
|
505 |
* mechanism.
|
|
sl@0
|
506 |
*
|
|
sl@0
|
507 |
* When not set, default to enabled.
|
|
sl@0
|
508 |
*
|
|
sl@0
|
509 |
* @since S60 3.0
|
|
sl@0
|
510 |
* @param aEnabled ETrue to enable squelching, EFalse to disable it.
|
|
sl@0
|
511 |
*/
|
|
sl@0
|
512 |
virtual void SetSquelch( TBool aEnabled ) = 0;
|
|
sl@0
|
513 |
|
|
sl@0
|
514 |
/**
|
|
sl@0
|
515 |
* Cancels an outstanding SetSquelch request. The method blocks while cancelling
|
|
sl@0
|
516 |
* the outstanding request. It is possible that the outstanding request may
|
|
sl@0
|
517 |
* complete normally before the cancel request can be processed.
|
|
sl@0
|
518 |
*
|
|
sl@0
|
519 |
* @since S60 3.0
|
|
sl@0
|
520 |
*/
|
|
sl@0
|
521 |
virtual void CancelSetSquelch() = 0;
|
|
sl@0
|
522 |
|
|
sl@0
|
523 |
/**
|
|
sl@0
|
524 |
* This function is called when data is needed for playing. BufferFilled should
|
|
sl@0
|
525 |
* be called as quickly as possible after the data is read into buffer or an
|
|
sl@0
|
526 |
* underflow situation may occur.
|
|
sl@0
|
527 |
*
|
|
sl@0
|
528 |
* @since S60 3.0
|
|
sl@0
|
529 |
* @param aBuffer Buffer into which data should be read.
|
|
sl@0
|
530 |
*/
|
|
sl@0
|
531 |
virtual void BufferToBeFilled( TDes8& aBuffer ) = 0;
|
|
sl@0
|
532 |
|
|
sl@0
|
533 |
/**
|
|
sl@0
|
534 |
* Retrieves the audio capabilities supported by the device.
|
|
sl@0
|
535 |
*
|
|
sl@0
|
536 |
* @since S60 3.0
|
|
sl@0
|
537 |
* @return Supported audio capabilities
|
|
sl@0
|
538 |
*/
|
|
sl@0
|
539 |
virtual TFMRadioCapabilities Capabilities() = 0;
|
|
sl@0
|
540 |
|
|
sl@0
|
541 |
#ifdef RD_FM_RADIO_ENHANCEMENTS
|
|
sl@0
|
542 |
/**
|
|
sl@0
|
543 |
* Returns a pointer to RDS control.
|
|
sl@0
|
544 |
*
|
|
sl@0
|
545 |
* @since S60 3.2
|
|
sl@0
|
546 |
* @param aObserver RDS control observer
|
|
sl@0
|
547 |
*/
|
|
sl@0
|
548 |
virtual MRdsControl* RdsControl( MRdsControlObserver& aObserver ) = 0;
|
|
sl@0
|
549 |
|
|
sl@0
|
550 |
/**
|
|
sl@0
|
551 |
* Gets the current frequency range. It also returns the minimum and maximum frequencies (Hz)
|
|
sl@0
|
552 |
* for the returned range. Client should always use the minimum and maximum frequencies returned
|
|
sl@0
|
553 |
* by the tuner device, since it may vary slightly depending on the hardware.
|
|
sl@0
|
554 |
*
|
|
sl@0
|
555 |
* @since S60 3.2
|
|
sl@0
|
556 |
* @param aRange On return contains the current frequency range.
|
|
sl@0
|
557 |
* @param aMinFreq On return contains the minimum frequency for the current frequency range.
|
|
sl@0
|
558 |
* @param aMaxFreq On return contains the maximum frequency for the current frequency range.
|
|
sl@0
|
559 |
* @return A standard system error code or FM tuner error (TFMRadioTunerError).
|
|
sl@0
|
560 |
*/
|
|
sl@0
|
561 |
virtual TInt GetFrequencyRange( TFMRadioFrequencyRange& aRange, TInt& aMinFreq, TInt& aMaxFreq ) const = 0;
|
|
sl@0
|
562 |
#endif
|
|
sl@0
|
563 |
|
|
sl@0
|
564 |
};
|
|
sl@0
|
565 |
|
|
sl@0
|
566 |
#endif // C_FMRADIOTUNERCONTROL_H
|
|
sl@0
|
567 |
|