Module: kamailio
Branch: master
Commit: 190ef9a54df33b4d053a4225e9d6257e0a045008
URL: 
https://github.com/kamailio/kamailio/commit/190ef9a54df33b4d053a4225e9d6257e0a045008

Author: Maksym Sobolyev <sobo...@sippysoft.com>
Committer: Victor Seva <linuxman...@torreviejawireless.org>
Date: 2023-10-20T09:57:47+02:00

rtpproxy: Update rtpproxy module documentation.

o Correct description of the timeout_socket;

o Document timeout_tag_pv;

o Update (c);

o Remove reference to the ngcp-mediaproxy-ng which does not exist
  anymore.

---

Modified: src/modules/rtpproxy/doc/rtpproxy.xml
Modified: src/modules/rtpproxy/doc/rtpproxy_admin.xml

---

Diff:  
https://github.com/kamailio/kamailio/commit/190ef9a54df33b4d053a4225e9d6257e0a045008.diff
Patch: 
https://github.com/kamailio/kamailio/commit/190ef9a54df33b4d053a4225e9d6257e0a045008.patch

---

diff --git a/src/modules/rtpproxy/doc/rtpproxy.xml 
b/src/modules/rtpproxy/doc/rtpproxy.xml
index 94886eaf404..ee1fdad9fc8 100644
--- a/src/modules/rtpproxy/doc/rtpproxy.xml
+++ b/src/modules/rtpproxy/doc/rtpproxy.xml
@@ -67,7 +67,7 @@
                </editor>
        </authorgroup>
        <copyright>
-               <year>2003-2008</year>
+               <year>2003-2023</year>
                <holder>Sippy Software, Inc.</holder>
        </copyright>
        <copyright>
diff --git a/src/modules/rtpproxy/doc/rtpproxy_admin.xml 
b/src/modules/rtpproxy/doc/rtpproxy_admin.xml
index 79a85edad70..b04baa5e3dc 100644
--- a/src/modules/rtpproxy/doc/rtpproxy_admin.xml
+++ b/src/modules/rtpproxy/doc/rtpproxy_admin.xml
@@ -18,11 +18,7 @@
        <title>Overview</title>
        <para>
                This is a module that enables media streams to be proxied
-               via an rtpproxy.  Rtpproxies know to work with this module
-               are Sippy RTPproxy <ulink url="http://www.rtpproxy.org";></ulink>
-               and ngcp-rtpproxy-ng
-               <ulink 
url="http://deb.sipwise.com/spce/2.6/pool/main/n/ngcp-mediaproxy-ng";></ulink>.
-               Some features of the rtpproxy module apply only to one of the 
two rtpproxies.
+               via the Sippy RTPproxy <ulink 
url="http://www.rtpproxy.org";></ulink>.
        </para>
        </section>
 
@@ -235,7 +231,37 @@ modparam("rtpproxy", "nortpproxy_str", 
"a=sdpmangled:yes\r\n")
                <title>Set <varname>timeout_socket</varname> parameter</title>
                <programlisting format="linespecific">
 ...
-modparam("rtpproxy", "timeout_socket", "xmlrpc:http://127.0.0.1:8000/RPC2";)
+modparam("rtpproxy", "timeout_socket", "tcp:127.0.0.1:8000")
+...
+</programlisting>
+               </example>
+       </section>
+       <section id="rtpproxy.p.timeout_tag_pv">
+               <title><varname>timeout_tag_pv</varname> (string)</title>
+               <para>
+               The parameter devines the AVP of the string to be provided to 
the
+               RTP-Proxy.
+               </para>
+               <para>
+               The content of the AVP must be a valid URL-encoded string with
+               no spaces.
+               It will be decoded and send by the RTP proxy to the timeout 
socket if the
+               media timeout has happened.
+               </para>
+               <para>
+               This parameter is required in order for the timeout notification
+               mechanism to work properly.
+               </para>
+               <para>
+               <emphasis>
+                       Default value is <quote></quote> (nothing).
+               </emphasis>
+               </para>
+               <example>
+               <title>Set <varname>timeout_tag_pv</varname> parameter</title>
+               <programlisting format="linespecific">
+...
+modparam("rtpproxy", "timeout_tag_pv", "$avp(rtpp_ntag)")
 ...
 </programlisting>
                </example>

_______________________________________________
Kamailio (SER) - Development Mailing List
To unsubscribe send an email to sr-dev-le...@lists.kamailio.org

Reply via email to