<?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 xml:lang="en" id="GUID-A66DF817-736E-53E5-869A-AD67A27E4410"><title>Accessing DVB-H Receiver Information</title><prolog><metadata><keywords/></metadata></prolog><conbody><p>This document is about accessing the DVB-H receiver information. </p> <section><title>Purpose</title> <p>The purpose of this tutorial is to retrieve current information about the receiver. </p> <p><b>Required Background</b> </p> <p> <xref href="GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736.dita"><apiname>CDvbhReceiverInfo</apiname></xref> supplies static " getter" methods which may be used to retrieve information about the receiver. These methods are described in more detail in Setup and Configuration Requirements section below. </p> <p><b>Introduction</b> </p> <p>The following receiver information may be queried as follows: </p> <ul><li id="GUID-651328F5-63E9-56A1-8F51-AB02CB80AFEA"><p>state </p> </li> <li id="GUID-F7BD97A0-3738-547F-9EDA-8739D4FE6D41"><p>signal quality </p> </li> <li id="GUID-F0552A41-6FAB-559D-A7EA-5FF492C0929D"><p>platform </p> </li> <li id="GUID-DD394408-8BE3-552D-89D1-3DA84AD2E0B9"><p>performance data </p> </li> <li id="GUID-D659136F-0C8A-5BFE-8003-08CDAAE1B231"><p>network time </p> </li> <li id="GUID-6DCFF543-610E-58DC-93C6-9B38ABF77C61"><p>frequency </p> </li> <li id="GUID-4EB63721-8A0A-5A62-8F4D-69FEB8C523D2"><p>Cell Id </p> </li> <li id="GUID-0B9A0C4B-A74A-5AC1-AB51-DDD4740704DA"><p>Network Id </p> </li> </ul> <p><b>Setup and Configuration Requirements</b> </p> <p>To retreive any of the above information you simply have to call one of the following static methods on <xref href="GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736.dita"><apiname>CDvbhReceiverInfo</apiname></xref>. </p> <ul><li id="GUID-E5969884-1FF1-57DF-863E-FCAB8862E173"><p>To retrieve the current state of the receiver, call <xref href="GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736.dita#GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736/GUID-FE27121A-C61C-3F5A-8A4F-F5991137AC22"><apiname>CDvbhReceiverInfo::GetState()</apiname></xref>  </p> </li> <li id="GUID-9FCF50A1-D773-5B00-9AB9-C2FF54EF5DD9"><p>To retrieve the quality of the DVB-H signal, call <xref href="GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736.dita#GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736/GUID-5C3AF450-9902-3BF3-83FE-F57048002AF2"><apiname>CDvbhReceiverInfo::GetSignalQuality()</apiname></xref>  </p> </li> <li id="GUID-71ADB195-8AE9-5CD5-969D-52A4FD50FD43"><p>To retrieve the currently set IP platform, call <xref href="GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736.dita#GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736/GUID-9EB3D6AA-5D83-35E6-801C-DE6A011736D0"><apiname>CDvbhReceiverInfo::GetPlatform()</apiname></xref>  </p> </li> <li id="GUID-1FEA7475-2169-5351-B348-9CC341A11806"><p>To retrieve the current performance metrics, call <xref href="GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736.dita#GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736/GUID-C34E67EA-14F3-3B08-A1ED-B138FB2612A3"><apiname>CDvbhReceiverInfo::GetPerformanceData()</apiname></xref>  </p> </li> <li id="GUID-F827C5B3-C81C-5A43-BAA1-EC94E80D28F9"><p>To retrieve the current network time, call <xref href="GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736.dita#GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736/GUID-CCF2213D-BFCC-3C0D-852A-06BDBD6A07A8"><apiname>CDvbhReceiverInfo::GetNetworkTime()</apiname></xref>  </p> </li> <li id="GUID-357CB90E-B457-5ED1-9BDA-79198C252FB1"><p>To retrieve the current frequency, call <xref href="GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736.dita#GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736/GUID-FF48DF3D-B6B4-3182-86D4-60C325252CCC"><apiname>CDvbhReceiverInfo::GetFrequency()</apiname></xref>  </p> </li> <li id="GUID-8490394B-81BA-5C67-AF69-8CE149A78948"><p>To retrieve the current cellId, call <xref href="GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736.dita#GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736/GUID-E29D1961-4A95-32E4-B7BA-DD02DEBE3CE0"><apiname>CDvbhReceiverInfo::GetCellId()</apiname></xref>  </p> </li> <li id="GUID-C97EFEB1-6095-5AFA-930E-132F603A5DFE"><p>To retrieve the current networkId, call <xref href="GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736.dita#GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736/GUID-A43AA358-DE20-36EB-A86D-3430DEF0C297"><apiname>CDvbhReceiverInfo::GetNetworkId()</apiname></xref>. </p> </li> </ul> </section> <section><title>Using Accessing DVB-H Receiver Information Tutorial </title> <p>The following tasks will be covered in this tutorial: </p> <ul><li id="GUID-09B0D70D-C205-5E2E-A395-569EB0065F80"><p><xref href="GUID-A66DF817-736E-53E5-869A-AD67A27E4410.dita#GUID-A66DF817-736E-53E5-869A-AD67A27E4410/GUID-E891523F-E484-5280-97B8-B09060AE6F4C"> How to retrieve the current information about the receiver</xref>  </p> </li> </ul> <p id="GUID-E891523F-E484-5280-97B8-B09060AE6F4C"><b>Basic Procedure</b> </p> <p>The high level steps to retrieve current information about the receiver are shown here: </p> <ol id="GUID-9BB47CB8-B4AC-52DE-892D-117F046DE0BE"><li id="GUID-D6A10508-C048-569D-8133-D09E1605CD6B"><p>You must call the appropriate getter method to retrieve the current information. For example in order to get information about signal quality, call <xref href="GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736.dita#GUID-CC7A9DBB-559F-3773-BEA4-BD56F495F736/GUID-5C3AF450-9902-3BF3-83FE-F57048002AF2"><apiname>CDvbhReceiverInfo::GetSignalQuality()</apiname></xref>. </p> <p>An example flow, to get signal quality is shown below. </p> </li> </ol> <p><b>Example </b> </p> <codeblock id="GUID-1440E0E5-3D56-5F4D-9F37-B71695D55212" xml:space="preserve">

TDvbhState currentState;

User::LeaveIfError(CDvbhReceiverInfo::GetState(currentState));

//Have obtained the current state.

if (currentState == EDvbhReceivingState)

    {

    //Receiver is in the right state to call GetSignalQuality()

    TDvbhSignalQuality currentSignalQuality;

    //Do not expect the following to leave.

    User::LeaveIfError(CDvbhReceiverInfo::GetSignalQuality(

                                                 currentSignalQuality));

    }

else

    {

    //Receiver is not in the right state for GetSignalQuality(). 

    }

</codeblock> </section> </conbody><related-links><link href="GUID-24BD5003-7E85-5BDF-A991-0D0DAE45B5DE.dita"><linktext>Receiver Information Notifications