Browse code

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

Kamailio Dev authored on 29/10/2021 10:46:23
Showing 1 changed files
... ...
@@ -489,6 +489,7 @@ Chapter 1. Admin Guide
489 489
    The following modules must be loaded before this module:
490 490
      * tm module - (optional) if you want to have rtpengine_manage() fully
491 491
        functional
492
+       lwsc module - (optional) if you plan to use “wsapi” parameter
492 493
 
493 494
 3.2. External Libraries or Applications
494 495
 
Browse code

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

Kamailio Dev authored on 28/09/2021 08:46:28
Showing 1 changed files
... ...
@@ -2748,6 +2748,8 @@ ackets, 0 errors
2748 2748
    is enabled, the sessions are still allowed to finish for the hidden old
2749 2749
    nodes.
2750 2750
 
2751
+   The execution of this command is limited to 10 seconds intervals.
2752
+
2751 2753
    Example 1.103.  rtpengine.reload usage
2752 2754
 ...
2753 2755
 $ kamcmd rtpengine.reload
Browse code

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

Kamailio Dev authored on 27/08/2021 16:31:13
Showing 1 changed files
... ...
@@ -138,20 +138,21 @@ Richard Fuchs
138 138
               5.4. rtpengine_info([flags])
139 139
               5.5. rtpengine_delete([flags])
140 140
               5.6. rtpengine_query([flags])
141
-              5.7. rtpengine_manage([flags])
142
-              5.8. start_recording([flags])
143
-              5.9. stop_recording([flags])
144
-              5.10. block_dtmf([flags])
145
-              5.11. unblock_dtmf([flags])
146
-              5.12. block_media([flags])
147
-              5.13. unblock_media([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])
141
+              5.7. rtpengine_query_v(fmt, var)
142
+              5.8. rtpengine_manage([flags])
143
+              5.9. start_recording([flags])
144
+              5.10. stop_recording([flags])
145
+              5.11. block_dtmf([flags])
146
+              5.12. unblock_dtmf([flags])
147
+              5.13. block_media([flags])
148
+              5.14. unblock_media([flags])
149
+              5.15. silence_media([flags])
150
+              5.16. unsilence_media([flags])
151
+              5.17. start_forwarding([flags])
152
+              5.18. stop_forwarding([flags])
153
+              5.19. play_media([flags])
154
+              5.20. stop_media([flags])
155
+              5.21. play_dtmf([flags])
155 156
 
156 157
         6. Exported Pseudo Variables
157 158
 
... ...
@@ -256,26 +257,27 @@ Richard Fuchs
256 257
    1.84. rtpengine_info usage
257 258
    1.85. rtpengine_delete usage
258 259
    1.86. rtpengine_query usage
259
-   1.87. rtpengine_manage usage
260
-   1.88. start_recording usage
261
-   1.89. stop_recording usage
262
-   1.90. block_dtmf usage
263
-   1.91. unblock_dtmf usage
264
-   1.92. block_media usage
265
-   1.93. unblock_media usage
266
-   1.94. silence_media usage
267
-   1.95. unsilence_media usage
268
-   1.96. start_forwarding usage
269
-   1.97. stop_forwarding usage
270
-   1.98. play_media usage
271
-   1.99. stop_media usage
272
-   1.100. play_dtmf usage
273
-   1.101. $rtpestat Usage
274
-   1.102. rtpengine.reload usage
275
-   1.103. rtpengine.enable usage
276
-   1.104. rtpengine.show usage
277
-   1.105. rtpengine.ping usage
278
-   1.106. rtpengine.get_hash_total usage
260
+   1.87. rtpengine_query_v usage
261
+   1.88. rtpengine_manage usage
262
+   1.89. start_recording usage
263
+   1.90. stop_recording usage
264
+   1.91. block_dtmf usage
265
+   1.92. unblock_dtmf usage
266
+   1.93. block_media usage
267
+   1.94. unblock_media usage
268
+   1.95. silence_media usage
269
+   1.96. unsilence_media usage
270
+   1.97. start_forwarding usage
271
+   1.98. stop_forwarding usage
272
+   1.99. play_media usage
273
+   1.100. stop_media usage
274
+   1.101. play_dtmf usage
275
+   1.102. $rtpestat Usage
276
+   1.103. rtpengine.reload usage
277
+   1.104. rtpengine.enable usage
278
+   1.105. rtpengine.show usage
279
+   1.106. rtpengine.ping usage
280
+   1.107. rtpengine.get_hash_total usage
279 281
 
