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

134 lines
12 KiB
HTML
Raw Normal View History

docs: Update Doxygen documentation newest version of API
2022-09-16 12:33:51 +00:00
<!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.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
zrtp: Update flag names used to determine the ZRTP mode
2022-09-22 04:35:14 +00:00
<title>uvgRTP: context.hh Source File</title>
docs: Update Doxygen documentation newest version of API
2022-09-16 12:33:51 +00:00
<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>
<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">
Release 2.1.2 This patch release significantly reduces RTCP CPU usage (thanks to #178), extends SCL to support NAL units as small as 4 bytes for H264 and 6 bytes for H265/H266 (including start code prefix). These are the smallest sizes reasonable. This release also fixes a bug where separate NAL units with same timestamps are discarded after first.
2022-11-25 06:48:11 +00:00
<div id="projectname">uvgRTP<span id="projectnumber">&#160;2.1.2</span>
docs: Update Doxygen documentation newest version of API
2022-09-16 12:33:51 +00:00
</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.9.5 -->
<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');
$(document).ready(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"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e3f96ff476f8286b6e150580a2f7bd74.html">uvgrtp</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">context.hh</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &quot;<a class="code" href="util_8hh.html">util.hh</a>&quot;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">namespace </span>uvgrtp {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">class </span>session;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="classuvgrtp_1_1context.html"> 16</a></span> <span class="keyword">class </span><a class="code hl_class" href="classuvgrtp_1_1context.html">context</a> {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="classuvgrtp_1_1context.html#a98be18c2848404549cfadf910ba1573a"> 24</a></span> <a class="code hl_function" href="classuvgrtp_1_1context.html#a98be18c2848404549cfadf910ba1573a">context</a>();</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="classuvgrtp_1_1context.html#a652a201ae11685961267455ab823eb60"> 32</a></span> <a class="code hl_function" href="classuvgrtp_1_1context.html#a652a201ae11685961267455ab823eb60">~context</a>();</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classuvgrtp_1_1context.html#a81b2dc23ebf64d1153410376503eccb4"> 44</a></span> <a class="code hl_class" href="classuvgrtp_1_1session.html">uvgrtp::session</a> *<a class="code hl_function" href="classuvgrtp_1_1context.html#a81b2dc23ebf64d1153410376503eccb4">create_session</a>(std::string address);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classuvgrtp_1_1context.html#a7699c9df53e8e7380d755f374d6fc2ce"> 62</a></span> <a class="code hl_class" href="classuvgrtp_1_1session.html">uvgrtp::session</a> *<a class="code hl_function" href="classuvgrtp_1_1context.html#a7699c9df53e8e7380d755f374d6fc2ce">create_session</a>(std::string remote_addr, std::string local_addr);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="classuvgrtp_1_1context.html#a61daf2f3cdcdf2542ee997ab6de5efa9"> 74</a></span> rtp_error_t <a class="code hl_function" href="classuvgrtp_1_1context.html#a61daf2f3cdcdf2542ee997ab6de5efa9">destroy_session</a>(<a class="code hl_class" href="classuvgrtp_1_1session.html">uvgrtp::session</a> *<a class="code hl_class" href="classuvgrtp_1_1session.html">session</a>);</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> std::string&amp; get_cname();</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="classuvgrtp_1_1context.html#a0ddad3f0a78b6a4b13f2b8fdd15c9087"> 86</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classuvgrtp_1_1context.html#a0ddad3f0a78b6a4b13f2b8fdd15c9087">crypto_enabled</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="comment">/* Generate CNAME for participant using host and login names */</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> std::string generate_cname() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="comment">/* CNAME is the same for all connections */</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> std::string cname_;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> };</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>}</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="keyword">namespace </span>uvg_rtp = uvgrtp;</div>
<div class="ttc" id="aclassuvgrtp_1_1context_html"><div class="ttname"><a href="classuvgrtp_1_1context.html">uvgrtp::context</a></div><div class="ttdoc">Provides CNAME isolation and can be used to create uvgrtp::session objects.</div><div class="ttdef"><b>Definition:</b> <a href="context_8hh_source.html#l00016">context.hh:16</a></div></div>
<div class="ttc" id="aclassuvgrtp_1_1context_html_a0ddad3f0a78b6a4b13f2b8fdd15c9087"><div class="ttname"><a href="classuvgrtp_1_1context.html#a0ddad3f0a78b6a4b13f2b8fdd15c9087">uvgrtp::context::crypto_enabled</a></div><div class="ttdeci">bool crypto_enabled() const</div><div class="ttdoc">Has Crypto++ been included in uvgRTP library.</div></div>
<div class="ttc" id="aclassuvgrtp_1_1context_html_a61daf2f3cdcdf2542ee997ab6de5efa9"><div class="ttname"><a href="classuvgrtp_1_1context.html#a61daf2f3cdcdf2542ee997ab6de5efa9">uvgrtp::context::destroy_session</a></div><div class="ttdeci">rtp_error_t destroy_session(uvgrtp::session *session)</div><div class="ttdoc">Destroy RTP session and all of its media streams.</div></div>
<div class="ttc" id="aclassuvgrtp_1_1context_html_a652a201ae11685961267455ab823eb60"><div class="ttname"><a href="classuvgrtp_1_1context.html#a652a201ae11685961267455ab823eb60">uvgrtp::context::~context</a></div><div class="ttdeci">~context()</div><div class="ttdoc">RTP context destructor.</div></div>
<div class="ttc" id="aclassuvgrtp_1_1context_html_a7699c9df53e8e7380d755f374d6fc2ce"><div class="ttname"><a href="classuvgrtp_1_1context.html#a7699c9df53e8e7380d755f374d6fc2ce">uvgrtp::context::create_session</a></div><div class="ttdeci">uvgrtp::session * create_session(std::string remote_addr, std::string local_addr)</div><div class="ttdoc">Create a new RTP session.</div></div>
<div class="ttc" id="aclassuvgrtp_1_1context_html_a81b2dc23ebf64d1153410376503eccb4"><div class="ttname"><a href="classuvgrtp_1_1context.html#a81b2dc23ebf64d1153410376503eccb4">uvgrtp::context::create_session</a></div><div class="ttdeci">uvgrtp::session * create_session(std::string address)</div><div class="ttdoc">Create a new RTP session.</div></div>
<div class="ttc" id="aclassuvgrtp_1_1context_html_a98be18c2848404549cfadf910ba1573a"><div class="ttname"><a href="classuvgrtp_1_1context.html#a98be18c2848404549cfadf910ba1573a">uvgrtp::context::context</a></div><div class="ttdeci">context()</div><div class="ttdoc">RTP context constructor.</div></div>
<div class="ttc" id="aclassuvgrtp_1_1session_html"><div class="ttname"><a href="classuvgrtp_1_1session.html">uvgrtp::session</a></div><div class="ttdoc">Provides ZRTP synchronization and can be used to create uvgrtp::media_stream objects.</div><div class="ttdef"><b>Definition:</b> <a href="session_8hh_source.html#l00026">session.hh:26</a></div></div>
<div class="ttc" id="autil_8hh_html"><div class="ttname"><a href="util_8hh.html">util.hh</a></div></div>
</div><!-- fragment --></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.9.5
</small></address>
</body>
</html>