2021-02-23 11:46:18 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2022-09-16 12:33:51 +00:00
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
2021-02-23 11:46:18 +00:00
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
2022-09-16 12:33:51 +00:00
< meta http-equiv = "X-UA-Compatible" content = "IE=11" / >
2024-02-20 08:46:32 +00:00
< meta name = "generator" content = "Doxygen 1.10.0" / >
2021-02-23 11:46:18 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > uvgRTP: uvgrtp::context 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 >
2024-02-20 08:46:32 +00:00
< script type = "text/javascript" src = "clipboard.js" > < / script >
< script type = "text/javascript" src = "cookie.js" > < / script >
2021-02-23 11:46:18 +00:00
< 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 >
2022-09-16 12:33:51 +00:00
< tr id = "projectrow" >
< td id = "projectalign" >
2024-02-20 11:10:01 +00:00
< div id = "projectname" > uvgRTP< span id = "projectnumber" >   3.1.1< / span >
2021-02-23 11:46:18 +00:00
< / div >
2022-09-16 12:33:51 +00:00
< div id = "projectbrief" > An open-source library for RTP/SRTP media delivery< / div >
2021-02-23 11:46:18 +00:00
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2024-02-20 08:46:32 +00:00
<!-- Generated by Doxygen 1.10.0 -->
2021-02-23 11:46:18 +00:00
< script type = "text/javascript" >
2022-09-16 12:33:51 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
2021-02-23 11:46:18 +00:00
/* @license-end */
< / script >
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
2022-09-16 12:33:51 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2021-02-23 11:46:18 +00:00
$(function() {
initMenu('',true,false,'search.php','Search');
2024-02-20 08:46:32 +00:00
$(function() { init_search(); });
2021-02-23 11:46:18 +00:00
});
2022-09-16 12:33:51 +00:00
/* @license-end */
< / script >
2021-02-23 11:46:18 +00:00
< 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" >
2022-09-16 12:33:51 +00:00
< 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 >
2021-02-23 11:46:18 +00:00
< / div >
< div id = "nav-path" class = "navpath" >
< ul >
< li class = "navelem" > < b > uvgrtp< / b > < / li > < li class = "navelem" > < a class = "el" href = "classuvgrtp_1_1context.html" > context< / a > < / li > < / ul >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "classuvgrtp_1_1context-members.html" > List of all members< / a > < / div >
2022-09-16 12:33:51 +00:00
< div class = "headertitle" > < div class = "title" > uvgrtp::context Class Reference< / div > < / div >
2021-02-23 11:46:18 +00:00
< / div > <!-- header -->
< div class = "contents" >
2022-09-16 12:33:51 +00:00
< p > Provides CNAME isolation and can be used to create < 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 > objects.
2024-02-20 08:46:32 +00:00
< a href = "#details" > More...< / a > < / p >
2022-09-16 12:33:51 +00:00
< p > < code > #include < < a class = "el" href = "context_8hh_source.html" > context.hh< / a > > < / code > < / p >
2021-02-23 11:46:18 +00:00
< table class = "memberdecls" >
2022-09-16 12:33:51 +00:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "pub-methods" name = "pub-methods" > < / a >
2021-02-23 11:46:18 +00:00
Public Member Functions< / h2 > < / td > < / tr >
2024-02-20 08:46:32 +00:00
< tr class = "memitem:a98be18c2848404549cfadf910ba1573a" id = "r_a98be18c2848404549cfadf910ba1573a" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a98be18c2848404549cfadf910ba1573a" > context< / a > ()< / td > < / tr >
2023-03-13 13:15:14 +00:00
< tr class = "memdesc:a98be18c2848404549cfadf910ba1573a" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > RTP context constructor. < br / > < / td > < / tr >
2021-02-23 11:46:18 +00:00
< tr class = "separator:a98be18c2848404549cfadf910ba1573a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-02-20 08:46:32 +00:00
< tr class = "memitem:a652a201ae11685961267455ab823eb60" id = "r_a652a201ae11685961267455ab823eb60" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a652a201ae11685961267455ab823eb60" > ~context< / a > ()< / td > < / tr >
2023-03-13 13:15:14 +00:00
< tr class = "memdesc:a652a201ae11685961267455ab823eb60" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > RTP context destructor. < br / > < / td > < / tr >
2021-02-23 11:46:18 +00:00
< tr class = "separator:a652a201ae11685961267455ab823eb60" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-02-20 08:46:32 +00:00
< tr class = "memitem:ae4417159d9b136b2d696fb7571fc3266" id = "r_ae4417159d9b136b2d696fb7571fc3266" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "classuvgrtp_1_1session.html" > uvgrtp::session< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#ae4417159d9b136b2d696fb7571fc3266" > create_session< / a > (std::pair< std::string, std::string > addresses)< / td > < / tr >
2024-01-30 12:53:35 +00:00
< tr class = "memdesc:ae4417159d9b136b2d696fb7571fc3266" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Create a new RTP session between two IP addresses. < br / > < / td > < / tr >
< tr class = "separator:ae4417159d9b136b2d696fb7571fc3266" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-02-20 08:46:32 +00:00
< tr class = "memitem:a81b2dc23ebf64d1153410376503eccb4" id = "r_a81b2dc23ebf64d1153410376503eccb4" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "classuvgrtp_1_1session.html" > uvgrtp::session< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a81b2dc23ebf64d1153410376503eccb4" > create_session< / a > (std::string address)< / td > < / tr >
2023-03-13 13:15:14 +00:00
< tr class = "memdesc:a81b2dc23ebf64d1153410376503eccb4" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Create a new RTP session. < br / > < / td > < / tr >
2022-09-16 12:33:51 +00:00
< tr class = "separator:a81b2dc23ebf64d1153410376503eccb4" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-02-20 08:46:32 +00:00
< tr class = "memitem:a61daf2f3cdcdf2542ee997ab6de5efa9" id = "r_a61daf2f3cdcdf2542ee997ab6de5efa9" > < td class = "memItemLeft" align = "right" valign = "top" > rtp_error_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a61daf2f3cdcdf2542ee997ab6de5efa9" > destroy_session< / a > (< a class = "el" href = "classuvgrtp_1_1session.html" > uvgrtp::session< / a > *< a class = "el" href = "classuvgrtp_1_1session.html" > session< / a > )< / td > < / tr >
2023-03-13 13:15:14 +00:00
< tr class = "memdesc:a61daf2f3cdcdf2542ee997ab6de5efa9" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Destroy RTP session and all of its media streams. < br / > < / td > < / tr >
2021-02-23 11:46:18 +00:00
< tr class = "separator:a61daf2f3cdcdf2542ee997ab6de5efa9" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-02-20 08:46:32 +00:00
< tr class = "memitem:a0ddad3f0a78b6a4b13f2b8fdd15c9087" id = "r_a0ddad3f0a78b6a4b13f2b8fdd15c9087" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a0ddad3f0a78b6a4b13f2b8fdd15c9087" > crypto_enabled< / a > () const< / td > < / tr >
2023-03-13 13:15:14 +00:00
< tr class = "memdesc:a0ddad3f0a78b6a4b13f2b8fdd15c9087" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Has Crypto++ been included in uvgRTP library. < br / > < / td > < / tr >
2022-09-16 12:33:51 +00:00
< tr class = "separator:a0ddad3f0a78b6a4b13f2b8fdd15c9087" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2021-02-23 11:46:18 +00:00
< / table >
2022-09-16 12:33:51 +00:00
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
2023-03-13 13:15:14 +00:00
< div class = "textblock" > < p > Provides CNAME isolation and can be used to create < 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 > objects. < / p >
2022-09-16 12:33:51 +00:00
2024-01-30 12:53:35 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "context_8hh_source.html#l00018" > 18< / a > of file < a class = "el" href = "context_8hh_source.html" > context.hh< / a > .< / p >
2022-09-16 12:33:51 +00:00
< / div > < h2 class = "groupheader" > Constructor & Destructor Documentation< / h2 >
< a id = "a98be18c2848404549cfadf910ba1573a" name = "a98be18c2848404549cfadf910ba1573a" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a98be18c2848404549cfadf910ba1573a" > ◆   < / a > < / span > context()< / h2 >
2021-02-23 11:46:18 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > uvgrtp::context::context < / td >
< td > (< / td >
2024-02-20 08:46:32 +00:00
< td class = "paramname" > < span class = "paramname" > < / span > < / td > < td > )< / td >
2021-02-23 11:46:18 +00:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > RTP context constructor. < / p >
2023-03-13 13:15:14 +00:00
< p > Most of the time one RTP context per application is enough. If CNAME namespace isolation is required, multiple context objects can be created. < / p >
2021-02-23 11:46:18 +00:00
< / div >
< / div >
2022-09-16 12:33:51 +00:00
< a id = "a652a201ae11685961267455ab823eb60" name = "a652a201ae11685961267455ab823eb60" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a652a201ae11685961267455ab823eb60" > ◆   < / a > < / span > ~context()< / h2 >
2021-02-23 11:46:18 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > uvgrtp::context::~context < / td >
< td > (< / td >
2024-02-20 08:46:32 +00:00
< td class = "paramname" > < span class = "paramname" > < / span > < / td > < td > )< / td >
2021-02-23 11:46:18 +00:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > RTP context destructor. < / p >
2024-02-20 08:46:32 +00:00
< p > This does not destroy active sessions. They must be destroyed manually by calling < a class = "el" href = "#a61daf2f3cdcdf2542ee997ab6de5efa9" title = "Destroy RTP session and all of its media streams." > uvgrtp::context::destroy_session()< / a > < / p >
2021-02-23 11:46:18 +00:00
< / div >
< / div >
< h2 class = "groupheader" > Member Function Documentation< / h2 >
2024-01-30 12:53:35 +00:00
< a id = "ae4417159d9b136b2d696fb7571fc3266" name = "ae4417159d9b136b2d696fb7571fc3266" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ae4417159d9b136b2d696fb7571fc3266" > ◆   < / a > < / span > create_session() < span class = "overload" > [1/2]< / span > < / h2 >
2021-02-23 11:46:18 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2022-09-16 12:33:51 +00:00
< td class = "memname" > < a class = "el" href = "classuvgrtp_1_1session.html" > uvgrtp::session< / a > * uvgrtp::context::create_session < / td >
2021-02-23 11:46:18 +00:00
< td > (< / td >
2024-02-20 08:46:32 +00:00
< td class = "paramtype" > std::pair< std::string, std::string > < / td > < td class = "paramname" > < span class = "paramname" > < em > addresses< / em > < / span > < / td > < td > )< / td >
2021-02-23 11:46:18 +00:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2024-01-30 12:53:35 +00:00
< p > Create a new RTP session between two IP addresses. < / p >
2021-02-23 11:46:18 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2024-01-30 12:53:35 +00:00
< tr > < td class = "paramname" > addresses< / td > < td > Local and remote IP address for session as a pair< / td > < / tr >
2021-02-23 11:46:18 +00:00
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > RTP session object< / dd > < / dl >
< dl class = "retval" > < dt > Return values< / dt > < dd >
< table class = "retval" >
2022-09-16 12:33:51 +00:00
< tr > < td class = "paramname" > < 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 > < / td > < td > On success < / td > < / tr >
2024-01-30 12:53:35 +00:00
< tr > < td class = "paramname" > nullptr< / td > < td > If memory allocation failed < / td > < / tr >
2021-02-23 11:46:18 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2024-01-30 12:53:35 +00:00
< a id = "a81b2dc23ebf64d1153410376503eccb4" name = "a81b2dc23ebf64d1153410376503eccb4" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a81b2dc23ebf64d1153410376503eccb4" > ◆   < / a > < / span > create_session() < span class = "overload" > [2/2]< / span > < / h2 >
2021-02-23 11:46:18 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2022-09-16 12:33:51 +00:00
< td class = "memname" > < a class = "el" href = "classuvgrtp_1_1session.html" > uvgrtp::session< / a > * uvgrtp::context::create_session < / td >
2021-02-23 11:46:18 +00:00
< td > (< / td >
2024-02-20 08:46:32 +00:00
< td class = "paramtype" > std::string< / td > < td class = "paramname" > < span class = "paramname" > < em > address< / em > < / span > < / td > < td > )< / td >
2021-02-23 11:46:18 +00:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Create a new RTP session. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2024-01-30 12:53:35 +00:00
< tr > < td class = "paramname" > address< / td > < td > IP address of the remote participant< / td > < / tr >
2021-02-23 11:46:18 +00:00
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > RTP session object< / dd > < / dl >
< dl class = "retval" > < dt > Return values< / dt > < dd >
< table class = "retval" >
2022-09-16 12:33:51 +00:00
< tr > < td class = "paramname" > < 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 > < / td > < td > On success < / td > < / tr >
2024-01-30 12:53:35 +00:00
< tr > < td class = "paramname" > nullptr< / td > < td > If "address" is empty or memory allocation failed < / td > < / tr >
2021-02-23 11:46:18 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2022-09-16 12:33:51 +00:00
< a id = "a0ddad3f0a78b6a4b13f2b8fdd15c9087" name = "a0ddad3f0a78b6a4b13f2b8fdd15c9087" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a0ddad3f0a78b6a4b13f2b8fdd15c9087" > ◆   < / a > < / span > crypto_enabled()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool uvgrtp::context::crypto_enabled < / td >
< td > (< / td >
2024-02-20 08:46:32 +00:00
< td class = "paramname" > < span class = "paramname" > < / span > < / td > < td > )< / td >
2022-09-16 12:33:51 +00:00
< td > const< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Has Crypto++ been included in uvgRTP library. < / p >
< dl class = "retval" > < dt > Return values< / dt > < dd >
< table class = "retval" >
< tr > < td class = "paramname" > true< / td > < td > Crypto++ has been included, using SRTP is possible < / td > < / tr >
< tr > < td class = "paramname" > false< / td > < td > Crypto++ has not been included, using SRTP is not possible < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
< a id = "a61daf2f3cdcdf2542ee997ab6de5efa9" name = "a61daf2f3cdcdf2542ee997ab6de5efa9" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a61daf2f3cdcdf2542ee997ab6de5efa9" > ◆   < / a > < / span > destroy_session()< / h2 >
2021-02-23 11:46:18 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > rtp_error_t uvgrtp::context::destroy_session < / td >
< td > (< / td >
2024-02-20 08:46:32 +00:00
< td class = "paramtype" > < a class = "el" href = "classuvgrtp_1_1session.html" > uvgrtp::session< / a > *< / td > < td class = "paramname" > < span class = "paramname" > < em > session< / em > < / span > < / td > < td > )< / td >
2021-02-23 11:46:18 +00:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Destroy RTP session and all of its media streams. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > session< / td > < td > Pointer to the session object 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 session is nullptr < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
< hr / > The documentation for this class was generated from the following file:< ul >
2022-09-22 04:35:14 +00:00
< li > < a class = "el" href = "context_8hh_source.html" > context.hh< / a > < / li >
2021-02-23 11:46:18 +00:00
< / ul >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2024-02-20 08:46:32 +00:00
Generated by  < a href = "https://www.doxygen.org/index.html" > < img class = "footer" src = "doxygen.svg" width = "104" height = "31" alt = "doxygen" / > < / a > 1.10.0
2021-02-23 11:46:18 +00:00
< / small > < / address >
< / body >
< / html >