280 282
 Chapter 1. Admin Guide
281 283
 
... ...
@@ -378,20 +380,21 @@ Chapter 1. Admin Guide
378 380
         5.4. rtpengine_info([flags])
379 381
         5.5. rtpengine_delete([flags])
380 382
         5.6. rtpengine_query([flags])
381
-        5.7. rtpengine_manage([flags])
382
-        5.8. start_recording([flags])
383
-        5.9. stop_recording([flags])
384
-        5.10. block_dtmf([flags])
385
-        5.11. unblock_dtmf([flags])
386
-        5.12. block_media([flags])
387
-        5.13. unblock_media([flags])
388
-        5.14. silence_media([flags])
389
-        5.15. unsilence_media([flags])
390
-        5.16. start_forwarding([flags])
391
-        5.17. stop_forwarding([flags])
392
-        5.18. play_media([flags])
393
-        5.19. stop_media([flags])
394
-        5.20. play_dtmf([flags])
383
+        5.7. rtpengine_query_v(fmt, var)
384
+        5.8. rtpengine_manage([flags])
385
+        5.9. start_recording([flags])
386
+        5.10. stop_recording([flags])
387
+        5.11. block_dtmf([flags])
388
+        5.12. unblock_dtmf([flags])
389
+        5.13. block_media([flags])
390
+        5.14. unblock_media([flags])
391
+        5.15. silence_media([flags])
392
+        5.16. unsilence_media([flags])
393
+        5.17. start_forwarding([flags])
394
+        5.18. stop_forwarding([flags])
395
+        5.19. play_media([flags])
396
+        5.20. stop_media([flags])
397
+        5.21. play_dtmf([flags])
395 398
 
396 399
    6. Exported Pseudo Variables
397 400
 
... ...
@@ -2018,20 +2021,21 @@ modparam("rtpengine", "wsapi", "lwsc")
2018 2021
    5.4. rtpengine_info([flags])
2019 2022
    5.5. rtpengine_delete([flags])
2020 2023
    5.6. rtpengine_query([flags])
2021
-   5.7. rtpengine_manage([flags])
2022
-   5.8. start_recording([flags])
2023
-   5.9. stop_recording([flags])
2024
-   5.10. block_dtmf([flags])
2025
-   5.11. unblock_dtmf([flags])
2026
-   5.12. block_media([flags])
2027
-   5.13. unblock_media([flags])
2028
-   5.14. silence_media([flags])
2029
-   5.15. unsilence_media([flags])
2030
-   5.16. start_forwarding([flags])
2031
-   5.17. stop_forwarding([flags])
2032
-   5.18. play_media([flags])
2033
-   5.19. stop_media([flags])
2034
-   5.20. play_dtmf([flags])
2024
+   5.7. rtpengine_query_v(fmt, var)
2025
+   5.8. rtpengine_manage([flags])
2026
+   5.9. start_recording([flags])
2027
+   5.10. stop_recording([flags])
2028
+   5.11. block_dtmf([flags])
2029
+   5.12. unblock_dtmf([flags])
2030
+   5.13. block_media([flags])
2031
+   5.14. unblock_media([flags])
2032
+   5.15. silence_media([flags])
2033
+   5.16. unsilence_media([flags])
2034
+   5.17. start_forwarding([flags])
2035
+   5.18. stop_forwarding([flags])
2036
+   5.19. play_media([flags])
2037
+   5.20. stop_media([flags])
2038
+   5.21. play_dtmf([flags])
2035 2039
 
