|
sl@0
|
1 |
// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
// Declares the DVB-H tuner hardware adaptation information classes.
|
|
sl@0
|
15 |
//
|
|
sl@0
|
16 |
//
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
/**
|
|
sl@0
|
19 |
@file
|
|
sl@0
|
20 |
@publishedPartner
|
|
sl@0
|
21 |
@prototype
|
|
sl@0
|
22 |
*/
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
#ifndef DVBHRECEIVERINFO_H
|
|
sl@0
|
25 |
#define DVBHRECEIVERINFO_H
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
#include <e32base.h>
|
|
sl@0
|
28 |
#include <mobiletv/hai/dvbh/dvbhtypes.h>
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
class TIp6Addr;
|
|
sl@0
|
31 |
|
|
sl@0
|
32 |
/**
|
|
sl@0
|
33 |
* @publishedPartner
|
|
sl@0
|
34 |
* @prototype
|
|
sl@0
|
35 |
* @see CDvbhReceiverInfo::SetStateObserver()
|
|
sl@0
|
36 |
*
|
|
sl@0
|
37 |
* Defines an interface for receiving notifications of RDvbhReceiver state changes.
|
|
sl@0
|
38 |
* Clients wishing to monitor state changes should provide a CDvbhReceiverInfo
|
|
sl@0
|
39 |
* instance with an implementation of this interface via CDvbhReceiverInfo::SetStateObserver().
|
|
sl@0
|
40 |
*/
|
|
sl@0
|
41 |
class MDvbhStateObserver
|
|
sl@0
|
42 |
{
|
|
sl@0
|
43 |
public:
|
|
sl@0
|
44 |
/**
|
|
sl@0
|
45 |
* @param aNewState Identifies the state to which the RDvbhReceiver has just transitioned.
|
|
sl@0
|
46 |
*
|
|
sl@0
|
47 |
* When a client has registered an implementation with a CDvbhReceiverInfo instance,
|
|
sl@0
|
48 |
* this method will be called whenever RDvbhReceiver changes state, in order to
|
|
sl@0
|
49 |
* inform the client of the new state.
|
|
sl@0
|
50 |
*/
|
|
sl@0
|
51 |
virtual void DvbhStateChange( TDvbhState aNewState ) = 0;
|
|
sl@0
|
52 |
};
|
|
sl@0
|
53 |
|
|
sl@0
|
54 |
/**
|
|
sl@0
|
55 |
* @publishedPartner
|
|
sl@0
|
56 |
* @prototype
|
|
sl@0
|
57 |
* @see CDvbhReceiverInfo::SetSignalQualityObserver()
|
|
sl@0
|
58 |
*
|
|
sl@0
|
59 |
* Defines an interface for receiving notifications of changes to signal quality.
|
|
sl@0
|
60 |
* Clients wishing to monitor signal quality should provide a CDvbhReceiverInfo
|
|
sl@0
|
61 |
* instance with an implementation of this interface via CDvbhReceiverInfo::SetSignalQualityObserver().
|
|
sl@0
|
62 |
*/
|
|
sl@0
|
63 |
class MDvbhSignalQualityObserver
|
|
sl@0
|
64 |
{
|
|
sl@0
|
65 |
public:
|
|
sl@0
|
66 |
/**
|
|
sl@0
|
67 |
* @param aNewSignalQuality Identifies the new signal quality value.
|
|
sl@0
|
68 |
*
|
|
sl@0
|
69 |
* When a client has registered an implementation with a CDvbhReceiverInfo instance,
|
|
sl@0
|
70 |
* this method will be called whenever the signal quality changes, in order to
|
|
sl@0
|
71 |
* inform the client of the new signal quality.
|
|
sl@0
|
72 |
*/
|
|
sl@0
|
73 |
virtual void DvbhSignalQualityChange( const TDvbhSignalQuality& aNewSignalQuality ) = 0;
|
|
sl@0
|
74 |
};
|
|
sl@0
|
75 |
|
|
sl@0
|
76 |
/**
|
|
sl@0
|
77 |
* @publishedPartner
|
|
sl@0
|
78 |
* @prototype
|
|
sl@0
|
79 |
* @see CDvbhReceiverInfo::SetPlatformObserver()
|
|
sl@0
|
80 |
*
|
|
sl@0
|
81 |
* Defines an interface for receiving notifications of changes of the current IP platform.
|
|
sl@0
|
82 |
* Clients wishing to monitor IP platform changes should provide a CDvbhReceiverInfo
|
|
sl@0
|
83 |
* instance with an implementation of this interface via CDvbhReceiverInfo::SetPlatformObserver().
|
|
sl@0
|
84 |
*/
|
|
sl@0
|
85 |
class MDvbhPlatformObserver
|
|
sl@0
|
86 |
{
|
|
sl@0
|
87 |
public:
|
|
sl@0
|
88 |
/**
|
|
sl@0
|
89 |
* @param aNewPlatform Identifies the IP platform to which the receiver has just switched.
|
|
sl@0
|
90 |
* @param aESGRoot The IP address of the bootstrap ESG sevice on the new platform.
|
|
sl@0
|
91 |
*
|
|
sl@0
|
92 |
* When a client has registered an implementation with a CDvbhReceiverInfo instance,
|
|
sl@0
|
93 |
* this method will be called whenever the current IP platform changes, in order to
|
|
sl@0
|
94 |
* inform the client of the new IP platform and bootstrap ESG IP address.
|
|
sl@0
|
95 |
*/
|
|
sl@0
|
96 |
virtual void DvbhPlatformChange( const TDvbhPlatform& aNewPlatform, const TIp6Addr& aESGRoot ) = 0;
|
|
sl@0
|
97 |
};
|
|
sl@0
|
98 |
|
|
sl@0
|
99 |
/**
|
|
sl@0
|
100 |
* @publishedPartner
|
|
sl@0
|
101 |
* @prototype
|
|
sl@0
|
102 |
* @see CDvbhReceiverInfo::SetNetworkTimeObserver()
|
|
sl@0
|
103 |
*
|
|
sl@0
|
104 |
* Defines an interface for notifying of updates to the network time.
|
|
sl@0
|
105 |
* Clients wishing to monitor network time changes should provide a CDvbhReceiverInfo
|
|
sl@0
|
106 |
* instance with an implementation of this interface via CDvbhReceiverInfo::SetNetworkTimeObserver().
|
|
sl@0
|
107 |
* Network time update is triggered via call to RDvbhReceiver::UpdateNetworkTime()
|
|
sl@0
|
108 |
*/
|
|
sl@0
|
109 |
class MDvbhNetworkTimeObserver
|
|
sl@0
|
110 |
{
|
|
sl@0
|
111 |
public:
|
|
sl@0
|
112 |
/**
|
|
sl@0
|
113 |
* When a client has registered an implementation with a CDvbhReceiverInfo instance,
|
|
sl@0
|
114 |
* this method will be called whenever the current network time has been updated.
|
|
sl@0
|
115 |
*/
|
|
sl@0
|
116 |
virtual void DvbhNetworkTimeUpdate() = 0;
|
|
sl@0
|
117 |
};
|
|
sl@0
|
118 |
|
|
sl@0
|
119 |
/**
|
|
sl@0
|
120 |
* @publishedPartner
|
|
sl@0
|
121 |
* @prototype
|
|
sl@0
|
122 |
* @see CDvbhReceiverInfo::SetFrequencyObserver()
|
|
sl@0
|
123 |
*
|
|
sl@0
|
124 |
* Defines an interface for receiving notifications of changes to the frequency to which the receiver is tuned.
|
|
sl@0
|
125 |
* Clients wishing to monitor frequency changes should provide a CDvbhReceiverInfo
|
|
sl@0
|
126 |
* instance with an implementation of this interface via CDvbhReceiverInfo::SetFrequencyObserver().
|
|
sl@0
|
127 |
*/
|
|
sl@0
|
128 |
class MDvbhFrequencyObserver
|
|
sl@0
|
129 |
{
|
|
sl@0
|
130 |
public:
|
|
sl@0
|
131 |
/**
|
|
sl@0
|
132 |
* @param aNewFrequency Identifies the frequency to which the tuner has just tuned.
|
|
sl@0
|
133 |
*
|
|
sl@0
|
134 |
* When a client has registered an implementation with a CDvbhReceiverInfo instance,
|
|
sl@0
|
135 |
* this method will be called whenever the tuned frequency changes, in order to
|
|
sl@0
|
136 |
* inform the client of the new frequency.
|
|
sl@0
|
137 |
*/
|
|
sl@0
|
138 |
virtual void DvbhFrequencyChange( const TDvbhFrequency& aNewFrequency ) = 0;
|
|
sl@0
|
139 |
};
|
|
sl@0
|
140 |
|
|
sl@0
|
141 |
/**
|
|
sl@0
|
142 |
* @publishedPartner
|
|
sl@0
|
143 |
* @prototype
|
|
sl@0
|
144 |
* @see CDvbhReceiverInfo::SetCellIdObserver()
|
|
sl@0
|
145 |
*
|
|
sl@0
|
146 |
* Defines an interface for receiving notifications of changes to current cellId.
|
|
sl@0
|
147 |
* Clients wishing to monitor cellId changes should provide a CDvbhReceiverInfo
|
|
sl@0
|
148 |
* instance with an implementation of this interface via CDvbhReceiverInfo::SetCellIdObserver().
|
|
sl@0
|
149 |
*/
|
|
sl@0
|
150 |
class MDvbhCellIdObserver
|
|
sl@0
|
151 |
{
|
|
sl@0
|
152 |
public:
|
|
sl@0
|
153 |
/**
|
|
sl@0
|
154 |
* @param aNewCellId The new cellId.
|
|
sl@0
|
155 |
*
|
|
sl@0
|
156 |
* When a client has registered an implementation with a CDvbhReceiverInfo instance,
|
|
sl@0
|
157 |
* this method will be called whenever the current cellId changes, in order to
|
|
sl@0
|
158 |
* inform the client of the new cellId.
|
|
sl@0
|
159 |
*/
|
|
sl@0
|
160 |
virtual void DvbhCellIdChange( const TDvbhCellId& aNewCellId ) = 0;
|
|
sl@0
|
161 |
};
|
|
sl@0
|
162 |
|
|
sl@0
|
163 |
/**
|
|
sl@0
|
164 |
* @publishedPartner
|
|
sl@0
|
165 |
* @prototype
|
|
sl@0
|
166 |
* @see CDvbhReceiverInfo::SetNetworkIdObserver()
|
|
sl@0
|
167 |
*
|
|
sl@0
|
168 |
* Defines an interface for receiving notifications of changes to current networkId.
|
|
sl@0
|
169 |
* Clients wishing to monitor networkId changes should provide a CDvbhReceiverInfo
|
|
sl@0
|
170 |
* instance with an implementation of this interface via CDvbhReceiverInfo::SetNetworkIdObserver().
|
|
sl@0
|
171 |
*/
|
|
sl@0
|
172 |
class MDvbhNetworkIdObserver
|
|
sl@0
|
173 |
{
|
|
sl@0
|
174 |
public:
|
|
sl@0
|
175 |
/**
|
|
sl@0
|
176 |
* @param aNewNetworkId The ID of the network to which the receiver is now tuned.
|
|
sl@0
|
177 |
*
|
|
sl@0
|
178 |
* When a client has registered an implementation with a CDvbhReceiverInfo instance,
|
|
sl@0
|
179 |
* this method will be called whenever the ID of the network to which it is tuned changes,
|
|
sl@0
|
180 |
* in order to inform the client of the new networkId.
|
|
sl@0
|
181 |
*/
|
|
sl@0
|
182 |
virtual void DvbhNetworkIdChange( const TDvbhNetworkId& aNewNetworkId ) = 0;
|
|
sl@0
|
183 |
};
|
|
sl@0
|
184 |
|
|
sl@0
|
185 |
|
|
sl@0
|
186 |
/**
|
|
sl@0
|
187 |
* @publishedPartner
|
|
sl@0
|
188 |
* @prototype
|
|
sl@0
|
189 |
* @see CDvbhReceiverInfo::SetBatteryStateObserver()
|
|
sl@0
|
190 |
*
|
|
sl@0
|
191 |
* Defines an interface for receiving notifications of changes in external DVB-H receiver battery state.
|
|
sl@0
|
192 |
* Clients wishing to monitor battery changes should provide a CDvbhReceiverInfo
|
|
sl@0
|
193 |
* instance with an implementation of this interface via CDvbhReceiverInfo::SetBatteryStateObserver().
|
|
sl@0
|
194 |
*/
|
|
sl@0
|
195 |
class MDvbhExtBatteryStateObserver
|
|
sl@0
|
196 |
{
|
|
sl@0
|
197 |
public:
|
|
sl@0
|
198 |
/**
|
|
sl@0
|
199 |
* @param aNewState The new battery state of external receiver.
|
|
sl@0
|
200 |
*
|
|
sl@0
|
201 |
* When a client has registered an implementation with a CDvbhReceiverInfo instance,
|
|
sl@0
|
202 |
* this method will be called whenever the battery state of external receiver is changed,
|
|
sl@0
|
203 |
* in order to inform the client of the new aNewState.
|
|
sl@0
|
204 |
*/
|
|
sl@0
|
205 |
virtual void DvbhExtBatteryStateChange( TDvbhExtBatteryState aNewState ) = 0;
|
|
sl@0
|
206 |
};
|
|
sl@0
|
207 |
|
|
sl@0
|
208 |
/**
|
|
sl@0
|
209 |
* @publishedPartner
|
|
sl@0
|
210 |
* @prototype
|
|
sl@0
|
211 |
* @see CDvbhReceiverInfo::SetExtConnectionStateObserver()
|
|
sl@0
|
212 |
*
|
|
sl@0
|
213 |
* Defines an interface for receiving notifications of changes in external DVB-H receiver connection
|
|
sl@0
|
214 |
* Clients wishing to monitor connection changes should provide a CDvbhReceiverInfo
|
|
sl@0
|
215 |
* instance with an implementation of this interface via CDvbhReceiverInfo::SetExtConnectionStateObserver().
|
|
sl@0
|
216 |
*/
|
|
sl@0
|
217 |
class MDvbhExtConnectionObserver
|
|
sl@0
|
218 |
{
|
|
sl@0
|
219 |
public:
|
|
sl@0
|
220 |
|
|
sl@0
|
221 |
/**
|
|
sl@0
|
222 |
* @param aNewState The new external receiver connection state.
|
|
sl@0
|
223 |
* @param aReceiverType Type of the receiver
|
|
sl@0
|
224 |
*
|
|
sl@0
|
225 |
* When a client has registered an implementation with a CDvbhReceiverInfo instance,
|
|
sl@0
|
226 |
* this method will be called whenever the connection state of external receiver is changed,
|
|
sl@0
|
227 |
* in order to inform the client of the new aNewState.
|
|
sl@0
|
228 |
*/
|
|
sl@0
|
229 |
virtual void DvbhExtConnectionStateChange(
|
|
sl@0
|
230 |
const TDvbhExtConnectionState& aNewState, const TDvbhReceiverType& aReceiverType ) = 0;
|
|
sl@0
|
231 |
};
|
|
sl@0
|
232 |
|
|
sl@0
|
233 |
|
|
sl@0
|
234 |
/**
|
|
sl@0
|
235 |
* @publishedPartner
|
|
sl@0
|
236 |
* @prototype
|
|
sl@0
|
237 |
* @see CDvbhReceiverInfo::SetExtAntennaConnectionStateObserver()
|
|
sl@0
|
238 |
*
|
|
sl@0
|
239 |
* Defines an interface for receiving notifications of changes in external DVB-H receiver antenna connection.
|
|
sl@0
|
240 |
* Clients wishing to monitor connection changes should provide a CDvbhReceiverInfo
|
|
sl@0
|
241 |
* instance with an implementation of this interface via CDvbhReceiverInfo::SetExtAntennaConnectionStateObserver().
|
|
sl@0
|
242 |
*/
|
|
sl@0
|
243 |
class MDvbhExtAntennaConnectionObserver
|
|
sl@0
|
244 |
{
|
|
sl@0
|
245 |
public:
|
|
sl@0
|
246 |
|
|
sl@0
|
247 |
/**
|
|
sl@0
|
248 |
* @param aNewState The new external antenna connection state.
|
|
sl@0
|
249 |
* @param aReceiverType Type of the receiver
|
|
sl@0
|
250 |
*
|
|
sl@0
|
251 |
* When a client has registered an implementation with a CDvbhReceiverInfo instance,
|
|
sl@0
|
252 |
* this method will be called whenever the connection state of external receiver antenna is changed,
|
|
sl@0
|
253 |
* in order to inform the client of the new aNewState.
|
|
sl@0
|
254 |
*/
|
|
sl@0
|
255 |
virtual void DvbhExtAntennaConnectionStateChange(
|
|
sl@0
|
256 |
const TDvbhExtAntennaConnectionState& aNewState, const TDvbhReceiverType& aReceiverType ) = 0;
|
|
sl@0
|
257 |
};
|
|
sl@0
|
258 |
|
|
sl@0
|
259 |
|
|
sl@0
|
260 |
/**
|
|
sl@0
|
261 |
* @publishedPartner
|
|
sl@0
|
262 |
* @prototype
|
|
sl@0
|
263 |
*
|
|
sl@0
|
264 |
* Provides operations for reading and tracking information about the receiver, such
|
|
sl@0
|
265 |
* as state, signal quality, frequency, etc. Refer to the individual class methods
|
|
sl@0
|
266 |
* for the full list.
|
|
sl@0
|
267 |
*
|
|
sl@0
|
268 |
* Use of this class is safe in the sense that it will not interfere with the
|
|
sl@0
|
269 |
* receiver operation in any way. There can be multiple simultaneous instances
|
|
sl@0
|
270 |
* of CDvbhReceiverInfo at one time.
|
|
sl@0
|
271 |
*/
|
|
sl@0
|
272 |
class CDvbhReceiverInfo : public CBase
|
|
sl@0
|
273 |
{
|
|
sl@0
|
274 |
public:
|
|
sl@0
|
275 |
/**
|
|
sl@0
|
276 |
* @return A new instance of CDvbhReceiverInfo.
|
|
sl@0
|
277 |
*
|
|
sl@0
|
278 |
* Factory function for creating a CDvbhReceiverInfo object.
|
|
sl@0
|
279 |
*/
|
|
sl@0
|
280 |
IMPORT_C static CDvbhReceiverInfo* NewL();
|
|
sl@0
|
281 |
|
|
sl@0
|
282 |
/**
|
|
sl@0
|
283 |
* @return A new instance of CDvbhReceiverInfo.
|
|
sl@0
|
284 |
*
|
|
sl@0
|
285 |
* Factory function for creating a CDvbhReceiverInfo object, with
|
|
sl@0
|
286 |
* the new object left on the CleanupStack.
|
|
sl@0
|
287 |
*/
|
|
sl@0
|
288 |
IMPORT_C static CDvbhReceiverInfo* NewLC();
|
|
sl@0
|
289 |
|
|
sl@0
|
290 |
/**
|
|
sl@0
|
291 |
* C++ destructor.
|
|
sl@0
|
292 |
*/
|
|
sl@0
|
293 |
IMPORT_C ~CDvbhReceiverInfo();
|
|
sl@0
|
294 |
|
|
sl@0
|
295 |
/**
|
|
sl@0
|
296 |
* @param aState Updated with the current state of the receiver.
|
|
sl@0
|
297 |
* @return KErrNone on success, otherwise a system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
298 |
*
|
|
sl@0
|
299 |
* Retrieves the current state of the receiver.
|
|
sl@0
|
300 |
*/
|
|
sl@0
|
301 |
IMPORT_C static TInt GetState( TDvbhState& aState );
|
|
sl@0
|
302 |
|
|
sl@0
|
303 |
/**
|
|
sl@0
|
304 |
* @param aObserver An instance of an MDvbhStateObserver implementation.
|
|
sl@0
|
305 |
* @return KErrNone on success, otherwise a system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
306 |
* @see MDvbhStateObserver
|
|
sl@0
|
307 |
*
|
|
sl@0
|
308 |
* Used to register an MDvbhStateObserver implementation with the object. Once a client
|
|
sl@0
|
309 |
* has registered such an observer, it will be notified of any changes in receiver
|
|
sl@0
|
310 |
* state via that observer until either a new observer is registered or this object is
|
|
sl@0
|
311 |
* destroyed.
|
|
sl@0
|
312 |
*
|
|
sl@0
|
313 |
* If called more than once on an instance, the most recent observer registered
|
|
sl@0
|
314 |
* overrides any previously registered observers.
|
|
sl@0
|
315 |
*/
|
|
sl@0
|
316 |
IMPORT_C TInt SetStateObserver( MDvbhStateObserver& aObserver );
|
|
sl@0
|
317 |
|
|
sl@0
|
318 |
/**
|
|
sl@0
|
319 |
* @param aSignalQuality Updated with the current signal quality value.
|
|
sl@0
|
320 |
* @return KErrNone on success, KErrNotReady if receiver is not in the Receiving state, or another system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
321 |
*
|
|
sl@0
|
322 |
* Retrieves the current signal quality value.
|
|
sl@0
|
323 |
*/
|
|
sl@0
|
324 |
IMPORT_C static TInt GetSignalQuality( TDvbhSignalQuality& aSignalQuality );
|
|
sl@0
|
325 |
|
|
sl@0
|
326 |
/**
|
|
sl@0
|
327 |
* @param aObserver An instance of an MDvbhSignalQualityObserver implementation.
|
|
sl@0
|
328 |
* @return KErrNone on success, otherwise a system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
329 |
* @see MDvbhSignalQualityObserver
|
|
sl@0
|
330 |
*
|
|
sl@0
|
331 |
* Used to register an MDvbhSignalQualityObserver implementation with the object. Once a client
|
|
sl@0
|
332 |
* has registered such an observer, it will be notified of any changes to signal
|
|
sl@0
|
333 |
* quality via that observer until either a new observer is registered or this object is
|
|
sl@0
|
334 |
* destroyed.
|
|
sl@0
|
335 |
*
|
|
sl@0
|
336 |
* If called more than once on an instance, the most recent observer registered
|
|
sl@0
|
337 |
* overrides any previously registered observers.
|
|
sl@0
|
338 |
*/
|
|
sl@0
|
339 |
IMPORT_C TInt SetSignalQualityObserver( MDvbhSignalQualityObserver& aObserver );
|
|
sl@0
|
340 |
|
|
sl@0
|
341 |
/**
|
|
sl@0
|
342 |
* @param aPlatform Updated with the currently active IP platform.
|
|
sl@0
|
343 |
* @param aESGRoot Updated with the IP address of the bootstrap ESG service on the platform.
|
|
sl@0
|
344 |
* @return KErrNone on success, KErrNotReady if platform has not been set on the receiver, or another system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
345 |
*
|
|
sl@0
|
346 |
* Retrieves the currently active IP platform and IP address of its bootstrap ESG service.
|
|
sl@0
|
347 |
*/
|
|
sl@0
|
348 |
IMPORT_C static TInt GetPlatform( TDvbhPlatform& aPlatform, TIp6Addr& aESGRoot );
|
|
sl@0
|
349 |
|
|
sl@0
|
350 |
/**
|
|
sl@0
|
351 |
* @param aObserver An instance of an MDvbhPlatformObserver implementation.
|
|
sl@0
|
352 |
* @return KErrNone on success, otherwise a system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
353 |
* @see MDvbhPlatformObserver
|
|
sl@0
|
354 |
*
|
|
sl@0
|
355 |
* Used to register an MDvbhPlatformObserver implementation with the object. Once a client
|
|
sl@0
|
356 |
* has registered such an observer, it will be notified of any changes to IP platform
|
|
sl@0
|
357 |
* via that observer until either a new observer is registered or this object is
|
|
sl@0
|
358 |
* destroyed.
|
|
sl@0
|
359 |
*
|
|
sl@0
|
360 |
* If called more than once on an instance, the most recent observer registered
|
|
sl@0
|
361 |
* overrides any previously registered observers.
|
|
sl@0
|
362 |
*/
|
|
sl@0
|
363 |
IMPORT_C TInt SetPlatformObserver( MDvbhPlatformObserver& aObserver );
|
|
sl@0
|
364 |
|
|
sl@0
|
365 |
/**
|
|
sl@0
|
366 |
* @param aNetworkTime Upated with the current network time.
|
|
sl@0
|
367 |
* @param aValid Updated with ETrue if the receiver is in Ready or Receiving state; or EFalse if the time offset of a previous platform is available and has been used as a fallback to calculate the given time.
|
|
sl@0
|
368 |
* @return KErrNone on success, KErrNotReady if no platform has ever been set on the receiver, or another system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
369 |
* @see RDvbhReceiver::UpdateNetworkTime()
|
|
sl@0
|
370 |
*
|
|
sl@0
|
371 |
* Retrieves the current network time by calculating it from the offset obtained
|
|
sl@0
|
372 |
* after the last call to RDvbhReceiver::UpdateNetworkTime().
|
|
sl@0
|
373 |
*/
|
|
sl@0
|
374 |
IMPORT_C static TInt GetNetworkTime( TTime& aNetworkTime, TBool& aValid );
|
|
sl@0
|
375 |
|
|
sl@0
|
376 |
/**
|
|
sl@0
|
377 |
* @param aObserver An instance of an MDvbhNetworkTimeObserver implementation.
|
|
sl@0
|
378 |
* @return KErrNone on success, otherwise a system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
379 |
* @see MDvbhNetworkTimeObserver
|
|
sl@0
|
380 |
*
|
|
sl@0
|
381 |
* Used to register an MDvbhNetworkTimeObserver implementation with the object. Once a client
|
|
sl@0
|
382 |
* has registered such an observer, it will be notified whenever the network time has been
|
|
sl@0
|
383 |
* updated via that observer until either a new observer is registered or this object is
|
|
sl@0
|
384 |
* destroyed.
|
|
sl@0
|
385 |
*
|
|
sl@0
|
386 |
* If called more than once on an instance, the most recent observer registered
|
|
sl@0
|
387 |
* overrides any previously registered observers.
|
|
sl@0
|
388 |
*/
|
|
sl@0
|
389 |
IMPORT_C TInt SetNetworkTimeObserver( MDvbhNetworkTimeObserver& aObserver );
|
|
sl@0
|
390 |
|
|
sl@0
|
391 |
/**
|
|
sl@0
|
392 |
* @param aPerformanceData Updated with the current usage and performance data of the receiver.
|
|
sl@0
|
393 |
* @return KErrNone on success, KErrNotReady if the receiver is not in Receiving state, or another system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
394 |
*
|
|
sl@0
|
395 |
* Retrieves the current performance and usage data from the receiver.
|
|
sl@0
|
396 |
*/
|
|
sl@0
|
397 |
IMPORT_C static TInt GetPerformanceData( TDvbhPerformanceData& aPerformanceData );
|
|
sl@0
|
398 |
|
|
sl@0
|
399 |
/**
|
|
sl@0
|
400 |
* @param aFrequency Updated with the frequency to which the receiver is currently tuned.
|
|
sl@0
|
401 |
* @return KErrNone on success, KErrNotReady if platform has not been set on the receiver, or another system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
402 |
*
|
|
sl@0
|
403 |
* Retrieves the frequency to which the receiver is currently tuned.
|
|
sl@0
|
404 |
*/
|
|
sl@0
|
405 |
IMPORT_C static TInt GetFrequency( TDvbhFrequency& aFrequency );
|
|
sl@0
|
406 |
|
|
sl@0
|
407 |
/**
|
|
sl@0
|
408 |
* @param aObserver An instance of an MDvbhFrequencyObserver implementation.
|
|
sl@0
|
409 |
* @return KErrNone on success, otherwise a system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
410 |
* @see MDvbhFrequencyObserver
|
|
sl@0
|
411 |
*
|
|
sl@0
|
412 |
* Used to register an MDvbhFrequencyObserver implementation with the object. Once a client
|
|
sl@0
|
413 |
* has registered such an observer, it will be notified whenever the frequency to which
|
|
sl@0
|
414 |
* the receiver is tuned changes via that observer until either a new observer is
|
|
sl@0
|
415 |
* registered or this object is destroyed.
|
|
sl@0
|
416 |
*
|
|
sl@0
|
417 |
* If called more than once on an instance, the most recent observer registered
|
|
sl@0
|
418 |
* overrides any previously registered observers.
|
|
sl@0
|
419 |
*/
|
|
sl@0
|
420 |
IMPORT_C TInt SetFrequencyObserver( MDvbhFrequencyObserver& aObserver );
|
|
sl@0
|
421 |
|
|
sl@0
|
422 |
/**
|
|
sl@0
|
423 |
* @param aCellId Updated with the current cellId.
|
|
sl@0
|
424 |
* @return KErrNone on success, KErrNotReady if platform has not been set on the receiver, or another system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
425 |
*
|
|
sl@0
|
426 |
* Retrieves the current cellId.
|
|
sl@0
|
427 |
*/
|
|
sl@0
|
428 |
IMPORT_C static TInt GetCellId( TDvbhCellId& aCellId );
|
|
sl@0
|
429 |
|
|
sl@0
|
430 |
/**
|
|
sl@0
|
431 |
* @param aObserver An instance of an MDvbhCellIdObserver implementation.
|
|
sl@0
|
432 |
* @return KErrNone on success, otherwise a system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
433 |
* @see MDvbhCellIdObserver
|
|
sl@0
|
434 |
*
|
|
sl@0
|
435 |
* Used to register an MDvbhCellIdObserver implementation with the object. Once a client
|
|
sl@0
|
436 |
* has registered such an observer, it will be notified whenever the current cellId changes
|
|
sl@0
|
437 |
* via that observer until either a new observer is registered or the object is destroyed.
|
|
sl@0
|
438 |
*
|
|
sl@0
|
439 |
* If called more than once on an instance, the most recent observer registered
|
|
sl@0
|
440 |
* overrides any previously registered observers.
|
|
sl@0
|
441 |
*/
|
|
sl@0
|
442 |
IMPORT_C TInt SetCellIdObserver( MDvbhCellIdObserver& aObserver );
|
|
sl@0
|
443 |
|
|
sl@0
|
444 |
/**
|
|
sl@0
|
445 |
* @param aNetworkId Updated with the ID of the network to which the receiver is currently tuned.
|
|
sl@0
|
446 |
* @return KErrNone on success, KErrNotReady if platform has not been set on the receiver, or another system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
447 |
*
|
|
sl@0
|
448 |
* Retrieves the networkId of the network to which the receiver is currently tuned.
|
|
sl@0
|
449 |
*/
|
|
sl@0
|
450 |
IMPORT_C static TInt GetNetworkId( TDvbhNetworkId& aNetworkId );
|
|
sl@0
|
451 |
|
|
sl@0
|
452 |
/**
|
|
sl@0
|
453 |
* @param aObserver An instance of an MDvbhNetworkIdObserver implementation.
|
|
sl@0
|
454 |
* @return KErrNone on success, otherwise a system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
455 |
* @see MDvbhNetworkIdObserver
|
|
sl@0
|
456 |
*
|
|
sl@0
|
457 |
* Used to register an MDvbhNetworkIdObserver implementation with the object. Once a client
|
|
sl@0
|
458 |
* has registered such an observer, it will be notified whenever the ID of the network to which
|
|
sl@0
|
459 |
* the receiver is tuned changes via that observer until either a new observer is
|
|
sl@0
|
460 |
* registered or this object is destroyed.
|
|
sl@0
|
461 |
*
|
|
sl@0
|
462 |
* If called more than once on an instance, the most recent observer registered
|
|
sl@0
|
463 |
* overrides any previously registered observers.
|
|
sl@0
|
464 |
*/
|
|
sl@0
|
465 |
IMPORT_C TInt SetNetworkIdObserver( MDvbhNetworkIdObserver& aObserver );
|
|
sl@0
|
466 |
|
|
sl@0
|
467 |
/**
|
|
sl@0
|
468 |
* @param aState Updated with the battery state of external receiver
|
|
sl@0
|
469 |
* @return KErrNone on success, or another system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
470 |
*
|
|
sl@0
|
471 |
* Retrieves the battery state of external receiver
|
|
sl@0
|
472 |
*/
|
|
sl@0
|
473 |
IMPORT_C static TInt GetBatteryState( TDvbhExtBatteryState& aState );
|
|
sl@0
|
474 |
|
|
sl@0
|
475 |
/**
|
|
sl@0
|
476 |
* @param aObserver An instance of an MDvbhExtBatteryStateObserver implementation.
|
|
sl@0
|
477 |
* @return KErrNone on success, otherwise a system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
478 |
* @see MDvbhExtBatteryStateObserver
|
|
sl@0
|
479 |
*
|
|
sl@0
|
480 |
* Used to register an MDvbhExtBatteryStateObserver implementation with the object. Once a client
|
|
sl@0
|
481 |
* has registered such an observer, it will be notified whenever the battery state of external receiver
|
|
sl@0
|
482 |
* has changed via that observer until either a new observer is
|
|
sl@0
|
483 |
* registered or this object is destroyed.
|
|
sl@0
|
484 |
*
|
|
sl@0
|
485 |
* If called more than once on an instance, the most recent observer registered
|
|
sl@0
|
486 |
* overrides any previously registered observers.
|
|
sl@0
|
487 |
*/
|
|
sl@0
|
488 |
IMPORT_C TInt SetBatteryStateObserver( MDvbhExtBatteryStateObserver& aObserver );
|
|
sl@0
|
489 |
|
|
sl@0
|
490 |
/**
|
|
sl@0
|
491 |
* @param aConnectionState Updated with the connection state of external receiver
|
|
sl@0
|
492 |
* @param aReceiver Input for which receiver type the connection state is queried
|
|
sl@0
|
493 |
* @return KErrNone on success, or another system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
494 |
*
|
|
sl@0
|
495 |
* Retrieves the connection state of external receiver
|
|
sl@0
|
496 |
*/
|
|
sl@0
|
497 |
IMPORT_C static TInt GetExtConnectionState( TDvbhExtConnectionState& aConnectionState, const TDvbhReceiverType& aReceiver );
|
|
sl@0
|
498 |
|
|
sl@0
|
499 |
/**
|
|
sl@0
|
500 |
* @param aObserver An instance of an MDvbhExtConnectionObserver implementation.
|
|
sl@0
|
501 |
* @return KErrNone on success, otherwise a system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
502 |
* @see MDvbhExtConnectionObserver
|
|
sl@0
|
503 |
*
|
|
sl@0
|
504 |
* Used to register an MDvbhExtConnectionObserver implementation with the object. Once a client
|
|
sl@0
|
505 |
* has registered such an observer, it will be notified whenever the connection state of external
|
|
sl@0
|
506 |
* receiver has changed via that observer until either a new observer is
|
|
sl@0
|
507 |
* registered or this object is destroyed.
|
|
sl@0
|
508 |
*
|
|
sl@0
|
509 |
* If called more than once on an instance, the most recent observer registered
|
|
sl@0
|
510 |
* overrides any previously registered observers.
|
|
sl@0
|
511 |
*/
|
|
sl@0
|
512 |
IMPORT_C TInt SetExtConnectionStateObserver( MDvbhExtConnectionObserver& aObserver );
|
|
sl@0
|
513 |
|
|
sl@0
|
514 |
/**
|
|
sl@0
|
515 |
* @param aConnectionState Updated with the antenna connection state of external receiver
|
|
sl@0
|
516 |
* @param aReceiver Input for which receiver type the connection state is queried
|
|
sl@0
|
517 |
* @return KErrNone on success, or another system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
518 |
*
|
|
sl@0
|
519 |
* Retrieves the antenna connection state of external receiver.
|
|
sl@0
|
520 |
*/
|
|
sl@0
|
521 |
IMPORT_C static TInt GetExtAntennaConnectionState( TDvbhExtAntennaConnectionState& aConnectionState, const TDvbhReceiverType& aReceiver );
|
|
sl@0
|
522 |
|
|
sl@0
|
523 |
/**
|
|
sl@0
|
524 |
* @param aObserver An instance of an MDvbhExtAntennaConnectionObserver implementation.
|
|
sl@0
|
525 |
* @return KErrNone on success, otherwise a system-wide error code. Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
526 |
* @see MDvbhExtAntennaConnectionObserver
|
|
sl@0
|
527 |
*
|
|
sl@0
|
528 |
* Used to register an MDvbhExtAntennaConnectionObserver implementation with the object. Once a client
|
|
sl@0
|
529 |
* has registered such an observer, it will be notified whenever the antenna connection state of external
|
|
sl@0
|
530 |
* receiver has changed via that observer until either a new observer is
|
|
sl@0
|
531 |
* registered or this object is destroyed.
|
|
sl@0
|
532 |
*
|
|
sl@0
|
533 |
* If called more than once on an instance, the most recent observer registered
|
|
sl@0
|
534 |
* overrides any previously registered observers.
|
|
sl@0
|
535 |
*/
|
|
sl@0
|
536 |
IMPORT_C TInt SetExtAntennaConnectionStateObserver( MDvbhExtAntennaConnectionObserver& aObserver );
|
|
sl@0
|
537 |
|
|
sl@0
|
538 |
/**
|
|
sl@0
|
539 |
* @param aDeviceInfo Updated with the device information of external receiver
|
|
sl@0
|
540 |
* @param aReceiver Input for which receiver type the device information is queried
|
|
sl@0
|
541 |
* @return KErrNone on success, KErrNotSupported if receiver type is not supported, or another system-wide error code.
|
|
sl@0
|
542 |
* Clients should accept unknown error codes gracefully since new error codes may be returned in the future.
|
|
sl@0
|
543 |
*
|
|
sl@0
|
544 |
* Retrieves the device information of external receiver. Please note that the external receiver must be connected to get valid
|
|
sl@0
|
545 |
* device information.
|
|
sl@0
|
546 |
*/
|
|
sl@0
|
547 |
IMPORT_C static TInt GetExtDeviceInfo( TDvbhAccessoryInfo& aDeviceInfo, const TDvbhReceiverType& aReceiver );
|
|
sl@0
|
548 |
|
|
sl@0
|
549 |
private:
|
|
sl@0
|
550 |
/**
|
|
sl@0
|
551 |
* C++ constructor.
|
|
sl@0
|
552 |
*/
|
|
sl@0
|
553 |
CDvbhReceiverInfo();
|
|
sl@0
|
554 |
|
|
sl@0
|
555 |
/**
|
|
sl@0
|
556 |
* Symbian 2nd phase constructor.
|
|
sl@0
|
557 |
*/
|
|
sl@0
|
558 |
void ConstructL();
|
|
sl@0
|
559 |
|
|
sl@0
|
560 |
private:
|
|
sl@0
|
561 |
/*
|
|
sl@0
|
562 |
* Implementers of this interface should declare their own CPrivateData
|
|
sl@0
|
563 |
* class containing whatever private data is needed for their implementation.
|
|
sl@0
|
564 |
*/
|
|
sl@0
|
565 |
class CPrivateData;
|
|
sl@0
|
566 |
CPrivateData* iData;
|
|
sl@0
|
567 |
};
|
|
sl@0
|
568 |
|
|
sl@0
|
569 |
#endif // DVBHRECEIVERINFO_H
|