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