|
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: P&S data for FMRadio |
|
15 * |
|
16 */ |
|
17 #ifndef FMRADIOINTERNALPSKEYS_H |
|
18 #define FMRADIOINTERNALPSKEYS_H |
|
19 |
|
20 #include <e32cmn.h> |
|
21 #include <fmradiouids.h> |
|
22 |
|
23 // FMRadio Application UID |
|
24 const TUid KFMRadioPSUid = { KUidFMRadioApplication }; |
|
25 |
|
26 /////////////////////////////////////////////////////////////////////////////////////////////////////// |
|
27 /// /// |
|
28 /// Data properties. These properties are published by fmradio and used by other applications. /// |
|
29 /// /// |
|
30 /////////////////////////////////////////////////////////////////////////////////////////////////////// |
|
31 |
|
32 /** |
|
33 * Currently active channel's ID. |
|
34 * Value <code>KErrNotFound</code> means that no preset channel is active. |
|
35 * Type <code>RProperty::EInt</code>. |
|
36 */ |
|
37 const TUint32 KFMRadioPSDataChannel = 0x00000000; |
|
38 |
|
39 /** |
|
40 * Currently active frequency. |
|
41 * Frequency unit is in kHz. |
|
42 * Type <code>RProperty::EInt</code>. |
|
43 */ |
|
44 const TUint32 KFMRadioPSDataFrequency = 0x00000001; |
|
45 |
|
46 /** |
|
47 * Current power state of the radio. |
|
48 * Type <code>RProperty::EInt</code>. |
|
49 * @see TFMRadioPSRadioPowerState. |
|
50 */ |
|
51 const TUint32 KFMRadioPSDataRadioPowerState = 0x00000002; |
|
52 |
|
53 /** |
|
54 * Power state of the radio. |
|
55 */ |
|
56 enum TFMRadioPSRadioPowerState |
|
57 { |
|
58 EFMRadioPSRadioPowerStateUninitialized, /**< The key is not yet initialized. */ |
|
59 EFMRadioPSRadioPowerOn, /**< Radio power on. */ |
|
60 EFMRadioPSRadioPowerOff /**< Radio power off. */ |
|
61 }; |
|
62 |
|
63 /** |
|
64 * Current volume level. |
|
65 * Scale is from 1-10. |
|
66 * Type <code>RProperty::EInt</code>. |
|
67 */ |
|
68 const TUint32 KFMRadioPSDataVolume = 0x00000003; |
|
69 |
|
70 /** |
|
71 * Changing of this value means that channel |
|
72 * data of specified channel ID has changed. |
|
73 * The value remains indicating the last changed channel ID. |
|
74 * Value <code>KErrNone</code> means that no channel data has been changed yet. |
|
75 * Type <code>RProperty::EInt</code>. |
|
76 */ |
|
77 const TUint32 KFMRadioPSDataChannelDataChanged = 0x00000004; |
|
78 |
|
79 /** |
|
80 * The current tuning state. |
|
81 * Type <code>RProperty::EInt</code>. |
|
82 * @see TFMRadioPSTuningState. |
|
83 */ |
|
84 const TUint32 KFMRadioPSDataTuningState = 0x00000006; |
|
85 |
|
86 /** |
|
87 * Possible tuning states. |
|
88 */ |
|
89 enum TFMRadioPSTuningState |
|
90 { |
|
91 EFMRadioPSTuningUninitialized, /**< Currently not tuning. */ |
|
92 EFMRadioPSTuningStarted, /**< Tuning has been started an lasted less than one second. */ |
|
93 EFMRadioPSTuningContinues /**< Tuning has taken more than one second. */ |
|
94 }; |
|
95 |
|
96 /** |
|
97 * Current mute state of radio. |
|
98 * Type <code>RProperty::EInt</code>. |
|
99 * @see TFMRadioPSRadioMuteState. |
|
100 */ |
|
101 const TUint32 KFMRadioPSDataRadioMuteState = 0x00000007; |
|
102 |
|
103 /** |
|
104 * Mute state of radio. |
|
105 */ |
|
106 enum TFMRadioPSRadioMuteState |
|
107 { |
|
108 EFMRadioPSMuteStateUninitialized, /**< The key has not yet been initialized. */ |
|
109 EFMRadioPSMuteStateOn, /**< Radio mute state is on. */ |
|
110 EFMRadioPSMuteStateOff /**< Radio mute state is off. */ |
|
111 }; |
|
112 |
|
113 /** |
|
114 * Indicates if FM Radio is running or closing. |
|
115 * Type <code>RProperty::EInt</code>. |
|
116 * @see TFMRadioPSApplicationRunningState. |
|
117 */ |
|
118 const TUint32 KFMRadioPSDataApplicationRunning = 0x00000008; |
|
119 |
|
120 /** |
|
121 * FM Radio application running states. |
|
122 */ |
|
123 enum TFMRadioPSApplicationRunningState |
|
124 { |
|
125 EFMRadioPSApplicationUninitialized, /**< FM Radio application's state is not yet initialized. */ |
|
126 EFMRadioPSApplicationRunning, /**< FM Radio application is running. */ |
|
127 EFMRadioPSApplicationClosing /**< FM Radio application is closing. */ |
|
128 }; |
|
129 |
|
130 /** |
|
131 * Indicates the current antenna connectivity status. |
|
132 * Type <code>RProperty::EInt</code>. |
|
133 * @see TFMRadioPSHeadsetStatus |
|
134 */ |
|
135 const TUint32 KFMRadioPSDataHeadsetStatus = 0x00000009; |
|
136 |
|
137 /** |
|
138 * Current antenna status. |
|
139 */ |
|
140 enum TFMRadioPSHeadsetStatus |
|
141 { |
|
142 EFMRadioPSHeadsetUninitialized, /**< The antenna status is uninitialized. */ |
|
143 EFMRadioPSHeadsetDisconnected, /**< The antenna is disconnected. */ |
|
144 EFMRadioPSHeadsetConnected /**< The antenna is connected. */ |
|
145 }; |
|
146 |
|
147 /** |
|
148 * The current frequency decimal count. |
|
149 * Type <code>RProperty::EInt</code>. |
|
150 * @see TFMRadioPSFrequencyDecimalCount. |
|
151 */ |
|
152 const TUint32 KFMRadioPSDataFrequencyDecimalCount = 0x00000010; |
|
153 |
|
154 /** |
|
155 * The current frequency decimal count. |
|
156 */ |
|
157 enum TFMRadioPSFrequencyDecimalCount |
|
158 { |
|
159 EFMRadioPSFrequencyDecimalCountUninitialized, /**< Frequency decimal count has not yet been initialized. */ |
|
160 EFMRadioPSFrequencyOneDecimal, /**< Frequency accuracy is one decimal. */ |
|
161 EFMRadioPSFrequencyTwoDecimals, /**< Frequency accuracy is two decimals. */ |
|
162 EFMRadioPSFrequencyThreeDecimals /**< Frequency accuracy is three decimals. */ |
|
163 }; |
|
164 |
|
165 /** |
|
166 * Current moving state of application. |
|
167 * Note that even if user activates the moving state, |
|
168 * the move can be still canceled. |
|
169 * Type <code>RProperty::EInt</code>. |
|
170 * @see TFMRadioPSMovingState |
|
171 */ |
|
172 const TUint32 KFMRadioPSDataMovingState = 0x00000011; |
|
173 |
|
174 /** |
|
175 * The current moving state. |
|
176 */ |
|
177 enum TFMRadioPSMovingState |
|
178 { |
|
179 EFMRadioPSMovingStateUninitialized, /**< Moving state is uninitialized. */ |
|
180 EFMRadioPSMovingStateOn, /**< User has activated moving state. */ |
|
181 EFMRadioPSMovingStatePerforming, /**< User has performed a channel move. */ |
|
182 EFMRadioPSMovingStateOff /**< Moving state is off. */ |
|
183 }; |
|
184 |
|
185 /** |
|
186 * Flag to indicate if we're connected to the network. |
|
187 */ |
|
188 const TUint32 KFMRadioPSDataNetworkConnected = 0x00000014; |
|
189 |
|
190 /** |
|
191 * Flag to indicate if loudspeaker is in use |
|
192 */ |
|
193 const TUint32 KFMRadioPSDataLoudspeakerStatus = 0x00000015; |
|
194 /** |
|
195 * Current speaker status. |
|
196 */ |
|
197 enum TFMRadioPSLoudspeakerStatus |
|
198 { |
|
199 EFMRadioPSLoudspeakerUninitialized, /**< The speaker status is uninitialized. */ |
|
200 EFMRadioPSLoudspeakerNotInUse, /**< The speaker is not in use. */ |
|
201 EFMRadioPSLoudpeakerInUse /**< The speaker is in use. */ |
|
202 }; |
|
203 |
|
204 /** |
|
205 * RDS Program Service information, property type is text. |
|
206 */ |
|
207 |
|
208 const TUint32 KFMRadioPSDataRDSProgramService = 0x00000016; |
|
209 |
|
210 /** |
|
211 * RDS Radio Text information. |
|
212 * Type <code>RProperty::EText</code>. |
|
213 */ |
|
214 const TUint32 KFMRadioPSDataRDSRadioText = 0x00000017; |
|
215 |
|
216 /** |
|
217 * Name of the current channel. |
|
218 * Type <code>RProperty::EText</code>. |
|
219 */ |
|
220 const TUint32 KFMRadioPSDataChannelName = 0x00000018; |
|
221 |
|
222 |
|
223 ////////////////////////////////////////////////////////////////////////////////////////////////////////// |
|
224 /// /// |
|
225 /// Control properties. These properties are published by other applications and used by FMRadio. /// |
|
226 /// /// |
|
227 ////////////////////////////////////////////////////////////////////////////////////////////////////////// |
|
228 |
|
229 /** |
|
230 * Sets mute state on or off. |
|
231 * Type <code>RProperty::EInt</code>. |
|
232 * @see TFMRadioPSRadioMuteState. |
|
233 */ |
|
234 const TUint32 KFMRadioPSControlSetRadioMuteState = 0x00001006; |
|
235 |
|
236 |
|
237 /** |
|
238 * Increases or decreases volume level. |
|
239 * Type <code>RProperty::EInt</code>. |
|
240 * @see TFMRadioPSAdjustVolume. |
|
241 */ |
|
242 const TUint32 KFMRadioPSControlAdjustVolume = 0x00001005; |
|
243 |
|
244 /** |
|
245 * Volume step direction. |
|
246 */ |
|
247 enum TFMRadioPSAdjustVolume |
|
248 { |
|
249 EFMRadioPSAdjustVolumeUninitialized = 0, /**< The key has not yet been initialized. */ |
|
250 EFMRadioPSIncreaseVolume, /**< Increase volume. */ |
|
251 EFMRadioPSDecreaseVolume /**< Decrease volume. */ |
|
252 }; |
|
253 |
|
254 ////////////////////////////////////////////////////////////////////////////////////////////////////////// |
|
255 /// /// |
|
256 /// Control properties. These properties are published by other applications and used by FM Radio. /// |
|
257 /// /// |
|
258 ////////////////////////////////////////////////////////////////////////////////////////////////////////// |
|
259 |
|
260 /** |
|
261 * Steps up or down a channel in channel list. |
|
262 * Type <code>RProperty::EInt</code>. |
|
263 * @see TFMRadioPSStepToChannel. |
|
264 */ |
|
265 const TUint32 KFMRadioPSControlStepToChannel = 0x00001000; |
|
266 |
|
267 /** |
|
268 * Step direction of channel step. |
|
269 */ |
|
270 enum TFMRadioPSStepToChannel |
|
271 { |
|
272 EFMRadioPSStepToChannelUninitialized, /**< Value of the key has not yet been initialized. */ |
|
273 EFMRadioPSStepToChannelUp, /**< Step to next channel up. */ |
|
274 EFMRadioPSStepToChannelDown /**< Step to next channel down. */ |
|
275 }; |
|
276 |
|
277 /** |
|
278 * Seeks to next active frequency up or down. |
|
279 * Type <code>RProperty::EInt</code>. |
|
280 * @see TFMRadioPSSeek. |
|
281 */ |
|
282 const TUint32 KFMRadioPSControlSeek = 0x00001002; |
|
283 |
|
284 /** |
|
285 * Seek direction. |
|
286 */ |
|
287 enum TFMRadioPSSeek |
|
288 { |
|
289 EFMRadioPSSeekUninitialized, /**< Value of the key has not yet been initialized. */ |
|
290 EFMRadioPSSeekUp, /**< Seek up. */ |
|
291 EFMRadioPSSeekDown /**< Seek down. */ |
|
292 }; |
|
293 |
|
294 const TUint32 KFMRadioActiveIdlePresetListCount = 0x00001003; |
|
295 const TUint32 KFMRadioActiveIdlePresetListFocus = 0x00001004; |
|
296 |
|
297 |
|
298 #endif |