2036 2040
 5.1.  set_rtpengine_set(setid[, setid])
2037 2041
 
... ...
@@ -2419,7 +2423,27 @@ rtpengine_delete();
2419 2423
 rtpengine_query();
2420 2424
 ...
2421 2425
 
2422
-5.7.  rtpengine_manage([flags])
2426
+5.7.  rtpengine_query_v(fmt, var)
2427
+
2428
+   Queries the RTP proxy about the current status and statistics of a
2429
+   running call, converts the response to JSON according to fmt and sets
2430
+   the variable var with the result.
2431
+
2432
+   The fmt parameter can be 'j' for compacted JSON and 'jp' for
2433
+   pretty-formatted JSON.
2434
+
2435
+   The var parameter has to be the name of a writable variable.
2436
+
2437
+   This function can be used from ANY_ROUTE.
2438
+
2439
+   Example 1.87. rtpengine_query_v usage
2440
+...
2441
+if(rtpengine_query_v("j", "$var(rdata)")) {
2442
+    xinfo("rtpengine query response: $var(rdata)\n");
2443
+}
2444
+...
2445
+
2446
+5.8.  rtpengine_manage([flags])
2423 2447
 
2424 2448
    Manage the RTPEngine session - it combines the functionality of
2425 2449
    rtpengine_offer(), rtpengine_answer() and rtpengine_delete(), detecting
... ...
@@ -2450,12 +2474,12 @@ rtpengine_query();
2450 2474
 
2451 2475
    This function can be used from ANY_ROUTE.
2452 2476
 
2453
-   Example 1.87. rtpengine_manage usage
2477
+   Example 1.88. rtpengine_manage usage
2454 2478
 ...
2455 2479
 rtpengine_manage();
2456 2480
 ...
2457 2481
 
2458
-5.8.  start_recording([flags])
2482
+5.9.  start_recording([flags])
2459 2483
 
2460 2484
    This function will send a signal to the RTP relay to record the RTP
2461 2485
    stream flowing through it. See also the option “record-call=on” for
... ...
@@ -2469,12 +2493,12 @@ rtpengine_manage();
2469 2493
 
2470 2494
    This function can be used from REQUEST_ROUTE and ONREPLY_ROUTE.
2471 2495
 
2472
-   Example 1.88. start_recording usage
2496
+   Example 1.89. start_recording usage
2473 2497
 ...
2474 2498
 start_recording();
2475 2499
 ...
2476 2500
 
2477
-5.9.  stop_recording([flags])
2501
+5.10.  stop_recording([flags])
2478 2502
 
2479 2503
    This function will send a signal to the RTP relay to stop recording the
2480 2504
    RTP stream flowing through it. See also the option “record-call=off”
... ...
@@ -2488,12 +2512,12 @@ start_recording();
2488 2512
 
2489 2513
    This function can be used from REQUEST_ROUTE and ONREPLY_ROUTE.
2490 2514
 
2491
-   Example 1.89. stop_recording usage
2515
+   Example 1.90. stop_recording usage
2492 2516
 ...
2493 2517
 stop_recording();
2494 2518
 ...
2495 2519
 
2496
-5.10.  block_dtmf([flags])
2520
+5.11.  block_dtmf([flags])
2497 2521
 
2498 2522
    This function will instruct the RTP proxy to start blocking DTMF event
2499 2523
    packets (RFC 4733). DTMF events will still be processed by the RTP
... ...
@@ -2512,14 +2536,14 @@ stop_recording();
2512 2536
 
2513 2537
    This function can be used from REQUEST_ROUTE and ONREPLY_ROUTE.
2514 2538
 
