|
@@ -30,13 +30,13 @@ Carsten Bock
|
|
|
|
|
|
ng-voice GmbH
|
|
|
|
|
|
- Copyright © 2003-2008 Sippy Software, Inc.
|
|
|
+ Copyright © 2003-2008 Sippy Software, Inc.
|
|
|
|
|
|
- Copyright © 2005 Voice Sistem SRL
|
|
|
+ Copyright © 2005 Voice Sistem SRL
|
|
|
|
|
|
- Copyright © 2009-2012 TuTPro Inc.
|
|
|
+ Copyright © 2009-2012 TuTPro Inc.
|
|
|
|
|
|
- Copyright © 2010 VoIPEmbedded Inc.
|
|
|
+ Copyright © 2010 VoIPEmbedded Inc.
|
|
|
__________________________________________________________________
|
|
|
|
|
|
Table of Contents
|
|
@@ -58,6 +58,7 @@ Carsten Bock
|
|
|
4.4. rtpproxy_retr (integer)
|
|
|
4.5. nortpproxy_str (string)
|
|
|
4.6. timeout_socket (string)
|
|
|
+ 4.7. ice_candidate_priority_avp (string)
|
|
|
|
|
|
5. Functions
|
|
|
|
|
@@ -92,16 +93,17 @@ Carsten Bock
|
|
|
1.4. Set rtpproxy_retr parameter
|
|
|
1.5. Set nortpproxy_str parameter
|
|
|
1.6. Set timeout_socket parameter
|
|
|
- 1.7. set_rtp_proxy_set usage
|
|
|
- 1.8. rtpproxy_offer usage
|
|
|
- 1.9. rtpproxy_answer usage
|
|
|
- 1.10. rtpproxy_destroy usage
|
|
|
- 1.11. rtpproxy_manage usage
|
|
|
- 1.12. rtpproxy_stream2xxx usage
|
|
|
- 1.13. start_recording usage
|
|
|
- 1.14. $rtpstat-Usage
|
|
|
- 1.15. nh_enable_rtpp usage
|
|
|
- 1.16. nh_show_rtpp usage
|
|
|
+ 1.7. Set ice_candidate_priority_avp parameter
|
|
|
+ 1.8. set_rtp_proxy_set usage
|
|
|
+ 1.9. rtpproxy_offer usage
|
|
|
+ 1.10. rtpproxy_answer usage
|
|
|
+ 1.11. rtpproxy_destroy usage
|
|
|
+ 1.12. rtpproxy_manage usage
|
|
|
+ 1.13. rtpproxy_stream2xxx usage
|
|
|
+ 1.14. start_recording usage
|
|
|
+ 1.15. $rtpstat-Usage
|
|
|
+ 1.16. nh_enable_rtpp usage
|
|
|
+ 1.17. nh_show_rtpp usage
|
|
|
|
|
|
Chapter 1. Admin Guide
|
|
|
|
|
@@ -122,6 +124,7 @@ Chapter 1. Admin Guide
|
|
|
4.4. rtpproxy_retr (integer)
|
|
|
4.5. nortpproxy_str (string)
|
|
|
4.6. timeout_socket (string)
|
|
|
+ 4.7. ice_candidate_priority_avp (string)
|
|
|
|
|
|
5. Functions
|
|
|
|
|
@@ -163,7 +166,7 @@ Chapter 1. Admin Guide
|
|
|
The module allows definition of several sets of rtpproxies.
|
|
|
Load-balancing will be performed over a set and the admin has the
|
|
|
ability to choose what set should be used. The set is selected via its
|
|
|
- id - the id being defined with the set. Refer to the "rtpproxy_sock"
|
|
|
+ id - the id being defined with the set. Refer to the “rtpproxy_sock�
|
|
|
module parameter definition for syntax description.
|
|
|
|
|
|
The balancing inside a set is done automatically by the module based on
|
|
@@ -205,13 +208,14 @@ Chapter 1. Admin Guide
|
|
|
4.4. rtpproxy_retr (integer)
|
|
|
4.5. nortpproxy_str (string)
|
|
|
4.6. timeout_socket (string)
|
|
|
+ 4.7. ice_candidate_priority_avp (string)
|
|
|
|
|
|
4.1. rtpproxy_sock (string)
|
|
|
|
|
|
Definition of socket(s) used to connect to (a set) RTPProxy. It may
|
|
|
specify a UNIX socket or an IPv4/IPv6 UDP socket.
|
|
|
|
|
|
- Default value is "NONE" (disabled).
|
|
|
+ Default value is “NONE� (disabled).
|
|
|
|
|
|
Example 1.1. Set rtpproxy_sock parameter
|
|
|
...
|
|
@@ -233,7 +237,7 @@ modparam("rtpproxy", "rtpproxy_sock",
|
|
|
rtpproxy module will not attempt to establish communication to RTPProxy
|
|
|
for rtpproxy_disable_tout seconds.
|
|
|
|
|
|
- Default value is "60".
|
|
|
+ Default value is “60�.
|
|
|
|
|
|
Example 1.2. Set rtpproxy_disable_tout parameter
|
|
|
...
|
|
@@ -244,7 +248,7 @@ modparam("rtpproxy", "rtpproxy_disable_tout", 20)
|
|
|
|
|
|
Timeout value in waiting for reply from RTPProxy.
|
|
|
|
|
|
- Default value is "1".
|
|
|
+ Default value is “1�.
|
|
|
|
|
|
Example 1.3. Set rtpproxy_tout parameter
|
|
|
...
|
|
@@ -256,7 +260,7 @@ modparam("rtpproxy", "rtpproxy_tout", 2)
|
|
|
How many times the module should retry to send and receive after
|
|
|
timeout was generated.
|
|
|
|
|
|
- Default value is "5".
|
|
|
+ Default value is “5�.
|
|
|
|
|
|
Example 1.4. Set rtpproxy_retr parameter
|
|
|
...
|
|
@@ -275,7 +279,7 @@ Note
|
|
|
|
|
|
The string must be a complete SDP line, including the EOH (\r\n).
|
|
|
|
|
|
- Default value is "a=nortpproxy:yes\r\n".
|
|
|
+ Default value is “a=nortpproxy:yes\r\n�.
|
|
|
|
|
|
Example 1.5. Set nortpproxy_str parameter
|
|
|
...
|
|
@@ -291,13 +295,30 @@ modparam("rtpproxy", "nortpproxy_str", "a=sdpmangled:yes\r\n")
|
|
|
If it is an empty string, no timeout socket will be transmitted to the
|
|
|
RTP-Proxy.
|
|
|
|
|
|
- Default value is "" (nothing).
|
|
|
+ Default value is “� (nothing).
|
|
|
|
|
|
Example 1.6. Set timeout_socket parameter
|
|
|
...
|
|
|
modparam("nathelper", "timeout_socket", "xmlrpc:http://127.0.0.1:8000/RPC2")
|
|
|
...
|
|
|
|
|
|
+4.7. ice_candidate_priority_avp (string)
|
|
|
+
|
|
|
+ If specified and if value of the avp value is not 0, rtpproxy_manage
|
|
|
+ function adds ICE relay candidate attributes to sdp stream(s)
|
|
|
+ containing ICE candidate attributes.
|
|
|
+
|
|
|
+ If value of the avp is 1, added candidates have high priority. If value
|
|
|
+ of the avp is 2 (default), added candidates have low priority.
|
|
|
+
|
|
|
+ There is no default value meaning that no ICE relay candidates are
|
|
|
+ added in any circumstance.
|
|
|
+
|
|
|
+ Example 1.7. Set ice_candidate_priority_avp parameter
|
|
|
+...
|
|
|
+modparam("rtpproxy", "ice_candidate_priority_avp", "$avp(ice_priority)")
|
|
|
+...
|
|
|
+
|
|
|
5. Functions
|
|
|
|
|
|
5.1. set_rtp_proxy_set(setid)
|
|
@@ -322,7 +343,7 @@ modparam("nathelper", "timeout_socket", "xmlrpc:http://127.0.0.1:8000/RPC2")
|
|
|
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
|
|
|
BRANCH_ROUTE.
|
|
|
|
|
|
- Example 1.7. set_rtp_proxy_set usage
|
|
|
+ Example 1.8. set_rtp_proxy_set usage
|
|
|
...
|
|
|
set_rtp_proxy_set("2");
|
|
|
rtpproxy_offer();
|
|
@@ -338,16 +359,16 @@ rtpproxy_offer();
|
|
|
* flags - flags to turn on some features.
|
|
|
+ 1 - append first Via branch to Call-ID when sending command to
|
|
|
rtpproxy. This can be used to create one media session per
|
|
|
- branch on the rtpproxy. When sending a subsequent "delete"
|
|
|
+ branch on the rtpproxy. When sending a subsequent “delete�
|
|
|
command to the rtpproxy, you can then stop just the session
|
|
|
for a specific branch when passing the flag '1' or '2' in the
|
|
|
- "unforce_rtpproxy", or stop all sessions for a call when not
|
|
|
+ “unforce_rtpproxy�, or stop all sessions for a call when not
|
|
|
passing one of those two flags there. This is especially
|
|
|
useful if you have serially forked call scenarios where
|
|
|
- rtpproxy gets an "update" command for a new branch, and then a
|
|
|
- "delete" command for the previous branch, which would
|
|
|
+ rtpproxy gets an “update� command for a new branch, and then a
|
|
|
+ “delete� command for the previous branch, which would
|
|
|
otherwise delete the full call, breaking the subsequent
|
|
|
- "lookup" for the new branch. This flag is only supported by
|
|
|
+ “lookup� for the new branch. This flag is only supported by
|
|
|
the ngcp-mediaproxy-ng rtpproxy at the moment!
|
|
|
+ 2 - append second Via branch to Call-ID when sending command
|
|
|
to rtpproxy. See flag '1' for its meaning.
|
|
@@ -355,7 +376,7 @@ rtpproxy_offer();
|
|
|
set for a reply.
|
|
|
+ a - flags that UA from which message is received doesn't
|
|
|
support symmetric RTP. (automatically sets the 'r' flag)
|
|
|
- + l - force "lookup", that is, only rewrite SDP when
|
|
|
+ + l - force “lookup�, that is, only rewrite SDP when
|
|
|
corresponding session already exists in the RTP proxy. By
|
|
|
default is on when the session is to be completed.
|
|
|
+ i, e - these flags specify the direction of the SIP message.
|
|
@@ -416,7 +437,7 @@ rtpproxy_offer();
|
|
|
|
|
|
This function can be used from ANY_ROUTE.
|
|
|
|
|
|
- Example 1.8. rtpproxy_offer usage
|
|
|
+ Example 1.9. rtpproxy_offer usage
|
|
|
route {
|
|
|
...
|
|
|
if (is_method("INVITE")) {
|
|
@@ -460,7 +481,7 @@ onreply_route[2]
|
|
|
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
|
|
|
FAILURE_ROUTE, BRANCH_ROUTE.
|
|
|
|
|
|
- Example 1.9. rtpproxy_answer usage
|
|
|
+ Example 1.10. rtpproxy_answer usage
|
|
|
|
|
|
See rtpproxy_offer() function example above for example.
|
|
|
|
|
@@ -474,25 +495,25 @@ onreply_route[2]
|
|
|
* flags - flags to turn on some features.
|
|
|
+ 1 - append first Via branch to Call-ID when sending command to
|
|
|
rtpproxy. This can be used to create one media session per
|
|
|
- branch on the rtpproxy. When sending a subsequent "delete"
|
|
|
+ branch on the rtpproxy. When sending a subsequent “delete�
|
|
|
command to the rtpproxy, you can then stop just the session
|
|
|
for a specific branch when passing the flag '1' or '2' in the
|
|
|
- "unforce_rtpproxy", or stop all sessions for a call when not
|
|
|
+ “unforce_rtpproxy�, or stop all sessions for a call when not
|
|
|
passing one of those two flags there. This is especially
|
|
|
useful if you have serially forked call scenarios where
|
|
|
- rtpproxy gets an "update" command for a new branch, and then a
|
|
|
- "delete" command for the previous branch, which would
|
|
|
+ rtpproxy gets an “update� command for a new branch, and then a
|
|
|
+ “delete� command for the previous branch, which would
|
|
|
otherwise delete the full call, breaking the subsequent
|
|
|
- "lookup" for the new branch. This flag is only supported by
|
|
|
+ “lookup� for the new branch. This flag is only supported by
|
|
|
the ngcp-mediaproxy-ng rtpproxy at the moment!
|
|
|
+ 2 - append second Via branch to Call-ID when sending command
|
|
|
to rtpproxy. See flag '1' for its meaning.
|
|
|
- + t - do not include To tag to "delete" command to rtpproxy thus
|
|
|
+ + t - do not include To tag to “delete� command to rtpproxy thus
|
|
|
causing full call to be deleted. Useful for deleting unused
|
|
|
rtpproxy call when 200 OK is received on a branch, where
|
|
|
rtpproxy is not needed.
|
|
|
|
|
|
- Example 1.10. rtpproxy_destroy usage
|
|
|
+ Example 1.11. rtpproxy_destroy usage
|
|
|
...
|
|
|
rtpproxy_destroy();
|
|
|
...
|
|
@@ -524,7 +545,7 @@ rtpproxy_destroy();
|
|
|
|
|
|
This function can be used from ANY_ROUTE.
|
|
|
|
|
|
- Example 1.11. rtpproxy_manage usage
|
|
|
+ Example 1.12. rtpproxy_manage usage
|
|
|
...
|
|
|
rtpproxy_manage();
|
|
|
...
|
|
@@ -560,7 +581,7 @@ rtpproxy_manage();
|
|
|
-1 means that it will be streaming in a loop indefinitely, until
|
|
|
the appropriate rtpproxy_stop_stream2xxx is issued.
|
|
|
|
|
|
- Example 1.12. rtpproxy_stream2xxx usage
|
|
|
+ Example 1.13. rtpproxy_stream2xxx usage
|
|
|
...
|
|
|
if (is_method("INVITE")) {
|
|
|
rtpproxy_offer();
|
|
@@ -593,7 +614,7 @@ rtpproxy_manage();
|
|
|
|
|
|
This function can be used from REQUEST_ROUTE and ONREPLY_ROUTE.
|
|
|
|
|
|
- Example 1.13. start_recording usage
|
|
|
+ Example 1.14. start_recording usage
|
|
|
...
|
|
|
start_recording();
|
|
|
...
|
|
@@ -613,7 +634,7 @@ start_recording();
|
|
|
packet-counters. The statistics must be retrieved before the session is
|
|
|
deleted (before unforce_rtpproxy()).
|
|
|
|
|
|
- Example 1.14. $rtpstat-Usage
|
|
|
+ Example 1.15. $rtpstat-Usage
|
|
|
...
|
|
|
append_hf("X-RTP-Statistics: $rtpstat\r\n");
|
|
|
...
|
|
@@ -636,7 +657,7 @@ start_recording();
|
|
|
NOTE: if a rtpproxy is defined multiple times (in the same or diferente
|
|
|
sete), all of its instances will be enables/disabled.
|
|
|
|
|
|
- Example 1.15. nh_enable_rtpp usage
|
|
|
+ Example 1.16. nh_enable_rtpp usage
|
|
|
...
|
|
|
$ kamctl fifo nh_enable_rtpp udp:192.168.2.133:8081 0
|
|
|
...
|
|
@@ -648,52 +669,52 @@ $ kamctl fifo nh_enable_rtpp udp:192.168.2.133:8081 0
|
|
|
|
|
|
No parameter.
|
|
|
|
|
|
- Example 1.16. nh_show_rtpp usage
|
|
|
+ Example 1.17. nh_show_rtpp usage
|
|
|
...
|
|
|
$ kamctl fifo nh_show_rtpp
|
|
|
...
|
|
|
|
|
|
Chapter 2. Frequently Asked Questions
|
|
|
|
|
|
- 2.1. What happend with "rtpproxy_disable" parameter?
|
|
|
+ 2.1. What happend with “rtpproxy_disable� parameter?
|
|
|
2.2. Where can I find more about Kamailio?
|
|
|
2.3. Where can I post a question about this module?
|
|
|
2.4. How can I report a bug?
|
|
|
|
|
|
2.1.
|
|
|
|
|
|
- What happend with "rtpproxy_disable" parameter?
|
|
|
+ What happend with “rtpproxy_disable� parameter?
|
|
|
|
|
|
- It was removed as it became obsolete - now "rtpproxy_sock" can take
|
|
|
- empty value to disable the rtpproxy functionality.
|
|
|
+ It was removed as it became obsolete - now “rtpproxy_sock� can take
|
|
|
+ empty value to disable the rtpproxy functionality.
|
|
|
|
|
|
2.2.
|
|
|
|
|
|
- Where can I find more about Kamailio?
|
|
|
+ Where can I find more about Kamailio?
|
|
|
|
|
|
- Take a look at http://www.kamailio.org/.
|
|
|
+ Take a look at http://www.kamailio.org/.
|
|
|
|
|
|
2.3.
|
|
|
|
|
|
- Where can I post a question about this module?
|
|
|
+ Where can I post a question about this module?
|
|
|
|
|
|
- First at all check if your question was already answered on one of our
|
|
|
- mailing lists:
|
|
|
- * User Mailing List -
|
|
|
- http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users
|
|
|
- * Developer Mailing List -
|
|
|
- http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
|
|
|
+ First at all check if your question was already answered on one of our
|
|
|
+ mailing lists:
|
|
|
+ * User Mailing List -
|
|
|
+ http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users
|
|
|
+ * Developer Mailing List -
|
|
|
+ http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
|
|
|
|
|
|
- E-mails regarding any stable Kamailio release should be sent to
|
|
|
- <[email protected]> and e-mails regarding development
|
|
|
- versions should be sent to <[email protected]>.
|
|
|
+ E-mails regarding any stable Kamailio release should be sent to
|
|
|
+ <[email protected]> and e-mails regarding development
|
|
|
+ versions should be sent to <[email protected]>.
|
|
|
|
|
|
- If you want to keep the mail private, send it to
|
|
|
- <[email protected]>.
|
|
|
+ If you want to keep the mail private, send it to
|
|
|
+ <[email protected]>.
|
|
|
|
|
|
2.4.
|
|
|
|
|
|
- How can I report a bug?
|
|
|
+ How can I report a bug?
|
|
|
|
|
|
- Please follow the guidelines provided at:
|
|
|
- http://sip-router.org/tracker.
|
|
|
+ Please follow the guidelines provided at:
|
|
|
+ http://sip-router.org/tracker.
|