<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>oRTP: include/ortp/telephonyevents.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">oRTP
 <span id="projectnumber">0.20.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">include/ortp/telephonyevents.h File Reference</div> </div>
</div>
<div class="contents">
<p>Receiving and sending telephone events (RFC2833)
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <<a class="el" href="rtpsession_8h_source.html">ortp/rtpsession.h</a>></code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for telephonyevents.h:</div>
<div class="dyncontent">
<div class="center"><img src="telephonyevents_8h__incl.png" border="0" usemap="#include_2ortp_2telephonyevents_8h" alt=""/></div>
<map name="include_2ortp_2telephonyevents_8h" id="include_2ortp_2telephonyevents_8h">
<area shape="rect" id="node3" href="rtpsession_8h.html" title="The RtpSession api." alt="" coords="814,80,932,107"/><area shape="rect" id="node5" href="port_8h_source.html" title="ortp/port.h" alt="" coords="643,304,724,331"/><area shape="rect" id="node33" href="rtp_8h_source.html" title="ortp/rtp.h" alt="" coords="761,155,835,181"/><area shape="rect" id="node36" href="str__utils_8h_source.html" title="ortp/str_utils.h" alt="" coords="818,229,923,256"/><area shape="rect" id="node39" href="payloadtype_8h.html" title="Using and creating standart and custom RTP profiles." alt="" coords="451,229,580,256"/><area shape="rect" id="node42" href="sessionset_8h.html" title="Sending and receiving multiple streams together with only one thread." alt="" coords="989,304,1112,331"/><area shape="rect" id="node48" href="rtcp_8h_source.html" title="ortp/rtcp.h" alt="" coords="605,229,685,256"/><area shape="rect" id="node52" href="rtpsignaltable_8h_source.html" title="ortp/rtpsignaltable.h" alt="" coords="1100,155,1235,181"/><area shape="rect" id="node54" href="event_8h_source.html" title="ortp/event.h" alt="" coords="911,155,1001,181"/></map>
</div>
</div>
<p><a href="telephonyevents_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__telephone__event.html">_telephone_event</a></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab091cd5f688bc33209cb59a056a7f37c"></a><!-- doxytag: member="telephonyevents.h::TELEPHONY_EVENTS_ALLOCATED_SIZE" ref="ab091cd5f688bc33209cb59a056a7f37c" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TELEPHONY_EVENTS_ALLOCATED_SIZE</b>   (4*sizeof(<a class="el" href="struct__telephone__event.html">telephone_event_t</a>))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af035c1e5ee22a73492d87c20d75bb22a"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_0" ref="af035c1e5ee22a73492d87c20d75bb22a" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_0</b>   (0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf9ac8bf924eb4c066e546a693380229"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_1" ref="abf9ac8bf924eb4c066e546a693380229" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_1</b>   (1)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f926a88a750f35ae969e2b41d471cfb"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_2" ref="a6f926a88a750f35ae969e2b41d471cfb" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_2</b>   (2)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2664875987d68e0a3c36cf5d2e45e21a"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_3" ref="a2664875987d68e0a3c36cf5d2e45e21a" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_3</b>   (3)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b37152d54027fbb6285a86f5eb01e1e"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_4" ref="a4b37152d54027fbb6285a86f5eb01e1e" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_4</b>   (4)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee78f60227098c3622e76bdc95a753c7"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_5" ref="aee78f60227098c3622e76bdc95a753c7" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_5</b>   (5)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a452e6ed6839ea48eeb6d3bd7c69aae94"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_6" ref="a452e6ed6839ea48eeb6d3bd7c69aae94" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_6</b>   (6)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a460f32ae9b51432e2fb54492510ae561"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_7" ref="a460f32ae9b51432e2fb54492510ae561" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_7</b>   (7)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aca47e22b3beb2e218407e029129cafe8"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_8" ref="aca47e22b3beb2e218407e029129cafe8" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_8</b>   (8)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa587614010667c672ec3caa07093505d"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_9" ref="aa587614010667c672ec3caa07093505d" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_9</b>   (9)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0aa5b20d2d31db35bac4fd8c6658eb3"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_STAR" ref="ab0aa5b20d2d31db35bac4fd8c6658eb3" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_STAR</b>   (10)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d5f8db428d9b715399010c5ae059178"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_POUND" ref="a5d5f8db428d9b715399010c5ae059178" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_POUND</b>   (11)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1217d0b7995679d3eb7a6445cc647f59"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_A" ref="a1217d0b7995679d3eb7a6445cc647f59" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_A</b>   (12)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef6cfaef85c9feee12fa2b81a233d2c1"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_B" ref="aef6cfaef85c9feee12fa2b81a233d2c1" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_B</b>   (13)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22d83aeeec14757d6dfa7221f187042b"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_C" ref="a22d83aeeec14757d6dfa7221f187042b" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_C</b>   (14)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa21a7bc04a2e87dde3c34bcf79a666c5"></a><!-- doxytag: member="telephonyevents.h::TEV_DTMF_D" ref="aa21a7bc04a2e87dde3c34bcf79a666c5" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_DTMF_D</b>   (15)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab59963c772565026ba3e719c722512d4"></a><!-- doxytag: member="telephonyevents.h::TEV_FLASH" ref="ab59963c772565026ba3e719c722512d4" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>TEV_FLASH</b>   (16)</td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a998c7fcf7150461aef2c75dc797df90c"></a><!-- doxytag: member="telephonyevents.h::telephone_event_t" ref="a998c7fcf7150461aef2c75dc797df90c" args="" -->
typedef struct <a class="el" href="struct__telephone__event.html">_telephone_event</a> </td><td class="memItemRight" valign="bottom"><b>telephone_event_t</b></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="telephonyevents_8h.html#a5a02d3fbbb0ae7eb98827435b85101a7">rtp_session_telephone_events_supported</a> (<a class="el" href="struct__RtpSession.html">RtpSession</a> *session)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="telephonyevents_8h.html#a3983865006c85c4fba770c79c6addd09">rtp_session_send_telephone_events_supported</a> (<a class="el" href="struct__RtpSession.html">RtpSession</a> *session)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="telephonyevents_8h.html#aa293218d9bda13e0a30bd71140ad49f2">rtp_session_recv_telephone_events_supported</a> (<a class="el" href="struct__RtpSession.html">RtpSession</a> *session)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmsgb.html">mblk_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="telephonyevents_8h.html#a2bcdb4dc9c3bee5e7c54d03a0032f831">rtp_session_create_telephone_event_packet</a> (<a class="el" href="struct__RtpSession.html">RtpSession</a> *session, int start)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="telephonyevents_8h.html#ae76f4651f4aa5fe57bfb28e32df9425f">rtp_session_add_telephone_event</a> (<a class="el" href="struct__RtpSession.html">RtpSession</a> *session, <a class="el" href="structmsgb.html">mblk_t</a> *packet, uint8_t event, int end, uint8_t volume, uint16_t duration)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="telephonyevents_8h.html#a2b92978f94e772570c0811605a590549">rtp_session_read_telephone_event</a> (<a class="el" href="struct__RtpSession.html">RtpSession</a> *session, <a class="el" href="structmsgb.html">mblk_t</a> *packet, <a class="el" href="struct__telephone__event.html">telephone_event_t</a> **tab)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="telephonyevents_8h.html#ae6ec6661b0d2cb3df245438e0f658fc6">rtp_session_send_dtmf</a> (<a class="el" href="struct__RtpSession.html">RtpSession</a> *session, char dtmf, uint32_t userts)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="telephonyevents_8h.html#a6be95ca243aaefcb23c90450c2900fb6">rtp_session_send_dtmf2</a> (<a class="el" href="struct__RtpSession.html">RtpSession</a> *session, char dtmf, uint32_t userts, int duration)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a784ea862a1eee91b91baf6a0bfd4e9b3"></a><!-- doxytag: member="telephonyevents.h::rtp_session_check_telephone_events" ref="a784ea862a1eee91b91baf6a0bfd4e9b3" args="(RtpSession *session, mblk_t *m0)" -->
void </td><td class="memItemRight" valign="bottom"><b>rtp_session_check_telephone_events</b> (<a class="el" href="struct__RtpSession.html">RtpSession</a> *session, <a class="el" href="structmsgb.html">mblk_t</a> *m0)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Receiving and sending telephone events (RFC2833) </p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="ae76f4651f4aa5fe57bfb28e32df9425f"></a><!-- doxytag: member="telephonyevents.h::rtp_session_add_telephone_event" ref="ae76f4651f4aa5fe57bfb28e32df9425f" args="(RtpSession *session, mblk_t *packet, uint8_t event, int end, uint8_t volume, uint16_t duration)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtp_session_add_telephone_event </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__RtpSession.html">RtpSession</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmsgb.html">mblk_t</a> * </td>
<td class="paramname"><em>packet</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>volume</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>duration</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>a rtp session. </td></tr>
<tr><td class="paramname">packet</td><td>a rtp packet as a mblk_t </td></tr>
<tr><td class="paramname">event</td><td>the event type as described in rfc2833, ie one of the TEV_* macros. </td></tr>
<tr><td class="paramname">end</td><td>a boolean to indicate if the end bit should be set. (end of tone) </td></tr>
<tr><td class="paramname">volume</td><td>the volume of the telephony tone, as described in rfc2833 </td></tr>
<tr><td class="paramname">duration</td><td>the duration of the telephony tone, in timestamp unit.</td></tr>
</table>
</dd>
</dl>
<p>Adds a named telephony event to a rtp packet previously allocated using <a class="el" href="telephonyevents_8h.html#a2bcdb4dc9c3bee5e7c54d03a0032f831">rtp_session_create_telephone_event_packet()</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success. </dd></dl>
</div>
</div>
<a class="anchor" id="a2bcdb4dc9c3bee5e7c54d03a0032f831"></a><!-- doxytag: member="telephonyevents.h::rtp_session_create_telephone_event_packet" ref="a2bcdb4dc9c3bee5e7c54d03a0032f831" args="(RtpSession *session, int start)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmsgb.html">mblk_t</a>* rtp_session_create_telephone_event_packet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__RtpSession.html">RtpSession</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>start</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allocates a new rtp packet to be used to add named telephony events. The application can use then <a class="el" href="telephonyevents_8h.html#ae76f4651f4aa5fe57bfb28e32df9425f">rtp_session_add_telephone_event()</a> to add named events to the packet. Finally the packet has to be sent with <a class="el" href="rtpsession_8h.html#afda0872c335c06a86a45ca4591a8b7ee">rtp_session_sendm_with_ts()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>a rtp session. </td></tr>
<tr><td class="paramname">start</td><td>boolean to indicate if the marker bit should be set.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a message block containing the rtp packet if successfull, NULL if the rtp session cannot support telephony event (because the rtp profile it is bound to does not include a telephony event payload type). </dd></dl>
</div>
</div>
<a class="anchor" id="a2b92978f94e772570c0811605a590549"></a><!-- doxytag: member="telephonyevents.h::rtp_session_read_telephone_event" ref="a2b92978f94e772570c0811605a590549" args="(RtpSession *session, mblk_t *packet, telephone_event_t **tab)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtp_session_read_telephone_event </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__RtpSession.html">RtpSession</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmsgb.html">mblk_t</a> * </td>
<td class="paramname"><em>packet</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct__telephone__event.html">telephone_event_t</a> ** </td>
<td class="paramname"><em>tab</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads telephony events from a rtp packet. * points to the beginning of the event buffer.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>a rtp session from which telephony events are received. </td></tr>
<tr><td class="paramname">packet</td><td>a rtp packet as a mblk_t. </td></tr>
<tr><td class="paramname">tab</td><td>the address of a pointer. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of events in the packet if successfull, 0 if the packet did not contain telephony events. </dd></dl>
</div>
</div>
<a class="anchor" id="aa293218d9bda13e0a30bd71140ad49f2"></a><!-- doxytag: member="telephonyevents.h::rtp_session_recv_telephone_events_supported" ref="aa293218d9bda13e0a30bd71140ad49f2" args="(RtpSession *session)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtp_session_recv_telephone_events_supported </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__RtpSession.html">RtpSession</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tells whether telephone event payload type is supported for receiving within the context of the rtp session. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>a rtp session</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the payload type number used for telephony events if found, -1 if not found. </dd></dl>
</div>
</div>
<a class="anchor" id="ae6ec6661b0d2cb3df245438e0f658fc6"></a><!-- doxytag: member="telephonyevents.h::rtp_session_send_dtmf" ref="ae6ec6661b0d2cb3df245438e0f658fc6" args="(RtpSession *session, char dtmf, uint32_t userts)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtp_session_send_dtmf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__RtpSession.html">RtpSession</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>dtmf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>userts</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This functions creates telephony events packets for dtmf and sends them. It uses <a class="el" href="telephonyevents_8h.html#a2bcdb4dc9c3bee5e7c54d03a0032f831">rtp_session_create_telephone_event_packet()</a> and <a class="el" href="telephonyevents_8h.html#ae76f4651f4aa5fe57bfb28e32df9425f">rtp_session_add_telephone_event()</a> to create them and finally <a class="el" href="rtpsession_8h.html#afda0872c335c06a86a45ca4591a8b7ee">rtp_session_sendm_with_ts()</a> to send them.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>a rtp session </td></tr>
<tr><td class="paramname">dtmf</td><td>a character meaning the dtmf (ex: '1', '#' , '9' ...) </td></tr>
<tr><td class="paramname">userts</td><td>the timestamp </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successfull, -1 if the session cannot support telephony events or if the dtmf given as argument is not valid. </dd></dl>
</div>
</div>
<a class="anchor" id="a6be95ca243aaefcb23c90450c2900fb6"></a><!-- doxytag: member="telephonyevents.h::rtp_session_send_dtmf2" ref="a6be95ca243aaefcb23c90450c2900fb6" args="(RtpSession *session, char dtmf, uint32_t userts, int duration)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtp_session_send_dtmf2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__RtpSession.html">RtpSession</a> * </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>dtmf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>userts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>duration</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A variation of <a class="el" href="telephonyevents_8h.html#ae6ec6661b0d2cb3df245438e0f658fc6">rtp_session_send_dtmf()</a> with duration specified.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>a rtp session </td></tr>
<tr><td class="paramname">dtmf</td><td>a character meaning the dtmf (ex: '1', '#' , '9' ...) </td></tr>
<tr><td class="paramname">userts</td><td>the timestamp </td></tr>
<tr><td class="paramname">duration</td><td>duration of the dtmf in timestamp units </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successfull, -1 if the session cannot support telephony events or if the dtmf given as argument is not valid. </dd></dl>
</div>
</div>
<a class="anchor" id="a3983865006c85c4fba770c79c6addd09"></a><!-- doxytag: member="telephonyevents.h::rtp_session_send_telephone_events_supported" ref="a3983865006c85c4fba770c79c6addd09" args="(RtpSession *session)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtp_session_send_telephone_events_supported </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__RtpSession.html">RtpSession</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tells whether telephone event payload type is supported for send within the context of the rtp session. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>a rtp session</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the payload type number used for telephony events if found, -1 if not found. </dd></dl>
</div>
</div>
<a class="anchor" id="a5a02d3fbbb0ae7eb98827435b85101a7"></a><!-- doxytag: member="telephonyevents.h::rtp_session_telephone_events_supported" ref="a5a02d3fbbb0ae7eb98827435b85101a7" args="(RtpSession *session)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rtp_session_telephone_events_supported </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__RtpSession.html">RtpSession</a> * </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tells whether telephony events payload type is supported within the context of the rtp session. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>a rtp session</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the payload type number used for telephony events if found, -1 if not found. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Sat Feb 25 2012 10:01:30 for oRTP by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5
</small></address>
</body>
</html>