2515
-   Example 1.90. block_dtmf usage
2539
+   Example 1.91. block_dtmf usage
2516 2540
 ...
2517 2541
 block_dtmf();
2518 2542
 block_dtmf("directional");
2519 2543
 block_dtmf("address=192.168.42.42");
2520 2544
 ...
2521 2545
 
2522
-5.11.  unblock_dtmf([flags])
2546
+5.12.  unblock_dtmf([flags])
2523 2547
 
2524 2548
    Reverses the effects of a previously issued block_dtmf call. See above
2525 2549
    for a description of which flags can be used.
... ...
@@ -2528,13 +2552,13 @@ block_dtmf("address=192.168.42.42");
2528 2552
    unblocking DTMF events for the entire call (i.e. no flags given) will
2529 2553
    not remove these blocks. The flag “all” can be used to achieve this.
2530 2554
 
2531
-   Example 1.91. unblock_dtmf usage
2555
+   Example 1.92. unblock_dtmf usage
2532 2556
 ...
2533 2557
 unblock_dtmf();
2534 2558
 unblock_dtmf("all");
2535 2559
 ...
2536 2560
 
2537
-5.12.  block_media([flags])
2561
+5.13.  block_media([flags])
2538 2562
 
2539 2563
    Analogous to “block_dtmf”, but blocks media RTP packets instead of DTMF
2540 2564
    events. When media is blocked, DTMF events still pass through the RTP
... ...
@@ -2542,27 +2566,27 @@ unblock_dtmf("all");
2542 2566
 
2543 2567
    See “block_dtmf” for a description of the flags that can be used.
2544 2568
 
2545
-   Example 1.92. block_media usage
2569
+   Example 1.93. block_media usage
2546 2570
 ...
2547 2571
 block_media();
2548 2572
 block_media("directional");
2549 2573
 block_media("address=192.168.42.42");
2550 2574
 ...
2551 2575
 
2552
-5.13.  unblock_media([flags])
2576
+5.14.  unblock_media([flags])
2553 2577
 
2554 2578
    Analogous to “unblock_dtmf”, but applies to media RTP packets instead
2555 2579
    of DTMF events.
2556 2580
 
2557 2581
    See “unblock_dtmf” for a description of the flags that can be used.
2558 2582
 
2559
-   Example 1.93. unblock_media usage
2583
+   Example 1.94. unblock_media usage
2560 2584
 ...
2561 2585
 unblock_media();
2562 2586
 unblock_media("all");
2563 2587
 ...
2564 2588
 
2565
-5.14.  silence_media([flags])
2589
+5.15.  silence_media([flags])
2566 2590
 
2567 2591
    Identical to “block_media” except that media RTP packets are not simply
2568 2592
    blocked, but instead have their audio payload replaced by silence
... ...
@@ -2571,27 +2595,27 @@ unblock_media("all");
2571 2595
 
2572 2596
    See “block_dtmf” for a description of the flags that can be used.
2573 2597
 
2574
-   Example 1.94. silence_media usage
2598
+   Example 1.95. silence_media usage
2575 2599
 ...
2576 2600
 silence_media();
2577 2601
 silence_media("directional");
2578 2602
 silence_media("address=192.168.42.42");
2579 2603
 ...
2580 2604
 
2581
-5.15.  unsilence_media([flags])
2605
+5.16.  unsilence_media([flags])
2582 2606
 
2583 2607
    Identical to “unblock_media” except that it's the counterpart to
2584 2608
    “silence_media”.
2585 2609
 
2586 2610
    See “unblock_dtmf” for a description of the flags that can be used.
2587 2611
 
2588
-   Example 1.95. unsilence_media usage
2612
+   Example 1.96. unsilence_media usage
2589 2613
 ...
2590 2614
 unsilence_media();
2591 2615
 unsilence_media("all");
2592 2616
 ...
2593 2617
 
2594
-5.16.  start_forwarding([flags])
2618
+5.17.  start_forwarding([flags])
2595 2619
 
