Symbian3/PDK/Source/GUID-D5F57D81-6B59-5C7E-A2C8-A5E29873346B.dita
author Dominic Pinkman <Dominic.Pinkman@Nokia.com>
Tue, 30 Mar 2010 11:56:28 +0100
changeset 5 f345bda72bc4
parent 3 46218c8b8afa
child 14 578be2adaf3e
permissions -rw-r--r--
Week 12 contribution of PDK documentation_content. See release notes for details. Fixes Bug 2054, Bug 1583, Bug 381, Bug 390, Bug 463, Bug 1897, Bug 344, Bug 1319, Bug 394, Bug 1520, Bug 1522, Bug 1892"
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5
f345bda72bc4 Week 12 contribution of PDK documentation_content. See release notes for details. Fixes Bug 2054, Bug 1583, Bug 381, Bug 390, Bug 463, Bug 1897, Bug 344, Bug 1319, Bug 394, Bug 1520, Bug 1522, Bug 1892"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents: 3
diff changeset
     1
<?xml version="1.0" encoding="utf-8"?>
f345bda72bc4 Week 12 contribution of PDK documentation_content. See release notes for details. Fixes Bug 2054, Bug 1583, Bug 381, Bug 390, Bug 463, Bug 1897, Bug 344, Bug 1319, Bug 394, Bug 1520, Bug 1522, Bug 1892"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents: 3
diff changeset
     2
<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
f345bda72bc4 Week 12 contribution of PDK documentation_content. See release notes for details. Fixes Bug 2054, Bug 1583, Bug 381, Bug 390, Bug 463, Bug 1897, Bug 344, Bug 1319, Bug 394, Bug 1520, Bug 1522, Bug 1892"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents: 3
diff changeset
     3
<!-- This component and the accompanying materials are made available under the terms of the License 
f345bda72bc4 Week 12 contribution of PDK documentation_content. See release notes for details. Fixes Bug 2054, Bug 1583, Bug 381, Bug 390, Bug 463, Bug 1897, Bug 344, Bug 1319, Bug 394, Bug 1520, Bug 1522, Bug 1892"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents: 3
diff changeset
     4
"Eclipse Public License v1.0" which accompanies this distribution, 
f345bda72bc4 Week 12 contribution of PDK documentation_content. See release notes for details. Fixes Bug 2054, Bug 1583, Bug 381, Bug 390, Bug 463, Bug 1897, Bug 344, Bug 1319, Bug 394, Bug 1520, Bug 1522, Bug 1892"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents: 3
diff changeset
     5
and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
f345bda72bc4 Week 12 contribution of PDK documentation_content. See release notes for details. Fixes Bug 2054, Bug 1583, Bug 381, Bug 390, Bug 463, Bug 1897, Bug 344, Bug 1319, Bug 394, Bug 1520, Bug 1522, Bug 1892"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents: 3
diff changeset
     6
<!-- Initial Contributors:
f345bda72bc4 Week 12 contribution of PDK documentation_content. See release notes for details. Fixes Bug 2054, Bug 1583, Bug 381, Bug 390, Bug 463, Bug 1897, Bug 344, Bug 1319, Bug 394, Bug 1520, Bug 1522, Bug 1892"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents: 3
diff changeset
     7
    Nokia Corporation - initial contribution.
f345bda72bc4 Week 12 contribution of PDK documentation_content. See release notes for details. Fixes Bug 2054, Bug 1583, Bug 381, Bug 390, Bug 463, Bug 1897, Bug 344, Bug 1319, Bug 394, Bug 1520, Bug 1522, Bug 1892"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents: 3
diff changeset
     8
Contributors: 
f345bda72bc4 Week 12 contribution of PDK documentation_content. See release notes for details. Fixes Bug 2054, Bug 1583, Bug 381, Bug 390, Bug 463, Bug 1897, Bug 344, Bug 1319, Bug 394, Bug 1520, Bug 1522, Bug 1892"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents: 3
diff changeset
     9
-->
f345bda72bc4 Week 12 contribution of PDK documentation_content. See release notes for details. Fixes Bug 2054, Bug 1583, Bug 381, Bug 390, Bug 463, Bug 1897, Bug 344, Bug 1319, Bug 394, Bug 1520, Bug 1522, Bug 1892"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents: 3
diff changeset
    10
<!DOCTYPE concept
f345bda72bc4 Week 12 contribution of PDK documentation_content. See release notes for details. Fixes Bug 2054, Bug 1583, Bug 381, Bug 390, Bug 463, Bug 1897, Bug 344, Bug 1319, Bug 394, Bug 1520, Bug 1522, Bug 1892"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents: 3
diff changeset
    11
  PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
