[sr-dev] git:master:5508e6d6: modules: readme files regenerated - rtpproxy ... [skip ci]

[Kamailio Dev]

Module: kamailio
Branch: master
Commit: 5508e6d6bafc3253f27d9473637233f32508af63
URL: https://github.com/kamailio/kamailio/commit/5508e6d6bafc3253f27d9473637233f32508af63

Author: Kamailio Dev <kamailio.dev at kamailio.org>
Committer: Kamailio Dev <kamailio.dev at kamailio.org>
Date: 2017-04-19T08:16:41+02:00

modules: readme files regenerated - rtpproxy ... [skip ci]

---

Modified: src/modules/rtpproxy/README

---

Diff:  https://github.com/kamailio/kamailio/commit/5508e6d6bafc3253f27d9473637233f32508af63.diff
Patch: https://github.com/kamailio/kamailio/commit/5508e6d6bafc3253f27d9473637233f32508af63.patch

---

diff --git a/src/modules/rtpproxy/README b/src/modules/rtpproxy/README
index 1c603d9..038f2f5 100644
--- a/src/modules/rtpproxy/README
+++ b/src/modules/rtpproxy/README
@@ -75,8 +75,8 @@ Carsten Bock
               5.7. rtpproxy_stream2uac(prompt_name, count),
               5.8. rtpproxy_stream2uas(prompt_name, count)
               5.9. rtpproxy_stop_stream2uac(),
-              5.10. start_recording()
-              5.11. rtpproxy_stop_stream2uas(prompt_name, count)
+              5.10. rtpproxy_stop_stream2uas()
+              5.11. start_recording()
 
         6. Exported Pseudo Variables
 
@@ -109,10 +109,11 @@ Carsten Bock
    1.16. rtpproxy_destroy usage
    1.17. rtpproxy_manage usage
    1.18. rtpproxy_stream2xxx usage
-   1.19. start_recording usage
-   1.20. $rtpstat-Usage
-   1.21. rtpproxy.enable usage
-   1.22. rtpproxy.list usage
+   1.19. rtpproxy_stop_stream2uas usage
+   1.20. start_recording usage
+   1.21. $rtpstat-Usage
+   1.22. rtpproxy.enable usage
+   1.23. rtpproxy.list usage
 
 Chapter 1. Admin Guide
 
@@ -150,8 +151,8 @@ Chapter 1. Admin Guide
         5.7. rtpproxy_stream2uac(prompt_name, count),
         5.8. rtpproxy_stream2uas(prompt_name, count)
         5.9. rtpproxy_stop_stream2uac(),
-        5.10. start_recording()
-        5.11. rtpproxy_stop_stream2uas(prompt_name, count)
+        5.10. rtpproxy_stop_stream2uas()
+        5.11. start_recording()
 
    6. Exported Pseudo Variables
 
@@ -415,8 +416,8 @@ xlog("L_INFO", "Chose rtpp instance $var(RTP_INSTANCE)\n");
    5.7. rtpproxy_stream2uac(prompt_name, count),
    5.8. rtpproxy_stream2uas(prompt_name, count)
    5.9. rtpproxy_stop_stream2uac(),
-   5.10. start_recording()
-   5.11. rtpproxy_stop_stream2uas(prompt_name, count)
+   5.10. rtpproxy_stop_stream2uas()
+   5.11. start_recording()
 
 5.1.  set_rtp_proxy_set(setid)
 
@@ -714,7 +715,23 @@ rtpproxy_manage();
 
    These functions can be used from REQUEST_ROUTE, ONREPLY_ROUTE.
 
-5.10.  start_recording()
+5.10.  rtpproxy_stop_stream2uas()
+
+   See function rtpproxy_stop_stream2uac().
+
+   Example 1.19. rtpproxy_stop_stream2uas usage
+...
+    if (is_method("INVITE")) {
+        rtpproxy_offer();
+        if (is_audio_on_hold()) {
+            rtpproxy_stream2uas("/var/rtpproxy/prompts/music_on_hold", "-1");
+        } else {
+            rtpproxy_stop_stream2uas();
+        };
+    };
+...
+
+5.11.  start_recording()
 
    This function will send a signal to the RTP-Proxy to record the RTP
    stream on the RTP-Proxy. This function is only supported by Sippy
@@ -722,15 +739,11 @@ rtpproxy_manage();
 
    This function can be used from REQUEST_ROUTE and ONREPLY_ROUTE.
 
-   Example 1.19. start_recording usage
+   Example 1.20. start_recording usage
 ...
 start_recording();
 ...
 
-5.11.  rtpproxy_stop_stream2uas(prompt_name, count)
-
-   See function rtpproxy_stop_stream2uac(prompt_name, count).
-
 6. Exported Pseudo Variables
 
    6.1. $rtpstat
@@ -742,7 +755,7 @@ start_recording();
    packet-counters. The statistics must be retrieved before the session is
    deleted (before unforce_rtpproxy()).
 
-   Example 1.20. $rtpstat-Usage
+   Example 1.21. $rtpstat-Usage
 ...
     append_hf("X-RTP-Statistics: $rtpstat\r\n");
 ...
@@ -765,7 +778,7 @@ start_recording();
    NOTE: if a rtpproxy is defined multiple times (in the same or different
    sets), all of its instances will be enabled/disabled.
 
-   Example 1.21.  rtpproxy.enable usage
+   Example 1.22.  rtpproxy.enable usage
 ...
 $ kamcmd rtpproxy.enable udp:192.168.2.133:8081 0
 ...
@@ -777,7 +790,7 @@ $ kamcmd rtpproxy.enable udp:192.168.2.133:8081 0
 
    No parameter.
 
-   Example 1.22.  rtpproxy.list usage
+   Example 1.23.  rtpproxy.list usage
 ...
 $ kamcmd rtpproxy.list
 ...