2596 2620
    Controls the PCM forwarding feature of the recording daemon. Unlike the
2597 2621
    recording feature, PCM forwarding can be done directionally for
... ...
@@ -2600,27 +2624,27 @@ unsilence_media("all");
2600 2624
 
2601 2625
    See “block_dtmf” for a description of the flags that can be used.
2602 2626
 
2603
-   Example 1.96. start_forwarding usage
2627
+   Example 1.97. start_forwarding usage
2604 2628
 ...
2605 2629
 start_forwarding();
2606 2630
 start_forwarding("directional");
2607 2631
 start_forwarding("address=192.168.42.42");
2608 2632
 ...
2609 2633
 
2610
-5.17.  stop_forwarding([flags])
2634
+5.18.  stop_forwarding([flags])
2611 2635
 
2612 2636
    Analogous to “unblock_dtmf”, but controls the PCM forwarding feature
2613 2637
    instead of DTMF blocking.
2614 2638
 
2615 2639
    See “unblock_dtmf” for a description of the flags that can be used.
2616 2640
 
2617
-   Example 1.97. stop_forwarding usage
2641
+   Example 1.98. stop_forwarding usage
2618 2642
 ...
2619 2643
 stop_forwarding();
2620 2644
 stop_forwarding("all");
2621 2645
 ...
2622 2646
 
2623
-5.18.  play_media([flags])
2647
+5.19.  play_media([flags])
2624 2648
 
2625 2649
    Instructs rtpengine to play a prerecorded announcement to the selected
2626 2650
    call participant, either from a local file or from a file stored in a
... ...
@@ -2633,25 +2657,25 @@ stop_forwarding("all");
2633 2657
    the duration of the media being played, expressed in milliseconds. If
2634 2658
    the length of the media could not be determined, it's set to -1.
2635 2659
 
2636
-   Example 1.98. play_media usage
2660
+   Example 1.99. play_media usage
2637 2661
 ...
2638 2662
 play_media("file=/use/share/media/hello.wav");
2639 2663
 play_media("from-tag=tfugklbildfydrtuykgfv db-id=12345");
2640 2664
 ...
2641 2665
 
2642
-5.19.  stop_media([flags])
2666
+5.20.  stop_media([flags])
2643 2667
 
2644 2668
    Stops the playback of media previously started by “play_media”. Media
2645 2669
    playback is automatically stopped when the end of the media file is
2646 2670
    reached, so this function is only useful to prematurely stop playback.
2647 2671
 
2648
-   Example 1.99. stop_media usage
2672
+   Example 1.100. stop_media usage
2649 2673
 ...
2650 2674
 stop_media();
2651 2675
 stop_media("from-tag=5yqaeriguhxcikxj");
2652 2676
 ...
2653 2677
 
2654
-5.20.  play_dtmf([flags])
2678
+5.21.  play_dtmf([flags])
2655 2679
 
2656 2680
    Injects a DTMF event into the media stream. Depending on which codecs
2657 2681
    were negotiated, this either injects an RFC 2833/4733 DTMF event, or an
... ...
@@ -2676,7 +2700,7 @@ stop_media("from-tag=5yqaeriguhxcikxj");
2676 2700
    alternative pause length can be given through the “pause” option,
2677 2701
    between 100 and 5000 ms.
2678 2702
 
2679
-   Example 1.100. play_dtmf usage
2703
+   Example 1.101. play_dtmf usage
2680 2704
 ...
2681 2705
 play_dtmf("from-tag=5yqaeriguhxcikxj code=#");
2682 2706
 play_dtmf("code=1 volume=5 duration=300 pause=150");
... ...
@@ -2694,7 +2718,7 @@ play_dtmf("code=1 volume=5 duration=300 pause=150");
2694 2718
    packet counters. The statistics must be retrieved before the session is
2695 2719
    deleted (before rtpengine_delete()).
2696 2720
 
