Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_rtp_file_sender.html
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: CRtpFileSender Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>CRtpFileSender Class Reference</h1><!-- doxytag: class="CRtpFileSender" -->
<p>
<a href="class_c_rtp_file_sender-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rtp_file_sender.html#ecbbd6e4ff98c225474210edde8f02e5">DoPacketSent</a> (const TRtpEvent &aEvent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rtp_file_sender.html#cd993430262ed8a1909fc47b0ef36c99">DoSendError</a> (const TRtpEvent &aEvent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="09469ec6e3b0c977961c4f37532b8268"></a><!-- doxytag: member="CRtpFileSender::StartL" ref="09469ec6e3b0c977961c4f37532b8268" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rtp_file_sender.html#09469ec6e3b0c977961c4f37532b8268">StartL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d247e334ce13904580baf6008e084a1"></a><!-- doxytag: member="CRtpFileSender::SetObserver" ref="7d247e334ce13904580baf6008e084a1" args="(MFileStreamerObserver &aObserver)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rtp_file_sender.html#7d247e334ce13904580baf6008e084a1">SetObserver</a> (<a class="el" href="class_m_file_streamer_observer.html">MFileStreamerObserver</a> &aObserver)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3dc45055b06bff09806ed20fd0b544ba"></a><!-- doxytag: member="CRtpFileSender::~CRtpFileSender" ref="3dc45055b06bff09806ed20fd0b544ba" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rtp_file_sender.html#3dc45055b06bff09806ed20fd0b544ba">~CRtpFileSender</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rtp_file_sender.html#cc0e18b5616ed680f92433c2cc023375">PacketSent</a> (<a class="el" href="class_c_rtp_file_sender.html">CRtpFileSender</a> *aPtr, const TRtpEvent &aEvent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rtp_file_sender.html#2f2435036f8e6ad9e01b9433d8b269b7">SendError</a> (<a class="el" href="class_c_rtp_file_sender.html">CRtpFileSender</a> *aPtr, const TRtpEvent &aEvent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="64c0dc812a3fdd4c5ba8c445a608d763"></a><!-- doxytag: member="CRtpFileSender::NewL" ref="64c0dc812a3fdd4c5ba8c445a608d763" args="(RRtpSession &aSession, RFs &aFs, const TDesC &aSrcFilename, TInt aPacketSize, TInt aDelayMicroSeconds)" -->
static <a class="el" href="class_c_rtp_file_sender.html">CRtpFileSender</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_rtp_file_sender.html#64c0dc812a3fdd4c5ba8c445a608d763">NewL</a> (RRtpSession &aSession, RFs &aFs, const TDesC &aSrcFilename, TInt aPacketSize, TInt aDelayMicroSeconds)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An Active Object which sends a block of a file after every n microseconds as an RTP payload.
<p>Definition at line <a class="el" href="_r_t_p_file_streamer_8h-source.html#l00039">39</a> of file <a class="el" href="_r_t_p_file_streamer_8h-source.html">RTPFileStreamer.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="cc0e18b5616ed680f92433c2cc023375"></a><!-- doxytag: member="CRtpFileSender::PacketSent" ref="cc0e18b5616ed680f92433c2cc023375" args="(CRtpFileSender *aPtr, const TRtpEvent &aEvent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRtpFileSender::PacketSent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_rtp_file_sender.html">CRtpFileSender</a> * </td>
<td class="paramname"> <em>aPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TRtpEvent & </td>
<td class="paramname"> <em>aEvent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A callback method which <a class="el" href="class_c_rtp_file_sender.html">CRtpFileSender</a> registers with the RtpSession to be called when a packet is successfully sent.
<p>Definition at line <a class="el" href="_r_t_p_file_streamer_8cpp-source.html#l00050">50</a> of file <a class="el" href="_r_t_p_file_streamer_8cpp-source.html">RTPFileStreamer.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="ecbbd6e4ff98c225474210edde8f02e5"></a><!-- doxytag: member="CRtpFileSender::DoPacketSent" ref="ecbbd6e4ff98c225474210edde8f02e5" args="(const TRtpEvent &aEvent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRtpFileSender::DoPacketSent </td>
<td>(</td>
<td class="paramtype">const TRtpEvent & </td>
<td class="paramname"> <em>aEvent</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An instance method which is called by the static callback function to notify the observer and start the RTimer such that another packet can be sent when the timer expires.
<p>Definition at line <a class="el" href="_r_t_p_file_streamer_8cpp-source.html#l00060">60</a> of file <a class="el" href="_r_t_p_file_streamer_8cpp-source.html">RTPFileStreamer.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="2f2435036f8e6ad9e01b9433d8b269b7"></a><!-- doxytag: member="CRtpFileSender::SendError" ref="2f2435036f8e6ad9e01b9433d8b269b7" args="(CRtpFileSender *aPtr, const TRtpEvent &aEvent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRtpFileSender::SendError </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_rtp_file_sender.html">CRtpFileSender</a> * </td>
<td class="paramname"> <em>aPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TRtpEvent & </td>
<td class="paramname"> <em>aEvent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A callback method to be called when a sent packet fails.
<p>Definition at line <a class="el" href="_r_t_p_file_streamer_8cpp-source.html#l00073">73</a> of file <a class="el" href="_r_t_p_file_streamer_8cpp-source.html">RTPFileStreamer.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="cd993430262ed8a1909fc47b0ef36c99"></a><!-- doxytag: member="CRtpFileSender::DoSendError" ref="cd993430262ed8a1909fc47b0ef36c99" args="(const TRtpEvent &aEvent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CRtpFileSender::DoSendError </td>
<td>(</td>
<td class="paramtype">const TRtpEvent & </td>
<td class="paramname"> <em>aEvent</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An instance method which is called by the static callback function to notify the observer of the error while sending the packet.
<p>Definition at line <a class="el" href="_r_t_p_file_streamer_8cpp-source.html#l00082">82</a> of file <a class="el" href="_r_t_p_file_streamer_8cpp-source.html">RTPFileStreamer.cpp</a>.</p>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:07 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>