Переглянути джерело

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

Kamailio Dev 4 роки тому
батько
коміт
57f2dcdcb1
2 змінених файлів з 38 додано та 20 видалено
  1. 19 9
      src/modules/rtpengine/README
  2. 19 11
      src/modules/rtpproxy/README

+ 19 - 9
src/modules/rtpengine/README

@@ -155,7 +155,8 @@ Richard Fuchs
 
 
         6. Exported Pseudo Variables
         6. Exported Pseudo Variables
 
 
-              6.1. $rtpstat
+              6.1. $rtpestat
+              6.2. $rtpstat
 
 
         7. RPC Commands
         7. RPC Commands
 
 
@@ -269,7 +270,7 @@ Richard Fuchs
    1.98. play_media usage
    1.98. play_media usage
    1.99. stop_media usage
    1.99. stop_media usage
    1.100. play_dtmf usage
    1.100. play_dtmf usage
-   1.101. $rtpstat Usage
+   1.101. $rtpestat Usage
    1.102. rtpengine.reload usage
    1.102. rtpengine.reload usage
    1.103. rtpengine.enable usage
    1.103. rtpengine.enable usage
    1.104. rtpengine.show usage
    1.104. rtpengine.show usage
@@ -394,7 +395,8 @@ Chapter 1. Admin Guide
 
 
    6. Exported Pseudo Variables
    6. Exported Pseudo Variables
 
 
-        6.1. $rtpstat
+        6.1. $rtpestat
+        6.2. $rtpstat
 
 
    7. RPC Commands
    7. RPC Commands
 
 
@@ -2682,19 +2684,27 @@ play_dtmf("code=1 volume=5 duration=300 pause=150");
 
 
 6. Exported Pseudo Variables
 6. Exported Pseudo Variables
 
 
-   6.1. $rtpstat
+   6.1. $rtpestat
+   6.2. $rtpstat
 
 
-6.1. $rtpstat
+6.1. $rtpestat
 
 
-   Returns the RTP statistics from the RTP proxy. The RTP statistics from
-   the RTP proxy are provided as a string and it does contain several
+   Returns the RTP statistics from the RTP relay. The RTP statistics from
+   the RTP relay are provided as a string and it does contain several
    packet counters. The statistics must be retrieved before the session is
    packet counters. The statistics must be retrieved before the session is
    deleted (before rtpengine_delete()).
    deleted (before rtpengine_delete()).
 
 
-   Example 1.101. $rtpstat Usage
+   Example 1.101. $rtpestat Usage
 ...
 ...
-    append_hf("X-RTP-Statistics: $rtpstat\r\n");
+    append_hf("X-RTP-Statistics: $rtpestat\r\n");
 ...
 ...
+    # $rtpestat = RTP: 54846 bytes, 1447 packets, 0 errors; RTCP: 336 bytes, 3 p
+ackets, 0 errors
+...
+
+6.2. $rtpstat
+
+   Same as $rtpestat.
 
 
 7. RPC Commands
 7. RPC Commands
 
 

+ 19 - 11
src/modules/rtpproxy/README

@@ -70,9 +70,10 @@ Carsten Bock
               5.10. rtpproxy_stop_stream2uas()
               5.10. rtpproxy_stop_stream2uas()
               5.11. start_recording()
               5.11. start_recording()
 
 
-        6. Exported Pseudo Variables
+        6. Exported Variables
 
 
-              6.1. $rtpstat
+              6.1. $rtppstat
+              6.2. $rtpstat
 
 
         7. RPC Commands
         7. RPC Commands
 
 
@@ -103,7 +104,7 @@ Carsten Bock
    1.18. rtpproxy_stream2xxx usage
    1.18. rtpproxy_stream2xxx usage
    1.19. rtpproxy_stop_stream2uas usage
    1.19. rtpproxy_stop_stream2uas usage
    1.20. start_recording usage
    1.20. start_recording usage
-   1.21. $rtpstat-Usage
+   1.21. $rtppstat Usage
    1.22. rtpproxy.enable usage
    1.22. rtpproxy.enable usage
    1.23. rtpproxy.list usage
    1.23. rtpproxy.list usage
 
 
@@ -146,9 +147,10 @@ Chapter 1. Admin Guide
         5.10. rtpproxy_stop_stream2uas()
         5.10. rtpproxy_stop_stream2uas()
         5.11. start_recording()
         5.11. start_recording()
 
 
-   6. Exported Pseudo Variables
+   6. Exported Variables
 
 
-        6.1. $rtpstat
+        6.1. $rtppstat
+        6.2. $rtpstat
 
 
    7. RPC Commands
    7. RPC Commands
 
 
@@ -736,22 +738,28 @@ rtpproxy_manage();
 start_recording();
 start_recording();
 ...
 ...
 
 
-6. Exported Pseudo Variables
+6. Exported Variables
 
 
-   6.1. $rtpstat
+   6.1. $rtppstat
+   6.2. $rtpstat
 
 
-6.1. $rtpstat
+6.1. $rtppstat
 
 
    Returns the RTP-Statistics from the RTP-Proxy. The RTP-Statistics from
    Returns the RTP-Statistics from the RTP-Proxy. The RTP-Statistics from
    the RTP-Proxy are provided as a string and it does contain several
    the RTP-Proxy are provided as a string and it does contain several
    packet-counters. The statistics must be retrieved before the session is
    packet-counters. The statistics must be retrieved before the session is
-   deleted (before unforce_rtpproxy()).
+   deleted (before unforce_rtpproxy()). It is the output of RTPProxy 'Q'
+   command.
 
 
-   Example 1.21. $rtpstat-Usage
+   Example 1.21. $rtppstat Usage
 ...
 ...
-    append_hf("X-RTP-Statistics: $rtpstat\r\n");
+    append_hf("X-RTP-Statistics: $rtppstat\r\n");
 ...
 ...
 
 
+6.2. $rtpstat
+
+   Same as $rtppstat.
+
 7. RPC Commands
 7. RPC Commands
 
 
    7.1. rtpproxy.enable
    7.1. rtpproxy.enable