qiurui
/
uvgrtp-base
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
uvgrtp-base/docs/html/classuvgrtp_1_1session.html

252 lines
15 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>uvgRTP: uvgrtp::session Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">uvgRTP<span id="projectnumber">&#160;3.1.1</span>
</div>
<div id="projectbrief">An open-source library for RTP/SRTP media delivery</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>uvgrtp</b></li><li class="navelem"><a class="el" href="classuvgrtp_1_1session.html">session</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classuvgrtp_1_1session-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">uvgrtp::session Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Provides ZRTP synchronization and can be used to create <a class="el" href="classuvgrtp_1_1media__stream.html" title="The media_stream is an entity which represents one RTP stream.">uvgrtp::media_stream</a> objects.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="session_8hh_source.html">session.hh</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0b9fb48e95cbfdb76fd9f61e8cafe8e4" id="r_a0b9fb48e95cbfdb76fd9f61e8cafe8e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvgrtp_1_1media__stream.html">uvgrtp::media_stream</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0b9fb48e95cbfdb76fd9f61e8cafe8e4">create_stream</a> (uint16_t src_port, uint16_t dst_port, rtp_format_t fmt, int rce_flags)</td></tr>
<tr class="memdesc:a0b9fb48e95cbfdb76fd9f61e8cafe8e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a uni- or bidirectional media stream. <br /></td></tr>
<tr class="separator:a0b9fb48e95cbfdb76fd9f61e8cafe8e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07a96e787de86d902d5c4d6bcb3dc416" id="r_a07a96e787de86d902d5c4d6bcb3dc416"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvgrtp_1_1media__stream.html">uvgrtp::media_stream</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a07a96e787de86d902d5c4d6bcb3dc416">create_stream</a> (uint16_t port, rtp_format_t fmt, int rce_flags)</td></tr>
<tr class="memdesc:a07a96e787de86d902d5c4d6bcb3dc416"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a unidirectional <a class="el" href="classuvgrtp_1_1media__stream.html" title="The media_stream is an entity which represents one RTP stream.">media_stream</a> for an RTP session. <br /></td></tr>
<tr class="separator:a07a96e787de86d902d5c4d6bcb3dc416"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a291629a3bfb910463b88d8edb3984149" id="r_a291629a3bfb910463b88d8edb3984149"><td class="memItemLeft" align="right" valign="top">rtp_error_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a291629a3bfb910463b88d8edb3984149">destroy_stream</a> (<a class="el" href="classuvgrtp_1_1media__stream.html">uvgrtp::media_stream</a> *stream)</td></tr>
<tr class="memdesc:a291629a3bfb910463b88d8edb3984149"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy a media stream. <br /></td></tr>
<tr class="separator:a291629a3bfb910463b88d8edb3984149"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides ZRTP synchronization and can be used to create <a class="el" href="classuvgrtp_1_1media__stream.html" title="The media_stream is an entity which represents one RTP stream.">uvgrtp::media_stream</a> objects. </p>
<p>By itself session does not do anything. The actual RTP streaming is done by <a class="el" href="classuvgrtp_1_1media__stream.html" title="The media_stream is an entity which represents one RTP stream.">media_stream</a> objects, which can be created by session. <a class="el" href="classuvgrtp_1_1media__stream.html" title="The media_stream is an entity which represents one RTP stream.">media_stream</a> corresponds to an RTP session in RFC 3550. </p>
<p class="definition">Definition at line <a class="el" href="session_8hh_source.html#l00027">27</a> of file <a class="el" href="session_8hh_source.html">session.hh</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a07a96e787de86d902d5c4d6bcb3dc416" name="a07a96e787de86d902d5c4d6bcb3dc416"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07a96e787de86d902d5c4d6bcb3dc416">&#9670;&#160;</a></span>create_stream() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classuvgrtp_1_1media__stream.html">uvgrtp::media_stream</a> * uvgrtp::session::create_stream </td>
<td>(</td>
<td class="paramtype">uint16_t</td> <td class="paramname"><span class="paramname"><em>port</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">rtp_format_t</td> <td class="paramname"><span class="paramname"><em>fmt</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>rce_flags</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a unidirectional <a class="el" href="classuvgrtp_1_1media__stream.html" title="The media_stream is an entity which represents one RTP stream.">media_stream</a> for an RTP session. </p>
<p>The created object is used for sending or receiving media, see documentation for <a class="el" href="classuvgrtp_1_1media__stream.html" title="The media_stream is an entity which represents one RTP stream.">uvgrtp::media_stream</a> for more details.</p>
<p>User can enable and disable functionality of uvgRTP by OR'ing (using |) RCE_* flags together and passing them using the rce_flags parameter. The RCE_SEND_ONLY flag in rce_flags means the port is interpreted as a remote port. The RCE_RECEIVE_ONLY means the port is used for binding to a local interface. Without either flag, this function defaults to RCE_SEND_ONLY.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">port</td><td>Either local or remote port depending on rce_flags </td></tr>
<tr><td class="paramname">fmt</td><td>Format of the media stream. see <a class="el" href="util_8hh.html#a313c6640ac5ed9384184a94ec57a9a96" title="These flags are given to uvgrtp::session::create_stream()">RTP_FORMAT</a> for more details </td></tr>
<tr><td class="paramname">rce_flags</td><td>RTP context enable flags, see <a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2af" title="RTP context enable flags.">RTP_CTX_ENABLE_FLAGS</a> for more details</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>RTP media stream object</dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">uvgrtp::media_stream*</td><td>On success </td></tr>
<tr><td class="paramname">nullptr</td><td>On failure, see print </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0b9fb48e95cbfdb76fd9f61e8cafe8e4" name="a0b9fb48e95cbfdb76fd9f61e8cafe8e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b9fb48e95cbfdb76fd9f61e8cafe8e4">&#9670;&#160;</a></span>create_stream() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classuvgrtp_1_1media__stream.html">uvgrtp::media_stream</a> * uvgrtp::session::create_stream </td>
<td>(</td>
<td class="paramtype">uint16_t</td> <td class="paramname"><span class="paramname"><em>src_port</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t</td> <td class="paramname"><span class="paramname"><em>dst_port</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">rtp_format_t</td> <td class="paramname"><span class="paramname"><em>fmt</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>rce_flags</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a uni- or bidirectional media stream. </p>
<p>The created object is used for sending and/or receiving media, see documentation for <a class="el" href="classuvgrtp_1_1media__stream.html" title="The media_stream is an entity which represents one RTP stream.">uvgrtp::media_stream</a> for more details.</p>
<p>If both addresses were provided when <a class="el" href="classuvgrtp_1_1session.html" title="Provides ZRTP synchronization and can be used to create uvgrtp::media_stream objects.">uvgrtp::session</a> was created, by default uvgRTP binds itself to local_addr:src_port and sends packets to remote_addr:dst_port.</p>
<p>User can enable and disable functionality of <a class="el" href="classuvgrtp_1_1media__stream.html" title="The media_stream is an entity which represents one RTP stream.">media_stream</a> by OR'ing (using |) RCE_* flags together and passing them using the rce_flags parameter. In rce_flags, the RCE_SEND_ONLY flag can be used to avoid binding and src_port is thus ignored. Correspondinly RCE_RECEIVE_ONLY flag means dst_port is ignored. Without either RCE_SEND_ONLY or RCE_RECEIVE_ONLY, and if only one address was provided for session that address is interpreted as remote_addr and binding happens to ANY:src_port.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src_port</td><td>Local port that uvgRTP listens to for incoming RTP packets </td></tr>
<tr><td class="paramname">dst_port</td><td>Remote port where uvgRTP sends RTP packets </td></tr>
<tr><td class="paramname">fmt</td><td>Format of the media stream. see <a class="el" href="util_8hh.html#a313c6640ac5ed9384184a94ec57a9a96" title="These flags are given to uvgrtp::session::create_stream()">RTP_FORMAT</a> for more details </td></tr>
<tr><td class="paramname">rce_flags</td><td>RTP context enable flags, see <a class="el" href="util_8hh.html#a15b2d6364db6065a482c99827f4bd2af" title="RTP context enable flags.">RTP_CTX_ENABLE_FLAGS</a> for more details</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>RTP media stream object</dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">uvgrtp::media_stream*</td><td>On success </td></tr>
<tr><td class="paramname">nullptr</td><td>On failure, see print and </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a291629a3bfb910463b88d8edb3984149" name="a291629a3bfb910463b88d8edb3984149"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a291629a3bfb910463b88d8edb3984149">&#9670;&#160;</a></span>destroy_stream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">rtp_error_t uvgrtp::session::destroy_stream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classuvgrtp_1_1media__stream.html">uvgrtp::media_stream</a> *</td> <td class="paramname"><span class="paramname"><em>stream</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a media stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>Pointer to the media stream that should be destroyed</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>RTP error code</dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">RTP_OK</td><td>On success </td></tr>
<tr><td class="paramname">RTP_INVALID_VALUE</td><td>If stream is nullptr </td></tr>
<tr><td class="paramname">RTP_NOT_FOUND</td><td>If stream does not belong to this session </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="session_8hh_source.html">session.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink