Browse code

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

Kamailio Dev authored on 23/07/2021 17:46:14
Showing 1 changed files
... ...
@@ -145,11 +145,13 @@ Richard Fuchs
145 145
               5.11. unblock_dtmf([flags])
146 146
               5.12. block_media([flags])
147 147
               5.13. unblock_media([flags])
148
-              5.14. start_forwarding([flags])
149
-              5.15. stop_forwarding([flags])
150
-              5.16. play_media([flags])
151
-              5.17. stop_media([flags])
152
-              5.18. play_dtmf([flags])
148
+              5.14. silence_media([flags])
149
+              5.15. unsilence_media([flags])
150
+              5.16. start_forwarding([flags])
151
+              5.17. stop_forwarding([flags])
152
+              5.18. play_media([flags])
153
+              5.19. stop_media([flags])
154
+              5.20. play_dtmf([flags])
153 155
 
154 156
         6. Exported Pseudo Variables
155 157
 
... ...
@@ -260,17 +262,19 @@ Richard Fuchs
260 262
    1.91. unblock_dtmf usage
261 263
    1.92. block_media usage
262 264
    1.93. unblock_media usage
263
-   1.94. start_forwarding usage
264
-   1.95. stop_forwarding usage
265
-   1.96. play_media usage
266
-   1.97. stop_media usage
267
-   1.98. play_dtmf usage
268
-   1.99. $rtpstat Usage
269
-   1.100. rtpengine.reload usage
270
-   1.101. rtpengine.enable usage
271
-   1.102. rtpengine.show usage
272
-   1.103. rtpengine.ping usage
273
-   1.104. rtpengine.get_hash_total usage
265
+   1.94. silence_media usage
266
+   1.95. unsilence_media usage
267
+   1.96. start_forwarding usage
268
+   1.97. stop_forwarding usage
269
+   1.98. play_media usage
270
+   1.99. stop_media usage
271
+   1.100. play_dtmf usage
272
+   1.101. $rtpstat Usage
273
+   1.102. rtpengine.reload usage
274
+   1.103. rtpengine.enable usage
275
+   1.104. rtpengine.show usage
276
+   1.105. rtpengine.ping usage
277
+   1.106. rtpengine.get_hash_total usage
274 278
 
275 279
 Chapter 1. Admin Guide
276 280
 
... ...
@@ -380,11 +384,13 @@ Chapter 1. Admin Guide
380 384
         5.11. unblock_dtmf([flags])
381 385
         5.12. block_media([flags])
382 386
         5.13. unblock_media([flags])
383
-        5.14. start_forwarding([flags])
384
-        5.15. stop_forwarding([flags])
385
-        5.16. play_media([flags])
386
-        5.17. stop_media([flags])
387
-        5.18. play_dtmf([flags])
387
+        5.14. silence_media([flags])
388
+        5.15. unsilence_media([flags])
389
+        5.16. start_forwarding([flags])
390
+        5.17. stop_forwarding([flags])
391
+        5.18. play_media([flags])
392
+        5.19. stop_media([flags])
393
+        5.20. play_dtmf([flags])
388 394
 
389 395
    6. Exported Pseudo Variables
390 396
 
... ...
@@ -2017,11 +2023,13 @@ modparam("rtpengine", "wsapi", "lwsc")
2017 2023
    5.11. unblock_dtmf([flags])
2018 2024
    5.12. block_media([flags])
2019 2025
    5.13. unblock_media([flags])
2020
-   5.14. start_forwarding([flags])
2021
-   5.15. stop_forwarding([flags])
2022
-   5.16. play_media([flags])
2023
-   5.17. stop_media([flags])
2024
-   5.18. play_dtmf([flags])
2026
+   5.14. silence_media([flags])
2027
+   5.15. unsilence_media([flags])
2028
+   5.16. start_forwarding([flags])
2029
+   5.17. stop_forwarding([flags])
2030
+   5.18. play_media([flags])
2031
+   5.19. stop_media([flags])
2032
+   5.20. play_dtmf([flags])
2025 2033
 
2026 2034
 5.1.  set_rtpengine_set(setid[, setid])
2027 2035
 
... ...
@@ -2552,7 +2560,36 @@ unblock_media();
2552 2560
 unblock_media("all");
2553 2561
 ...
2554 2562
 
2555
-5.14.  start_forwarding([flags])
2563
+5.14.  silence_media([flags])
2564
+
2565
+   Identical to “block_media” except that media RTP packets are not simply
2566
+   blocked, but instead have their audio payload replaced by silence
2567
+   audio. This is only supported for certain trivial audio codecs (e.g.
2568
+   G.711, G.722).
2569
+
2570
+   See “block_dtmf” for a description of the flags that can be used.
2571
+
2572
+   Example 1.94. silence_media usage
2573
+...
2574
+silence_media();
2575
+silence_media("directional");
2576
+silence_media("address=192.168.42.42");
2577
+...
2578
+
2579
+5.15.  unsilence_media([flags])
2580
+
2581
+   Identical to “unblock_media” except that it's the counterpart to
2582
+   “silence_media”.
2583
+
2584
+   See “unblock_dtmf” for a description of the flags that can be used.
2585
+
2586
+   Example 1.95. unsilence_media usage
2587
+...
2588
+unsilence_media();
2589
+unsilence_media("all");
2590
+...
2591
+
2592
+5.16.  start_forwarding([flags])
2556 2593
 
2557 2594
    Controls the PCM forwarding feature of the recording daemon. Unlike the
2558 2595
    recording feature, PCM forwarding can be done directionally for
... ...
@@ -2561,27 +2598,27 @@ unblock_media("all");
2561 2598
 
2562 2599
    See “block_dtmf” for a description of the flags that can be used.
2563 2600
 
2564
-   Example 1.94. start_forwarding usage
2601
+   Example 1.96. start_forwarding usage
2565 2602
 ...
2566 2603
 start_forwarding();
2567 2604
 start_forwarding("directional");
2568 2605
 start_forwarding("address=192.168.42.42");
2569 2606
 ...
2570 2607
 
2571
-5.15.  stop_forwarding([flags])
2608
+5.17.  stop_forwarding([flags])
2572 2609
 
2573 2610
    Analogous to “unblock_dtmf”, but controls the PCM forwarding feature
2574 2611
    instead of DTMF blocking.
2575 2612
 
2576 2613
    See “unblock_dtmf” for a description of the flags that can be used.
2577 2614
 
2578
-   Example 1.95. stop_forwarding usage
2615
+   Example 1.97. stop_forwarding usage
2579 2616
 ...
2580 2617
 stop_forwarding();
2581 2618
 stop_forwarding("all");
2582 2619
 ...
2583 2620
 
2584
-5.16.  play_media([flags])
2621
+5.18.  play_media([flags])
2585 2622
 
2586 2623
    Instructs rtpengine to play a prerecorded announcement to the selected
2587 2624
    call participant, either from a local file or from a file stored in a
... ...
@@ -2594,25 +2631,25 @@ stop_forwarding("all");
2594 2631
    the duration of the media being played, expressed in milliseconds. If
2595 2632
    the length of the media could not be determined, it's set to -1.
2596 2633
 
2597
-   Example 1.96. play_media usage
2634
+   Example 1.98. play_media usage
2598 2635
 ...
2599 2636
 play_media("file=/use/share/media/hello.wav");
2600 2637
 play_media("from-tag=tfugklbildfydrtuykgfv db-id=12345");
2601 2638
 ...
2602 2639
 
2603
-5.17.  stop_media([flags])
2640
+5.19.  stop_media([flags])
2604 2641
 
2605 2642
    Stops the playback of media previously started by “play_media”. Media
2606 2643
    playback is automatically stopped when the end of the media file is
2607 2644
    reached, so this function is only useful to prematurely stop playback.
2608 2645
 
2609
-   Example 1.97. stop_media usage
2646
+   Example 1.99. stop_media usage
2610 2647
 ...
2611 2648
 stop_media();
2612 2649
 stop_media("from-tag=5yqaeriguhxcikxj");
2613 2650
 ...
2614 2651
 
