Symbian3/PDK/Source/GUID-721A5765-7A9A-58F9-AFAF-ABC559207D23.dita
author Graeme Price <GRAEME.PRICE@NOKIA.COM>
Fri, 15 Oct 2010 14:32:18 +0100
changeset 15 307f4279f433
parent 14 578be2adaf3e
permissions -rw-r--r--
Initial contribution of the Adaptation Documentation.

<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
<!-- This component and the accompanying materials are made available under the terms of the License 
"Eclipse Public License v1.0" which accompanies this distribution, 
and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
<!-- Initial Contributors:
    Nokia Corporation - initial contribution.
Contributors: 
-->
<!DOCTYPE concept
  PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="GUID-721A5765-7A9A-58F9-AFAF-ABC559207D23" xml:lang="en"><title>DVB-H
Receiver Information Library Overview</title><prolog><metadata><keywords/></metadata></prolog><conbody>
<p>This document introduces you to the DVB-H Receiver Information library. </p>
<section><title>Purpose</title> <p>The DVB-H Receiver Information library
provides the functionality to get information about the DVB-H receiver and
track its usage. </p> </section>
<section><title>DVB-H Receiver Information Library Details</title><p>The Symbian
platform does not include an implementation of this API, but a lib is provided,
along with stub functionality, allowing you to implement your own DVB-H information
receiver. In order to use this API you must include <filepath>dvbhreceiverinfo.h</filepath> in
your code. This will import the necessary functionality of <filepath>dvbhreceiverinfo.lib</filepath>,
such as the <xref href="GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736.dita"><apiname>CDvbhReceiverInfo</apiname></xref> class to your code. </p> <table id="GUID-14B23517-500D-5942-BD08-E5BB0F868DF2">
<tgroup cols="3"><colspec colname="col0"/><colspec colname="col1"/><colspec colname="col2"/>
<thead>
<row>
<entry>DLL</entry>
<entry>LIB</entry>
<entry>Short Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><p> <b>You must create your own *.dll file, Symbian do not supply one.</b>  </p> </entry>
<entry><p> <filepath>dvbhreceiverinfo.lib</filepath>  </p> </entry>
<entry><p>Provides the functionality stubs to allow device creators to create
their own implementation. </p> </entry>
</row>
</tbody>
</tgroup>
</table></section>
<section><title>Architectural Relationship</title> <p>This API is part of
the Mobile TV DVB-H Receiver HAI component. </p> </section>
<section><title>Description</title> <p>DVB-H Receiver Information API allows
you to retrieve information about the signal and the hardware. It is not possible
to change or interfere with the operation of the receiver by using <xref href="GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736.dita"><apiname>CDvbhReceiverInfo</apiname></xref> class
but only to read the information. </p> <p>DVB-H Receiver Information API is
used to: </p> <ul>
<li id="GUID-3A5AB9CE-06C4-5F96-85AD-1843ABCA8E36"><p>Retrieve current receiver
state, signal quality, platform, network time and frequency </p> </li>
<li id="GUID-123543F4-5B16-578A-B479-EBD078540C5D"><p>Retrieves performance
data of the receiver </p> </li>
<li id="GUID-394F54E6-5836-591B-BA90-92448E0A2433"><p>Notify the request of
receiver state, signal quality, platform, network time and frequency. </p> </li>
</ul> <p>This API does not provide access to the DVB-H datagram packets but
to information about the IP packets and the state of the hardware. To access
the DVB-H data stream use the <xref href="GUID-F0C47F37-354B-51BD-B607-D4575C249DC8.dita">DVB-H
Receiver API</xref>. </p> </section>
<section><title>Key DVB-H Receiver Information Library Classes</title> <p>The
key classe of the DVB-H Receiver Information API is </p> <ul>
<li id="GUID-CB96B20B-B5B7-5647-99E1-8671F3B5E021"><p> <xref href="GUID-599BA755-F3E0-36BB-9581-AEC026ECC036.dita"><apiname>CDVBHReceiverInfo</apiname></xref>  </p> <p>This
class is used to create appropriate function calls to perform the various
information requests. </p> </li>
</ul> <p>The class diagram of <xref href="GUID-599BA755-F3E0-36BB-9581-AEC026ECC036.dita"><apiname>CDVBHReceiverInfo</apiname></xref> is shown
below: </p> <fig id="GUID-A659713A-CE42-5E5B-AAD9-A4E94D81C39C">
<image href="GUID-F7181D22-8607-56CE-B8CC-77AE0E378503_d0e532340_href.png" placement="inline"/>
</fig> <p>The enhanced functionality of <xref href="GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736.dita"><apiname>CDvbhReceiverInfo</apiname></xref> API
are provided by a number of additional utilty classes, they are such as: </p> <ul>
<li id="GUID-15AA6C87-EB57-57BC-9375-7CC6FBD3E197"><p> <xref href="GUID-495FBE09-313A-359F-84D0-763B79306C00.dita"><apiname>MDvbhNetworkIdObserver</apiname></xref> :
To observer interface for tracking changes in network id. </p> <p> </p> </li>
<li id="GUID-C0C6DC5E-A5BB-5CDF-A1B5-66AD34D7276E"><p> <xref href="GUID-E03EB6B3-A318-3401-9B39-9ECDF25F3935.dita"><apiname>MDvbhStateObserver</apiname></xref> :
To observer interface for receiver state changes. </p> </li>
<li id="GUID-385F2E11-A372-5FFC-859E-85DF17589770"><p> <xref href="GUID-9A76F530-3177-3490-BD52-7F9528179C73.dita"><apiname>MDvbhNetworkTimeObserver</apiname></xref> :
To observe interface for tracking updates in network time. </p> <p> </p> </li>
<li id="GUID-E251C854-8D96-56A6-AB59-1D0AD1ADADB5"><p> <xref href="GUID-5461F8B8-4DF7-3E64-BB3E-B06138CAD364.dita"><apiname>MDvbhSignalQualityObserver</apiname></xref> :
To observe interface for tracking signal quality of DVB-H reception. </p> <p> </p> </li>
<li id="GUID-7CC2378B-31F6-54B3-AB31-851CC90F628E"><p> <xref href="GUID-5956E1FB-7A62-304F-9301-ED079FC37DDF.dita"><apiname>MDvbhFrequencyObserver</apiname></xref> :
To observer interface for tracking changes in frequency. </p> </li>
<li id="GUID-7DFA01E9-A6A0-552B-95F8-B96BF3ACE55E"><p> <xref href="GUID-67FE4031-3B14-378B-BEB0-3B606F2F5CD0.dita"><apiname>MDvbhPlatformObserver</apiname></xref> :
To observer interface for tracking changes to the selected DVB-H platform. </p> </li>
</ul> </section>
<section><title>Using DVB-H Receiver Information Library</title> <ul>
<li id="GUID-4FE07606-0CE3-5CF6-BE02-7535763FD7ED"><p>This library retrieves
you some current information like state of the receiver, quality of the DVB-H
signal, performance metrics, network time and frequency. </p> </li>
</ul> <ul>
<li id="GUID-9BBA13A1-3007-5741-AC36-1BA3C9620B81"><p>This library receives
you notification changes of state, signal quality, platform, frequency and
network time. </p> </li>
</ul> </section>
</conbody><related-links>
<link href="GUID-A66DF817-736E-53E5-869A-AD67A27E4410.dita"><linktext>Accessing
DVB-H Receiver Information Tutorial</linktext></link>
<link href="GUID-24BD5003-7E85-5BDF-A991-0D0DAE45B5DE.dita"><linktext>Receiver
Information Notified Changes Tutorial</linktext></link>
</related-links></concept>