Symbian3/PDK/Source/GUID-9652782C-D5A7-584F-A61C-1340D49478A2.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-9652782C-D5A7-584F-A61C-1340D49478A2"><title>Registering for and handling events</title><prolog><metadata><keywords/></metadata></prolog><conbody><p>This page describes how to register an event for a callback function and how to handle them when the event occured. </p> <p>Events can be registered for a session, a send source or a receive source using <codeph>RRtpXxx:RegisterEventCallbackL()</codeph>, where <codeph>Xxx</codeph> can be <codeph>Session</codeph>, <codeph>SendSource</codeph> or <codeph>ReceiveSource</codeph>, for the respective source of events. </p> <codeblock id="GUID-389805C0-3A8E-5270-AEE3-4C9E60C4E6A7" xml:space="preserve">RegisterEventCallbackL(ERtpPacketReceived, GetPacket, aPtr, ERtpOneShot);</codeblock> <p>In the above call, the event <codeph>ERtpPacketReceived</codeph> is registered to the callback function <codeph>GetPacket()</codeph>. <codeph>ERtpOneShot</codeph> indicates that the callback function can be called only once. </p> <p> <codeph>TRtpEvent</codeph> provides a handle to an RTP session, send stream or receive stream event. The event types supported by <codeph>TRtpEventType</codeph> are passed to <codeph>RegisterEventCallbackL()</codeph>, so that the registered callback function is called for the specified event. </p> <p>Some of the event types supported by <codeph>TRtpEventType</codeph> that may be handled are given below: </p> <ul><li id="GUID-4187B54E-E4A1-5A2C-9E4B-2D4C41E84CA5"><p> <codeph>ERtpAnyEvent</codeph> is called for any event failures. </p> </li> <li id="GUID-34E11BD0-2D71-586C-B913-0FE8FFAB4837"><p>Event types related to the session: </p> <ul><li id="GUID-048D9BA1-A3FC-5C48-A4F0-803B3ACE6E04"><p> <codeph>ERtpSessionFail</codeph> indicates a session-level error. </p> </li> <li id="GUID-15D13D17-2B08-5275-A3A9-060B1CE2177B"><p> <codeph>ERtpSessionEventEnd</codeph> defines the upper limit for session event type values. </p> </li> </ul> </li> <li id="GUID-45DA3A9F-4E04-53FB-85FA-9285F173488C"><p>Event types related to the send stream: </p> <ul><li id="GUID-0AFA7AE7-B81D-59A2-9DFE-CC57AC266153"><p> <codeph>ERtpSendFail</codeph> indicates an error has occurred while sending a packet. </p> </li> <li id="GUID-3804EB39-97A6-517A-B4C7-7EFE86B49232"><p> <codeph>ERtpSendSucceeded</codeph> indicates a send packet operation has succeeded. </p> </li> </ul> </li> <li id="GUID-AE3F984B-9816-5B44-AB8F-368008367049"><p>Event types related to the reception stream: </p> <ul><li id="GUID-D651EC2F-72D6-5DED-B017-873734C9B472"><p> <codeph>ERtpNewSource</codeph> indicates that a new stream has been received. </p> </li> <li id="GUID-F6A82FA7-D8C2-5F46-A5D2-2AFAEA1DBAAD"><p> <codeph>ERtpPacketReceived</codeph> indicates that an in-sequence packet has been received. </p> </li> </ul> </li> <li id="GUID-5F9B64A4-FEE5-5CD2-B95E-733FD7381CC1"><p>Event types related to non-RTP data: </p> <ul><li id="GUID-35D36569-71E0-57E5-B398-4D7DB248DCB4"><p> <codeph>ENonRtpDataReceived </codeph> indicates that non-RTP data has been received on the RTP socket. </p> </li> <li id="GUID-3BD0DD09-3244-5E28-901C-4400FF45ADFE"><p> <codeph>ENonRtcpDataReceived</codeph> indicates that non-RTP data has been received on the RTCP socket. </p> </li> </ul> </li> </ul> </conbody></concept>