2615
-5.18.  play_dtmf([flags])
2652
+5.20.  play_dtmf([flags])
2616 2653
 
2617 2654
    Injects a DTMF event into the media stream. Depending on which codecs
2618 2655
    were negotiated, this either injects an RFC 2833/4733 DTMF event, or an
... ...
@@ -2637,7 +2674,7 @@ stop_media("from-tag=5yqaeriguhxcikxj");
2637 2674
    alternative pause length can be given through the “pause” option,
2638 2675
    between 100 and 5000 ms.
2639 2676
 
2640
-   Example 1.98. play_dtmf usage
2677
+   Example 1.100. play_dtmf usage
2641 2678
 ...
2642 2679
 play_dtmf("from-tag=5yqaeriguhxcikxj code=#");
2643 2680
 play_dtmf("code=1 volume=5 duration=300 pause=150");
... ...
@@ -2654,7 +2691,7 @@ play_dtmf("code=1 volume=5 duration=300 pause=150");
2654 2691
    packet counters. The statistics must be retrieved before the session is
2655 2692
    deleted (before rtpengine_delete()).
2656 2693
 
2657
-   Example 1.99. $rtpstat Usage
2694
+   Example 1.101. $rtpstat Usage
2658 2695
 ...
2659 2696
     append_hf("X-RTP-Statistics: $rtpstat\r\n");
2660 2697
 ...
... ...
@@ -2677,7 +2714,7 @@ play_dtmf("code=1 volume=5 duration=300 pause=150");
2677 2714
    is enabled, the sessions are still allowed to finish for the hidden old
2678 2715
    nodes.
2679 2716
 
2680
-   Example 1.100.  rtpengine.reload usage
2717
+   Example 1.102.  rtpengine.reload usage
2681 2718
 ...
2682 2719
 $ kamcmd rtpengine.reload
2683 2720
 ...
... ...
@@ -2708,7 +2745,7 @@ $ kamcmd rtpengine.reload
2708 2745
    NOTE: If you specify an IPv6 RTP, the proxy url must be prefixed with
2709 2746
    :: to escape the :: from the IPv6 address. See the example below.
2710 2747
 
2711
-   Example 1.101.  rtpengine.enable usage
2748
+   Example 1.103.  rtpengine.enable usage
2712 2749
 ...
2713 2750
 $ kamcmd rtpengine.enable udp:192.168.2.133:8081 0
2714 2751
 $ kamcmd rtpengine.enable ::udp6:fe80::9a90:96ff:fea8:fd99:9999 1
... ...
@@ -2731,7 +2768,7 @@ $ kamcmd rtpengine.enable all 1
2731 2768
    NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to
2732 2769
    escape the :: from the IPv6 address. See the example below.
2733 2770
 
2734
-   Example 1.102.  rtpengine.show usage
2771
+   Example 1.104.  rtpengine.show usage
2735 2772
 ...
2736 2773
 $ kamcmd rtpengine.show udp:192.168.2.133:8081
2737 2774
 $ kamcmd rtpengine.show ::udp6:fe80::9a90:96ff:fea8:fd99:9999
... ...
@@ -2751,7 +2788,7 @@ $ kamcmd rtpengine.show all
2751 2788
    NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to
2752 2789
    escape the :: from the IPv6 address. See the example below.
2753 2790
 
2754
-   Example 1.103.  rtpengine.ping usage
2791
+   Example 1.105.  rtpengine.ping usage
2755 2792
 ...
2756 2793
 $ kamcmd rtpengine.ping udp:192.168.2.133:8081
2757 2794
 $ kamcmd rtpengine.ping ::udp6:fe80::9a90:96ff:fea8:fd99:9999
... ...
@@ -2763,7 +2800,7 @@ $ kamcmd rtpengine.ping all
2763 2800
    Print the total number of hash entries in the hash table at a given
2764 2801
    moment.
2765 2802
 
2766
-   Example 1.104.  rtpengine.get_hash_total usage
2803
+   Example 1.106.  rtpengine.get_hash_total usage
2767 2804
 ...
2768 2805
 $ kamcmd rtpengine.get_hash_total
2769 2806
 ...