2697
-   Example 1.101. $rtpestat Usage
2721
+   Example 1.102. $rtpestat Usage
2698 2722
 ...
2699 2723
     append_hf("X-RTP-Statistics: $rtpestat\r\n");
2700 2724
 ...
... ...
@@ -2724,7 +2748,7 @@ ackets, 0 errors
2724 2748
    is enabled, the sessions are still allowed to finish for the hidden old
2725 2749
    nodes.
2726 2750
 
2727
-   Example 1.102.  rtpengine.reload usage
2751
+   Example 1.103.  rtpengine.reload usage
2728 2752
 ...
2729 2753
 $ kamcmd rtpengine.reload
2730 2754
 ...
... ...
@@ -2755,7 +2779,7 @@ $ kamcmd rtpengine.reload
2755 2779
    NOTE: If you specify an IPv6 RTP, the proxy url must be prefixed with
2756 2780
    :: to escape the :: from the IPv6 address. See the example below.
2757 2781
 
2758
-   Example 1.103.  rtpengine.enable usage
2782
+   Example 1.104.  rtpengine.enable usage
2759 2783
 ...
2760 2784
 $ kamcmd rtpengine.enable udp:192.168.2.133:8081 0
2761 2785
 $ kamcmd rtpengine.enable ::udp6:fe80::9a90:96ff:fea8:fd99:9999 1
... ...
@@ -2778,7 +2802,7 @@ $ kamcmd rtpengine.enable all 1
2778 2802
    NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to
2779 2803
    escape the :: from the IPv6 address. See the example below.
2780 2804
 
2781
-   Example 1.104.  rtpengine.show usage
2805
+   Example 1.105.  rtpengine.show usage
2782 2806
 ...
2783 2807
 $ kamcmd rtpengine.show udp:192.168.2.133:8081
2784 2808
 $ kamcmd rtpengine.show ::udp6:fe80::9a90:96ff:fea8:fd99:9999
... ...
@@ -2798,7 +2822,7 @@ $ kamcmd rtpengine.show all
2798 2822
    NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to
2799 2823
    escape the :: from the IPv6 address. See the example below.
2800 2824
 
2801
-   Example 1.105.  rtpengine.ping usage
2825
+   Example 1.106.  rtpengine.ping usage
2802 2826
 ...
2803 2827
 $ kamcmd rtpengine.ping udp:192.168.2.133:8081
2804 2828
 $ kamcmd rtpengine.ping ::udp6:fe80::9a90:96ff:fea8:fd99:9999
... ...
@@ -2810,7 +2834,7 @@ $ kamcmd rtpengine.ping all
2810 2834
    Print the total number of hash entries in the hash table at a given
2811 2835
    moment.
2812 2836
 
2813
-   Example 1.106.  rtpengine.get_hash_total usage
2837
+   Example 1.107.  rtpengine.get_hash_total usage
2814 2838
 ...
2815 2839
 $ kamcmd rtpengine.get_hash_total
2816 2840
 ...
Browse code

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

Kamailio Dev authored on 27/08/2021 11:16:21
Showing 1 changed files
... ...
@@ -155,7 +155,8 @@ Richard Fuchs
155 155
 
156 156
         6. Exported Pseudo Variables
157 157
 
158
-              6.1. $rtpstat
158
+              6.1. $rtpestat
159
+              6.2. $rtpstat
159 160
 
160 161
         7. RPC Commands
161 162
 
... ...
@@ -269,7 +270,7 @@ Richard Fuchs
269 270
    1.98. play_media usage
270 271
    1.99. stop_media usage
271 272
    1.100. play_dtmf usage
272
-   1.101. $rtpstat Usage
273
+   1.101. $rtpestat Usage
273 274
    1.102. rtpengine.reload usage
274 275
    1.103. rtpengine.enable usage
275 276
    1.104. rtpengine.show usage