1
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    12
<concept xml:lang="en" id="GUID-D5F57D81-6B59-5C7E-A2C8-A5E29873346B"><title>Managing send and receive reports</title><prolog><metadata><keywords/></metadata></prolog><conbody><p>This page describes the sent reports used to know how the data packets are being sent to the host (SR) and the receive reports used to get the feedback from the receiving hosts (RR). </p> <p>A sent or receive report along with the name of its user on the RTCP (control) port is multi-casted periodically. This is done to have information on who is joining or leaving at any moment and how well you receive the data in a session. </p> <p>The RTCP sender and receiver reports describe one timing and sequence number space for each SSRC and do not carry a payload type field. </p> <section><title>Sending reports</title> <p>A Sender Report has three sections: </p> <ol id="GUID-E9E3CF3F-BEEF-51FC-909C-A3EC55E079E1"><li id="GUID-D12D3E11-1910-5E58-A906-C0A39D56EB65"><p>Header </p> </li> <li id="GUID-765CC21A-FE41-573B-86EF-6947F089E4D0"><p>Sender information, which summarises the data transmissions from current sender. </p> </li> <li id="GUID-C8143D49-5A2E-5E21-A386-341449FFB54B"><p>Reception report block (zero or more), which gives the reception of RTP packets from a single synchronisation source. </p> </li> </ol> <p> <codeph>RRtcpSRPart</codeph> provides the information on the data transmitted from the sender as a sender report (SR). </p> <p>You can access the following information from an SR packet: </p> <p> <codeph>NTPTimeStamp</codeph>: Gets the absolute date and time when the report was sent. This is represented in timestamp format of the Network Time Protocol (NTP), which is in seconds relative to 0h UTC on 1 January 1900. This is used in combination with timestamps returned in reception reports from other receivers to measure round-trip propagation to those receivers. </p> <p> <codeph>RTPTimeStamp</codeph>: Gets the RTP time when this packet was sent. RTP time is profile dependant. </p> <p> <codeph>ByteCount</codeph>: Gets the number of bytes sent. </p> <p> <codeph>PacketCount</codeph>: Gets the total number of RTP data packets transmitted by the sender from the start of the transmission until the time this SR packet was generated. You must reset the count if the sender changes its SSRC identifier. </p> <p> <codeph>Extension</codeph>: Retrieves an extension defined for SR packets (also for RR packets) for any additional information to be reported about sender or receiver. </p> <p> <b>Note:</b>  <codeph>RRtcpSRPart</codeph> does not have a close function as the resources accessed through this handle are owned by object of <codeph>RRtpReceiveSource</codeph>. </p> </section> <section><title>Receiving reports</title> <p>To know how the data packets are being sent to the host, feedback is required from the receiving hosts. <codeph>RRtcpRRItem</codeph> supports you in getting this information as receiving reports. </p> <p> <codeph>RRtcpRRPart</codeph> provides a list of the receipt reports (RR) from the receiving hosts reporting on the send stream. You can also create an RR object by calling <codeph>RRtpSession::GetRRs()</codeph>. </p> <p>To get a specific receive report of a host, call the index operator <codeph>RRtcpRRPart::operator[]</codeph>. This returns an object of <codeph>RRtcpRRItem</codeph>. You can get the total number of receive reports received by calling <codeph>RRtcpRRPart::Count</codeph>. </p> <p>You can get the following information from a receiver report to assess the quality of the service: </p> <p> <codeph>SenderSSRC</codeph>: Gets the sender’s 32-bit numeric synchronisation source identifier. The same is updated in the member table. </p> <p> <codeph>AboutSSRC</codeph>: Gets the SSRC related to the current packet. </p> <p> <codeph>PacketsLost</codeph>: Returns the total number of RTP packets lost from source SSRC since the beginning of the reception. </p> <p> <codeph>FractionLost</codeph>: Returns the fraction of RTP data packets from the source SSRC lost since the previous SR or RR packet was sent. This is the integer part of the product of loss fraction and 256 (loss fraction x 256). </p> <p> <codeph>ExtendedHighestSequenceNumber</codeph>: Gets the extended highest sequence number received in an RTP data packet from the source. </p> <p> <codeph>DelaySinceLastSR</codeph>: Gets the time elapsed from the receipt of the last SR (Sender Report) and the time when current reception report packet was sent. The delay time is expressed in 1/65536 seconds. If no SR packet has been received yet from SSRC, the DLSR field is set to zero. </p> <p> <codeph>InterarrivalJitter</codeph>: Gets the variance of the RTP data packet interarrival time, measured in timestamp units and expressed as an unsigned integer. This gives the measure of network congestion. </p> <p> <codeph>LastSRTimestamp</codeph>: Gets NTP timestamp of the most recent RTCP sender report (SR) packet from source SSRC. If no SR has been received, the field is set to zero. </p> <p>All the preceding information about the data sent to the receiving hosts is used to modify the transmission and also to determine if the problem is local, regional or global. </p> </section> <section><title>See also</title> <p><xref href="GUID-FBA52F3B-0A7A-5FE3-82CD-72F88788D432.dita#GUID-FBA52F3B-0A7A-5FE3-82CD-72F88788D432/GUID-352B33B6-D02B-5ECB-B154-6CB06C21A377">Types of RTCP packets</xref>  </p> <p><xref href="GUID-0ACAFB87-0D45-5BAA-B40A-9A7DC1646B01.dita#GUID-0ACAFB87-0D45-5BAA-B40A-9A7DC1646B01/GUID-663C6781-3137-5D48-A836-6ADDD4474805">Sending various RTCP packets</xref>  </p> </section> </conbody></concept>