... ...
@@ -394,7 +395,8 @@ Chapter 1. Admin Guide
394 395
 
395 396
    6. Exported Pseudo Variables
396 397
 
397
-        6.1. $rtpstat
398
+        6.1. $rtpestat
399
+        6.2. $rtpstat
398 400
 
399 401
    7. RPC Commands
400 402
 
... ...
@@ -2682,19 +2684,27 @@ play_dtmf("code=1 volume=5 duration=300 pause=150");
2682 2684
 
2683 2685
 6. Exported Pseudo Variables
2684 2686
 
2685
-   6.1. $rtpstat
2687
+   6.1. $rtpestat
2688
+   6.2. $rtpstat
2686 2689
 
2687
-6.1. $rtpstat
2690
+6.1. $rtpestat
2688 2691
 
2689
-   Returns the RTP statistics from the RTP proxy. The RTP statistics from
2690
-   the RTP proxy are provided as a string and it does contain several
2692
+   Returns the RTP statistics from the RTP relay. The RTP statistics from
2693
+   the RTP relay are provided as a string and it does contain several
2691 2694
    packet counters. The statistics must be retrieved before the session is
2692 2695
    deleted (before rtpengine_delete()).
2693 2696
 
2694
-   Example 1.101. $rtpstat Usage
2697
+   Example 1.101. $rtpestat Usage
2695 2698
 ...
2696
-    append_hf("X-RTP-Statistics: $rtpstat\r\n");
2699
+    append_hf("X-RTP-Statistics: $rtpestat\r\n");
2697 2700
 ...
2701
+    # $rtpestat = RTP: 54846 bytes, 1447 packets, 0 errors; RTCP: 336 bytes, 3 p
2702
+ackets, 0 errors
2703
+...
2704
+
2705
+6.2. $rtpstat
2706
+
2707
+   Same as $rtpestat.
2698 2708
 
2699 2709
 7. RPC Commands
2700 2710
 
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
 ...
Browse code

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

Kamailio Dev authored on 13/07/2021 13:16:15
Showing 1 changed files
... ...
@@ -648,9 +648,11 @@ modparam("rtpengine", "rtpengine_tout_ms", 2000)
648 648
 4.5. rtpengine_allow_op (integer)
649 649
 
650 650
    Enable this setting to allow finishing the current sessions while
651
-   denying new sessions for the manually deactivated nodes via kamctl
652
-   command i.e. "disabled(permanent)" nodes. Probably the manually
653
-   deactivated machine is still running(did not crash).
651
+   denying new sessions for deactivated nodes.
652
+
653
+   Nodes can be manually deactivated via kamctl command i.e.
654
+   "disabled(permanent)" nodes. Probably the manually deactivated machine
655
+   is still running(did not crash).
654 656
 
655 657
    This is useful when deactivating a node for maintenance and reject new
656 658
    sessions but allow current ones to finish.
... ...
@@ -664,6 +666,12 @@ modparam("rtpengine", "rtpengine_tout_ms", 2000)
664 666
 
665 667
    Default value is “0” to keep the current behaviour.
666 668
 
669
+   If value set to “1” it will send commands to all disabled nodes for the
670
+   existing call.
671
+
672
+   If value set to “2” it will send commands only to manually disabled
673
+   nodes. (Not when timeout is disabled or node broken)
674
+
667 675
    Example 1.5. Set rtpengine_allow_op parameter
668 676
 ...
669 677
 modparam("rtpengine", "rtpengine_allow_op", 1)
Browse code

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

Kamailio Dev authored on 29/03/2021 10:01:13
Showing 1 changed files
... ...
@@ -421,7 +421,9 @@ Chapter 1. Admin Guide
421 421
    module parameter definition for syntax description.
422 422
 
423 423
    The balancing inside a set is done automatically by the module based on
424
-   the weight of each RTPEngine from the set.
424
+   the weight of each RTPEngine from the set. The default weight is 1, if
425
+   another RTPEngine should be used twice as often as the first one, one
426
+   would specify the weight 2 for this server, for example.
425 427
 
426 428
    The selection of the set is done from script prior using
427 429
    rtpengine_delete(), rtpengine_offer() or rtpengine_answer() functions -
Browse code

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

Kamailio Dev authored on 25/03/2021 20:16:12
Showing 1 changed files
... ...
@@ -128,6 +128,7 @@ Richard Fuchs
128 128
               4.76. mos_average_samples_B_pv (string)
129 129
               4.77. control_cmd_tos (integer)
130 130
               4.78. hash_algo (integer)
131
+              4.79. wsapi (string)
131 132
 
132 133
         5. Functions
133 134
 
... ...
@@ -245,30 +246,31 @@ Richard Fuchs
245 246
    1.77. Set mos_average_samples_B_pv parameter
246 247
    1.78. Set control_cmd_tos parameter
247 248
    1.79. Set hash_algo parameter
248
-   1.80. set_rtpengine_set usage
249
-   1.81. rtpengine_offer usage
250
-   1.82. rtpengine_answer usage
251
-   1.83. rtpengine_info usage
252
-   1.84. rtpengine_delete usage
253
-   1.85. rtpengine_query usage
254
-   1.86. rtpengine_manage usage
255
-   1.87. start_recording usage
256
-   1.88. stop_recording usage
257
-   1.89. block_dtmf usage
258
-   1.90. unblock_dtmf usage
259
-   1.91. block_media usage
260
-   1.92. unblock_media usage
261
-   1.93. start_forwarding usage
262
-   1.94. stop_forwarding usage
263
-   1.95. play_media usage
264
-   1.96. stop_media usage
265
-   1.97. play_dtmf usage
266
-   1.98. $rtpstat Usage
267
-   1.99. rtpengine.reload usage
268
-   1.100. rtpengine.enable usage
269
-   1.101. rtpengine.show usage
270
-   1.102. rtpengine.ping usage
271
-   1.103. rtpengine.get_hash_total usage
249
+   1.80. Set wsapi parameter
250
+   1.81. set_rtpengine_set usage
251
+   1.82. rtpengine_offer usage
252
+   1.83. rtpengine_answer usage
253
+   1.84. rtpengine_info usage
254
+   1.85. rtpengine_delete usage
255
+   1.86. rtpengine_query usage
256
+   1.87. rtpengine_manage usage
257
+   1.88. start_recording usage
258
+   1.89. stop_recording usage
259
+   1.90. block_dtmf usage
260
+   1.91. unblock_dtmf usage
261
+   1.92. block_media usage
262
+   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
272 274
 
273 275
 Chapter 1. Admin Guide
274 276
 
... ...
@@ -361,6 +363,7 @@ Chapter 1. Admin Guide
361 363
         4.76. mos_average_samples_B_pv (string)
362 364
         4.77. control_cmd_tos (integer)
363 365
         4.78. hash_algo (integer)
366
+        4.79. wsapi (string)
364 367
 
365 368
    5. Functions
366 369
 
... ...
@@ -560,11 +563,12 @@ Chapter 1. Admin Guide
560 563
    4.76. mos_average_samples_B_pv (string)
561 564
    4.77. control_cmd_tos (integer)
562 565
    4.78. hash_algo (integer)
566
+   4.79. wsapi (string)
563 567
 
564 568
 4.1. rtpengine_sock (string)
565 569
 
566 570
    Definition of socket(s) used to connect to (a set) RTP proxy. It may
567
-   specify a UNIX socket or an IPv4/IPv6 UDP socket.
571
+   specify an IPv4/IPv6 UDP socket or a websocket URI.
568 572
 
569 573
    Default value is “NONE” (disabled).
570 574
 
... ...
@@ -572,6 +576,12 @@ Chapter 1. Admin Guide
572 576
 ...
573 577
 # single rtproxy