rtpengine Module

Maxim Sobolev

   Sippy Software, Inc.

Juha Heinanen

   TuTPro, Inc.

Edited by

Maxim Sobolev

Bogdan-Andrei Iancu

Juha Heinanen

Sas Ovidiu

Carsten Bock

   ng-voice GmbH

Richard Fuchs

   Sipwise GmbH

   Copyright © 2003-2008 Sippy Software, Inc.

   Copyright © 2005 Voice Sistem SRL

   Copyright © 2009-2014 TuTPro Inc.

   Copyright © 2010 VoIPEmbedded Inc.

   Copyright © 2013-2019 Sipwise GmbH
     __________________________________________________________________

   Table of Contents

   1. Admin Guide

        1. Overview
        2. Usage With Multiple RTPEngine Instances
        3. Dependencies

              3.1. Kamailio Modules
              3.2. External Libraries or Applications

        4. Parameters

              4.1. rtpengine_sock (string)
              4.2. rtpengine_disable_tout (integer)
              4.3. aggressive_redetection (integer)
              4.4. rtpengine_tout_ms (integer)
              4.5. rtpengine_allow_op (integer)
              4.6. queried_nodes_limit (integer)
              4.7. rtpengine_retr (integer)
              4.8. extra_id_pv (string)
              4.9. setid_avp (string)
              4.10. force_send_interface (string)
              4.11. read_sdp_pv (string)
              4.12. write_sdp_pv (string)
              4.13. rtp_inst_pvar (string)
              4.14. hash_table_size (integer)
              4.15. hash_table_tout (integer)
              4.16. db_url (string)
              4.17. table_name (string)
              4.18. setid_col (string)
              4.19. url_col (string)
              4.20. weight_col (string)
              4.21. disabled_col (string)
              4.22. setid_default (integer)
              4.23. media_duration (string)
              4.24. mos_min_pv (string)
              4.25. mos_min_at_pv (string)
              4.26. mos_min_packetloss_pv (string)
              4.27. mos_min_jitter_pv (string)
              4.28. mos_min_roundtrip_pv (string)
              4.29. mos_max_pv (string)
              4.30. mos_max_at_pv (string)
              4.31. mos_max_packetloss_pv (string)
              4.32. mos_max_jitter_pv (string)
              4.33. mos_max_roundtrip_pv (string)
              4.34. mos_average_pv (string)
              4.35. mos_average_packetloss_pv (string)
              4.36. mos_average_jitter_pv (string)
              4.37. mos_average_roundtrip_pv (string)
              4.38. mos_average_samples_pv (string)
              4.39. mos_A_label_pv (string)
              4.40. mos_min_A_pv (string)
              4.41. mos_min_at_A_pv (string)
              4.42. mos_min_packetloss_A_pv (string)
              4.43. mos_min_jitter_A_pv (string)
              4.44. mos_min_roundtrip_A_pv (string)
              4.45. mos_max_A_pv (string)
              4.46. mos_max_at_A_pv (string)
              4.47. mos_max_packetloss_A_pv (string)
              4.48. mos_max_jitter_A_pv (string)
              4.49. mos_max_roundtrip_A_pv (string)
              4.50. mos_average_A_pv (string)
              4.51. mos_average_packetloss_A_pv (string)
              4.52. mos_average_jitter_A_pv (string)
              4.53. mos_average_roundtrip_A_pv (string)
              4.54. mos_average_samples_A_pv (string)
              4.55. mos_B_label_pv (string)
              4.56. mos_min_B_pv (string)
              4.57. mos_min_at_B_pv (string)
              4.58. mos_min_packetloss_B_pv (string)
              4.59. mos_min_jitter_B_pv (string)
              4.60. mos_min_roundtrip_B_pv (string)
              4.61. mos_max_B_pv (string)
              4.62. mos_max_at_B_pv (string)
              4.63. mos_max_packetloss_B_pv (string)
              4.64. mos_max_jitter_B_pv (string)
              4.65. mos_max_roundtrip_B_pv (string)
              4.66. mos_average_B_pv (string)
              4.67. mos_average_packetloss_B_pv (string)
              4.68. mos_average_jitter_B_pv (string)
              4.69. mos_average_roundtrip_B_pv (string)
              4.70. mos_average_samples_B_pv (string)
              4.71. control_cmd_tos (integer)
              4.72. hash_algo (integer)

        5. Functions

              5.1. set_rtpengine_set(setid[, setid])
              5.2. rtpengine_offer([flags])
              5.3. rtpengine_answer([flags])
              5.4. rtpengine_info([flags])
              5.5. rtpengine_delete([flags])
              5.6. rtpengine_query([flags])
              5.7. rtpengine_manage([flags])
              5.8. start_recording([flags])
              5.9. stop_recording([flags])
              5.10. block_dtmf([flags])
              5.11. unblock_dtmf([flags])
              5.12. block_media([flags])
              5.13. unblock_media([flags])
              5.14. start_forwarding([flags])
              5.15. stop_forwarding([flags])
              5.16. play_media([flags])
              5.17. stop_media([flags])
              5.18. play_dtmf([flags])

        6. Exported Pseudo Variables

              6.1. $rtpstat

        7. RPC Commands

              7.1. rtpengine.reload
              7.2. rtpengine.enable proxy_url/all 0/1
              7.3. rtpengine.show proxy_url/all
              7.4. rtpengine.ping proxy_url/all
              7.5. rtpengine.get_hash_total

   2. Frequently Asked Questions

   List of Examples

   1.1. Set rtpengine_sock parameter
   1.2. Set rtpengine_disable_tout parameter
   1.3. Set aggressive_redetection parameter
   1.4. Set rtpengine_tout_ms parameter
   1.5. Set rtpengine_allow_op parameter
   1.6. Set queried_nodes_limit parameter
   1.7. Set rtpengine_retr parameter
   1.8. Set extra_id_pv parameter
   1.9. Set setid_avp parameter
   1.10. Set force_send_interface parameter
   1.11. Set read_sdp_pv parameter
   1.12. Set write_sdp_pv parameter
   1.13. Set rtp_inst_pvar parameter
   1.14. Set hash_table_size parameter
   1.15. Set hash_table_tout parameter
   1.16. Set db_url parameter
   1.17. Set table_name parameter
   1.18. Setup rtpengine table
   1.19. Set setid_col parameter
   1.20. Set url_col parameter
   1.21. Set weight_col parameter
   1.22. Set disabled_col parameter
   1.23. Set setid_default parameter
   1.24. Set media_duration parameter
   1.25. Set mos_min_pv parameter
   1.26. Set mos_min_at_pv parameter
   1.27. Set mos_min_packetloss_pv parameter
   1.28. Set mos_min_jitter_pv parameter
   1.29. Set mos_min_roundtrip_pv parameter
   1.30. Set mos_max_pv parameter
   1.31. Set mos_max_at_pv parameter
   1.32. Set mos_max_packetloss_pv parameter
   1.33. Set mos_max_jitter_pv parameter
   1.34. Set mos_max_roundtrip_pv parameter
   1.35. Set mos_average_pv parameter
   1.36. Set mos_average_packetloss_pv parameter
   1.37. Set mos_average_jitter_pv parameter
   1.38. Set mos_average_roundtrip_pv parameter
   1.39. Set mos_average_samples_pv parameter
   1.40. Set mos_A_label_pv parameter
   1.41. Set mos_min_A_pv parameter
   1.42. Set mos_min_at_A_pv parameter
   1.43. Set mos_min_packetloss_A_pv parameter
   1.44. Set mos_min_jitter_A_pv parameter
   1.45. Set mos_min_roundtrip_A_pv parameter
   1.46. Set mos_max_A_pv parameter
   1.47. Set mos_max_at_A_pv parameter
   1.48. Set mos_max_packetloss_A_pv parameter
   1.49. Set mos_max_jitter_A_pv parameter
   1.50. Set mos_max_roundtrip_A_pv parameter
   1.51. Set mos_average_A_pv parameter
   1.52. Set mos_average_packetloss_A_pv parameter
   1.53. Set mos_average_jitter_A_pv parameter
   1.54. Set mos_average_roundtrip_A_pv parameter
   1.55. Set mos_average_samples_A_pv parameter
   1.56. Set mos_B_label_pv parameter
   1.57. Set mos_min_B_pv parameter
   1.58. Set mos_min_at_B_pv parameter
   1.59. Set mos_min_packetloss_B_pv parameter
   1.60. Set mos_min_jitter_B_pv parameter
   1.61. Set mos_min_roundtrip_B_pv parameter
   1.62. Set mos_max_B_pv parameter
   1.63. Set mos_max_at_B_pv parameter
   1.64. Set mos_max_packetloss_B_pv parameter
   1.65. Set mos_max_jitter_B_pv parameter
   1.66. Set mos_max_roundtrip_B_pv parameter
   1.67. Set mos_average_B_pv parameter
   1.68. Set mos_average_packetloss_B_pv parameter
   1.69. Set mos_average_jitter_B_pv parameter
   1.70. Set mos_average_roundtrip_B_pv parameter
   1.71. Set mos_average_samples_B_pv parameter
   1.72. Set control_cmd_tos parameter
   1.73. Set hash_algo parameter
   1.74. set_rtpengine_set usage
   1.75. rtpengine_offer usage
   1.76. rtpengine_answer usage
   1.77. rtpengine_info usage
   1.78. rtpengine_delete usage
   1.79. rtpengine_query usage
   1.80. rtpengine_manage usage
   1.81. start_recording usage
   1.82. stop_recording usage
   1.83. block_dtmf usage
   1.84. unblock_dtmf usage
   1.85. block_media usage
   1.86. unblock_media usage
   1.87. start_forwarding usage
   1.88. stop_forwarding usage
   1.89. play_media usage
   1.90. stop_media usage
   1.91. play_dtmf usage
   1.92. $rtpstat Usage
   1.93. rtpengine.reload usage
   1.94. rtpengine.enable usage
   1.95. rtpengine.show usage
   1.96. rtpengine.ping usage
   1.97. rtpengine.get_hash_total usage

Chapter 1. Admin Guide

   Table of Contents

   1. Overview
   2. Usage With Multiple RTPEngine Instances
   3. Dependencies

        3.1. Kamailio Modules
        3.2. External Libraries or Applications

   4. Parameters

        4.1. rtpengine_sock (string)
        4.2. rtpengine_disable_tout (integer)
        4.3. aggressive_redetection (integer)
        4.4. rtpengine_tout_ms (integer)
        4.5. rtpengine_allow_op (integer)
        4.6. queried_nodes_limit (integer)
        4.7. rtpengine_retr (integer)
        4.8. extra_id_pv (string)
        4.9. setid_avp (string)
        4.10. force_send_interface (string)
        4.11. read_sdp_pv (string)
        4.12. write_sdp_pv (string)
        4.13. rtp_inst_pvar (string)
        4.14. hash_table_size (integer)
        4.15. hash_table_tout (integer)
        4.16. db_url (string)
        4.17. table_name (string)
        4.18. setid_col (string)
        4.19. url_col (string)
        4.20. weight_col (string)
        4.21. disabled_col (string)
        4.22. setid_default (integer)
        4.23. media_duration (string)
        4.24. mos_min_pv (string)
        4.25. mos_min_at_pv (string)
        4.26. mos_min_packetloss_pv (string)
        4.27. mos_min_jitter_pv (string)
        4.28. mos_min_roundtrip_pv (string)
        4.29. mos_max_pv (string)
        4.30. mos_max_at_pv (string)
        4.31. mos_max_packetloss_pv (string)
        4.32. mos_max_jitter_pv (string)
        4.33. mos_max_roundtrip_pv (string)
        4.34. mos_average_pv (string)
        4.35. mos_average_packetloss_pv (string)
        4.36. mos_average_jitter_pv (string)
        4.37. mos_average_roundtrip_pv (string)
        4.38. mos_average_samples_pv (string)
        4.39. mos_A_label_pv (string)
        4.40. mos_min_A_pv (string)
        4.41. mos_min_at_A_pv (string)
        4.42. mos_min_packetloss_A_pv (string)
        4.43. mos_min_jitter_A_pv (string)
        4.44. mos_min_roundtrip_A_pv (string)
        4.45. mos_max_A_pv (string)
        4.46. mos_max_at_A_pv (string)
        4.47. mos_max_packetloss_A_pv (string)
        4.48. mos_max_jitter_A_pv (string)
        4.49. mos_max_roundtrip_A_pv (string)
        4.50. mos_average_A_pv (string)
        4.51. mos_average_packetloss_A_pv (string)
        4.52. mos_average_jitter_A_pv (string)
        4.53. mos_average_roundtrip_A_pv (string)
        4.54. mos_average_samples_A_pv (string)
        4.55. mos_B_label_pv (string)
        4.56. mos_min_B_pv (string)
        4.57. mos_min_at_B_pv (string)
        4.58. mos_min_packetloss_B_pv (string)
        4.59. mos_min_jitter_B_pv (string)
        4.60. mos_min_roundtrip_B_pv (string)
        4.61. mos_max_B_pv (string)
        4.62. mos_max_at_B_pv (string)
        4.63. mos_max_packetloss_B_pv (string)
        4.64. mos_max_jitter_B_pv (string)
        4.65. mos_max_roundtrip_B_pv (string)
        4.66. mos_average_B_pv (string)
        4.67. mos_average_packetloss_B_pv (string)
        4.68. mos_average_jitter_B_pv (string)
        4.69. mos_average_roundtrip_B_pv (string)
        4.70. mos_average_samples_B_pv (string)
        4.71. control_cmd_tos (integer)
        4.72. hash_algo (integer)

   5. Functions

        5.1. set_rtpengine_set(setid[, setid])
        5.2. rtpengine_offer([flags])
        5.3. rtpengine_answer([flags])
        5.4. rtpengine_info([flags])
        5.5. rtpengine_delete([flags])
        5.6. rtpengine_query([flags])
        5.7. rtpengine_manage([flags])
        5.8. start_recording([flags])
        5.9. stop_recording([flags])
        5.10. block_dtmf([flags])
        5.11. unblock_dtmf([flags])
        5.12. block_media([flags])
        5.13. unblock_media([flags])
        5.14. start_forwarding([flags])
        5.15. stop_forwarding([flags])
        5.16. play_media([flags])
        5.17. stop_media([flags])
        5.18. play_dtmf([flags])

   6. Exported Pseudo Variables

        6.1. $rtpstat

   7. RPC Commands

        7.1. rtpengine.reload
        7.2. rtpengine.enable proxy_url/all 0/1
        7.3. rtpengine.show proxy_url/all
        7.4. rtpengine.ping proxy_url/all
        7.5. rtpengine.get_hash_total

1. Overview

   This is a module that enables media streams to be proxied via an RTP
   proxy. The only RTP proxy currently known to work with this module is
   the Sipwise rtpengine https://github.com/sipwise/rtpengine. The
   rtpengine module is a modified version of the original rtpproxy module
   using a new control protocol. The module is designed to be a drop-in
   replacement for the old module from a configuration file point of view,
   however due to the incompatible control protocol, it only works with
   RTP proxies which specifically support it.

2. Usage With Multiple RTPEngine Instances

   The rtpengine module can support multiple RTPEngine instances for
   balancing/distribution and control/selection purposes.

   The module allows definition of several sets of RTPEngines.
   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 “rtpengine_sock”
   module parameter definition for syntax description.

   The balancing inside a set is done automatically by the module based on
   the weight of each RTPEngine from the set.

   The selection of the set is done from script prior using
   rtpengine_delete(), rtpengine_offer() or rtpengine_answer() functions -
   see the set_rtpengine_set() function.

   Another way to select the set is to define setid_avp module parameter
   and assign setid to the defined avp before calling rtpengine_offer() or
   rtpengine_manage() function. If forwarding of the requests fails and
   there is another branch to try, remember to unset the avp after calling
   rtpengine_delete() function.

   For backward compatibility reasons, a set with no id take by default
   the id 0. Also if no set is explicitly set before rtpengine_delete(),
   rtpengine_offer() or rtpengine_answer() the 0 id set will be used.

   IMPORTANT: if you use multiple sets, take care and use the same set for
   both rtpengine_offer()/rtpengine_answer() and rtpengine_delete()!! If
   the set was selected using setid_avp, the avp needs to be set only once
   before rtpengine_offer() or rtpengine_manage() call.

   From the current implementation point of view, the sets of rtpengine
   nodes are in shared memory(shm), so all processes can see a common list
   of nodes. There is no locking when setting the nodes enabled/disabled
   (to keep the memory access as fast as possible). Thus, problems related
   to node state might appear for concurrent processes that might set the
   nodes enabled/disabled(e.g. by fifo command). These robustness problems
   are overcome as follows.

   If the current process sees the selected node as disabled, the node is
   force tested before the current process actually accepts the disabled
   state. If the test succeeds, the process will set the node as enabled
   (but other concurrent process might still see it as disabled).

   If the current process sees the selected node as enabled, it does no
   additional checks and sends the command which will fail in case the
   machine is actually broken. The process will set the node as disabled
   (but other concurrent process might still see it as enabled).

   The 'kamctl fifo' commands (including rtpengine ones) are executed by
   an exclusive process which operate on the same shared memory node list.

   All the nodes are pinged in the beginning by all the processes, even if
   the node list is shared memory.

3. Dependencies

   3.1. Kamailio Modules
   3.2. External Libraries or Applications

3.1. Kamailio Modules

   The following modules must be loaded before this module:
     * tm module - (optional) if you want to have rtpengine_manage() fully
       functional

3.2. External Libraries or Applications

   The following libraries or applications must be installed before
   running Kamailio with this module loaded:
     * None.

4. Parameters

   4.1. rtpengine_sock (string)
   4.2. rtpengine_disable_tout (integer)
   4.3. aggressive_redetection (integer)
   4.4. rtpengine_tout_ms (integer)
   4.5. rtpengine_allow_op (integer)
   4.6. queried_nodes_limit (integer)
   4.7. rtpengine_retr (integer)
   4.8. extra_id_pv (string)
   4.9. setid_avp (string)
   4.10. force_send_interface (string)
   4.11. read_sdp_pv (string)
   4.12. write_sdp_pv (string)
   4.13. rtp_inst_pvar (string)
   4.14. hash_table_size (integer)
   4.15. hash_table_tout (integer)
   4.16. db_url (string)
   4.17. table_name (string)
   4.18. setid_col (string)
   4.19. url_col (string)
   4.20. weight_col (string)
   4.21. disabled_col (string)
   4.22. setid_default (integer)
   4.23. media_duration (string)
   4.24. mos_min_pv (string)
   4.25. mos_min_at_pv (string)
   4.26. mos_min_packetloss_pv (string)
   4.27. mos_min_jitter_pv (string)
   4.28. mos_min_roundtrip_pv (string)
   4.29. mos_max_pv (string)
   4.30. mos_max_at_pv (string)
   4.31. mos_max_packetloss_pv (string)
   4.32. mos_max_jitter_pv (string)
   4.33. mos_max_roundtrip_pv (string)
   4.34. mos_average_pv (string)
   4.35. mos_average_packetloss_pv (string)
   4.36. mos_average_jitter_pv (string)
   4.37. mos_average_roundtrip_pv (string)
   4.38. mos_average_samples_pv (string)
   4.39. mos_A_label_pv (string)
   4.40. mos_min_A_pv (string)
   4.41. mos_min_at_A_pv (string)
   4.42. mos_min_packetloss_A_pv (string)
   4.43. mos_min_jitter_A_pv (string)
   4.44. mos_min_roundtrip_A_pv (string)
   4.45. mos_max_A_pv (string)
   4.46. mos_max_at_A_pv (string)
   4.47. mos_max_packetloss_A_pv (string)
   4.48. mos_max_jitter_A_pv (string)
   4.49. mos_max_roundtrip_A_pv (string)
   4.50. mos_average_A_pv (string)
   4.51. mos_average_packetloss_A_pv (string)
   4.52. mos_average_jitter_A_pv (string)
   4.53. mos_average_roundtrip_A_pv (string)
   4.54. mos_average_samples_A_pv (string)
   4.55. mos_B_label_pv (string)
   4.56. mos_min_B_pv (string)
   4.57. mos_min_at_B_pv (string)
   4.58. mos_min_packetloss_B_pv (string)
   4.59. mos_min_jitter_B_pv (string)
   4.60. mos_min_roundtrip_B_pv (string)
   4.61. mos_max_B_pv (string)
   4.62. mos_max_at_B_pv (string)
   4.63. mos_max_packetloss_B_pv (string)
   4.64. mos_max_jitter_B_pv (string)
   4.65. mos_max_roundtrip_B_pv (string)
   4.66. mos_average_B_pv (string)
   4.67. mos_average_packetloss_B_pv (string)
   4.68. mos_average_jitter_B_pv (string)
   4.69. mos_average_roundtrip_B_pv (string)
   4.70. mos_average_samples_B_pv (string)
   4.71. control_cmd_tos (integer)
   4.72. hash_algo (integer)

4.1. rtpengine_sock (string)

   Definition of socket(s) used to connect to (a set) RTP proxy. It may
   specify a UNIX socket or an IPv4/IPv6 UDP socket.

   Default value is “NONE” (disabled).

   Example 1.1. Set rtpengine_sock parameter
...
# single rtproxy
modparam("rtpengine", "rtpengine_sock", "udp:localhost:12221")
# multiple rtproxies for LB with weights (missing weight defaults to 1)
modparam("rtpengine", "rtpengine_sock",
        "udp:localhost:12221=2 udp:localhost:12222=1")
# multiple sets of multiple rtproxies
modparam("rtpengine", "rtpengine_sock",
        "1 == udp:localhost:12221 udp:localhost:12222")
modparam("rtpengine", "rtpengine_sock",
        "2 == udp:localhost:12225")
...

4.2. rtpengine_disable_tout (integer)

   Once an RTP proxy was found unreachable and marked as disabled, the
   rtpengine module will not attempt to establish communication to that
   RTP proxy for rtpengine_disable_tout seconds.

   Default value is “60”.

   Can be set at runtime, e.g.:
                        $ kamcmd cfg.set_now_int rtpengine rtpengine_disable_tou
t 20

   Example 1.2. Set rtpengine_disable_tout parameter
...
modparam("rtpengine", "rtpengine_disable_tout", 20)
...

4.3. aggressive_redetection (integer)

   This parameter determines what happens when all potential rtpengines
   are found to be unreachable. If enabled, the sip server will send pings
   to all rtpengines, else no rtpengine will be queried until its
   rtpengine_disable_tout timeout passes.

   Default value is “1” (enabled).

   Can be set at runtime, e.g.:
                        $ kamcmd cfg.set_now_int rtpengine aggressive_redetectio
n 0

   Example 1.3. Set aggressive_redetection parameter
...
modparam("rtpengine", "aggressive_redetection", 0)
...

4.4. rtpengine_tout_ms (integer)

   Timeout value expressed in milliseconds in waiting for reply from RTP
   proxy.

   Default value is “1000”.

   Can be set at runtime, e.g.:
                        $ kamcmd cfg.set_now_int rtpengine rtpengine_tout_ms 100
0

   Example 1.4. Set rtpengine_tout_ms parameter
...
modparam("rtpengine", "rtpengine_tout_ms", 2000)
...

4.5. rtpengine_allow_op (integer)

   Enable this setting to allow finishing the current sessions while
   denying new sessions for the manually deactivated nodes via kamctl
   command i.e. "disabled(permanent)" nodes. Probably the manually
   deactivated machine is still running(did not crash).

   This is useful when deactivating a node for maintenance and reject new
   sessions but allow current ones to finish.

   The behaviour is the same for a rtpengine deleted table node. When the
   node is deleted from the table and the table reloaded (see
   nh_reload_rtpp) the node actually is disabled(permanent) and hidden for
   display. Next time the same node will be added in the table, and the
   database content reloaded, the re-activated node will be updated and
   re-displayed.

   Default value is “0” to keep the current behaviour.

   Example 1.5. Set rtpengine_allow_op parameter
...
modparam("rtpengine", "rtpengine_allow_op", 1)
...

4.6. queried_nodes_limit (integer)

   The total number of nodes inside a set (sets are configurable via
   rtpengine_sock function) to be queried before giving up establishing a
   session. This brings more flexibility in case checking all rtpengines
   would take too long. Max limit is 30.

   By default all nodes in a set are tried before giving up communicating
   with the rtpengines.

   Can be set at runtime, e.g.:
                        $ kamcmd cfg.set_now_int rtpengine queried_nodes_limit 5

   Example 1.6. Set queried_nodes_limit parameter
...
modparam("rtpengine", "queried_nodes_limit", 5)
...

4.7. rtpengine_retr (integer)

   How many times the module should retry to send and receive after
   timeout was generated.

   Default value is “5”.

   Can be set at runtime, e.g.:
                        $ kamcmd cfg.set_now_int rtpengine rtpengine_retr 5

   Example 1.7. Set rtpengine_retr parameter
...
modparam("rtpengine", "rtpengine_retr", 2)
...

4.8. extra_id_pv (string)

   The parameter sets the PV definition to use when the “via-branch”
   parameter is used on rtpengine_delete(), rtpengine_offer(),
   rtpengine_answer() or rtpengine_manage() command.

   Default is empty, the “via-branch” parameter may not be used then.

   Example 1.8. Set extra_id_pv parameter
...
modparam("rtpengine", "extra_id_pv", "$avp(extra_id)")
...

4.9. setid_avp (string)

   The parameter defines an AVP that, if set, determines which RTP proxy
   set rtpengine_offer(), rtpengine_answer(), rtpengine_delete(), and
   rtpengine_manage() functions use.

   There is no default value.

   Example 1.9. Set setid_avp parameter
...
modparam("rtpengine", "setid_avp", "$avp(setid)")
...

4.10. force_send_interface (string)

   Forces all control messages between the SIP proxy and the RTP proxy to
   be sent from the specified local interface. Both IPv4 and IPv6
   addresses are supported. If not specified, the default interface
   selected by the operating system will be used. Note: when
   rtpengine_sock is a IPv6 link-local address, one _must_ set this
   parameter in order to successfully connect to RTP engine. This is
   necessarily because OS needs additional scope_id hint to communicate
   over IPv6 link locals. The scope_id is resolved based on the given
   IPv6.

   There is no default value.

   Example 1.10. Set force_send_interface parameter
...
modparam("rtpengine", "force_send_interface", "10.3.7.123")
modparam("rtpengine", "force_send_interface", "2001:8d8:1ff:10c0:9a90:96ff:fea8:
fd99")
...

4.11. read_sdp_pv (string)

   If this parameter is set to a valid AVP or script var specifier,
   rtpengine will take the input SDP from this pv instead of the message
   body.

   There is no default value.

   Example 1.11. Set read_sdp_pv parameter
...
modparam("rtpengine", "read_sdp_pv", "$var(sdp)")
...
route {
        ...
        $var(sdp) = $rb + "a=foo:bar\r\n";
        rtpengine_manage();
}

4.12. write_sdp_pv (string)

   If this parameter is set to a valid AVP or script var specifier, the
   SDP returned by rtpengine in the offer/answer operations is returned in
   the specified variable instead of the message body.

   There is no default value.

   Example 1.12. Set write_sdp_pv parameter
...
modparam("rtpengine", "write_sdp_pv", "$avp(sdp)")
...
route {
        ...
        rtpengine_manage();
        set_body("$avp(sdp)a=baz123\r\n", "application/sdp");
}

4.13. rtp_inst_pvar (string)

   A pseudo variable to store the chosen RTP Engine IP address. If this
   parameter is set, the IP address and port of the instance chosen will
   be stored in the given variable.

   By default, this parameter is not set.

   Example 1.13. Set rtp_inst_pvar parameter
...
modparam("rtpengine", "rtp_inst_pvar", "$avp(RTP_INSTANCE)")
...

4.14. hash_table_size (integer)

   To maintain information about a selected rtp machine node for a given
   call, entries are added in a hashtable of (callid, node) pairs. This
   parameter sets the size of the hash table. Default value is 256.

   NOTE: If configured size is less than 1, the size will be defaulted to
   1.

   Example 1.14. Set hash_table_size parameter
...
modparam("rtpengine", "hash_table_size", 123)
...

4.15. hash_table_tout (integer)

   Number of seconds after an rtpengine hash table entry is marked for
   deletion. By default, this parameter is set to 3600 (seconds).

   To maintain information about a selected rtp machine node for a given
   call, entries are added in a hashtable of (callid, node) pairs. When
   command comes the callid is looked up in this table. If found, the
   chosen node is used. If not found, choose a new node, insert the callid
   in the hashtable and return the chosen node.

   NOTE: In the current implementation, the actual deletion happens on the
   fly, while insert/remove/lookup the hastable, only for the entries in
   the insert/remove/lookup path.

   NOTE: When configuring this parameter, one should consider maximum call
   time VS share memory for unfinished calls.

   Example 1.15. Set hash_table_tout parameter
...
modparam("rtpengine", "hash_table_tout", 300)
...

4.16. db_url (string)

   The rtpengine database url. If present and valid, it activates database
   mode. In this mode the node information is read from database, not from
   configuration modparam parameters.

   By default, the database url is NULL (not set).

   Example 1.16. Set db_url parameter
...
modparam("rtpengine", "db_url", "mysql://pass@localhost/db")
...

4.17. table_name (string)

   The rtpengine table name. If database mode is activated (i.e. valid
   db_url), sets the name of the rtpengine table, on startup.

   By default, the rtpengine table name is "rtpengine".

   NOTE: One needs to add the version of the rtpengine table in the
   version table. The current version is version 1.

   Example 1.17. Set table_name parameter
...
modparam("rtpengine", "table_name", "rtpengine_table_name")
...

   Example 1.18. Setup rtpengine table
mysql> describe rtpengine;
+----------+------------------+------+-----+---------------------+-------+
| Field    | Type             | Null | Key | Default             | Extra |
+----------+------------------+------+-----+---------------------+-------+
| setid    | int(10) unsigned | NO   | PRI | 0                   |       |
| url      | varchar(64)      | NO   | PRI | NULL                |       |
| weight   | int(10) unsigned | NO   |     | 1                   |       |
| disabled | int(1)           | NO   |     | 0                   |       |
| stamp    | datetime         | NO   |     | 1900-01-01 00:00:01 |       |
+----------+------------------+------+-----+---------------------+-------+

mysql> select * from rtpengine;
+-------+----------------------------+--------+----------+---------------------+
| setid | url                        | weight | disabled | stamp               |
+-------+----------------------------+--------+----------+---------------------+
|     0 | udp:rtpengine1.domain:8800 |      1 |        0 | 2016-03-10 10:30:54 |
|     0 | udp:rtpengine2.domain:8800 |      1 |        1 | 2016-03-10 10:30:54 |
+-------+----------------------------+--------+----------+---------------------+

mysql> select * from version;
+---------------------------+---------------+
| table_name                | table_version |
+---------------------------+---------------+
| rtpengine                 |             1 |
+---------------------------+---------------+

4.18. setid_col (string)

   Column name for the "setid" in the rtpengine table. If database mode is
   activated (i.e. valid db_url), set the setid of rtp nodes according to
   this column, on startup. The MySQL value for this column should be INT
   UNSIGNED.

   By default, the column name is "setid".

   Example 1.19. Set setid_col parameter
...
modparam("rtpengine", "setid_col", "setid_column_name")
...

4.19. url_col (string)

   Column name for the url in the rtpengine table. If database mode is
   activated (i.e. valid db_url), set the url of rtp nodes according to
   this column, on startup. The MySQL value for this column should be
   VARCHAR.

   By default, the column name is "url".

   Example 1.20. Set url_col parameter
...
modparam("rtpengine", "url_col", "url_column_name")
...

4.20. weight_col (string)

   Column name for weight in the rtpengine table. If database mode is
   activated (i.e. valid db_url), set the weight of rtp nodes according to
   this column, on startup. The column value has priority over the URL
   weight. The MySQL value for this column should be INT UNSIGNED.

   By default, the column name is "weight".

   Example 1.21. Set weight_col parameter
...
modparam("rtpengine", "weight_col", "weight_column_name")
...

4.21. disabled_col (string)

   Column name in the rtpengine table. If database mode is activated (i.e.
   valid db_url), set the state of rtp nodes according to this column, on
   startup. The MySQL value for this column should be INT.

   By default, the column name is "disabled".

   Example 1.22. Set disabled_col parameter
...
modparam("rtpengine", "disabled_col", "disabled_column_name")
...

4.22. setid_default (integer)

   The default set of nodes to be used.

   By default, the setid is 0.

   NOTE that if setid_avp is configured, this value will be ignored and
   the active set will be chosen according to the setid_avp.

   Example 1.23. Set setid_default parameter
...
modparam("rtpengine", "setid_default", 11)
...

4.23. media_duration (string)

   The name of a pseudovariable to be filled in with the length of the
   media being played back after a call to “play_media”, expressed in
   milliseconds. It's set to -1 if the length of the media could not be
   determined.

   By default, this parameter is not set.

   Example 1.24. Set media_duration parameter
...
modparam("rtpengine", "media_duration", "$avp(MEDIA_DURATION)")
...

4.24. mos_min_pv (string)

   The name of a pseudovariable to hold the minimum encountered MOS value
   for the call. The value typically has a range of 1.0 through 5.0.

   There is no default value.

   This value is filled in after invoking“rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Example 1.25. Set mos_min_pv parameter
...
modparam("rtpengine", "mos_min_pv", "$avp(mos_min)")
...

4.25. mos_min_at_pv (string)

   The name of a pseudovariable to hold the timestamp of when the minimum
   MOS value was encountered during the call, such as “0:30” for 30
   seconds after the start of the call.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Example 1.26. Set mos_min_at_pv parameter
...
modparam("rtpengine", "mos_min_at_pv", "$avp(mos_min_at)")
...

4.26. mos_min_packetloss_pv (string)

   The name of a pseudovariable to hold the amount of packetloss in
   percent at the time the minimum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Example 1.27. Set mos_min_packetloss_pv parameter
...
modparam("rtpengine", "mos_min_packetloss_pv", "$avp(mos_min_packetloss)")
...

4.27. mos_min_jitter_pv (string)

   The name of a pseudovariable to hold the amount of jitter in
   milliseconds at the time the minimum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Example 1.28. Set mos_min_jitter_pv parameter
...
modparam("rtpengine", "mos_min_jitter_pv", "$avp(mos_min_jitter)")
...

4.28. mos_min_roundtrip_pv (string)

   The name of a pseudovariable to hold the packet round-trip time in
   milliseconds at the time the minimum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Example 1.29. Set mos_min_roundtrip_pv parameter
...
modparam("rtpengine", "mos_min_roundtrip_pv", "$avp(mos_min_roundtrip)")
...

4.29. mos_max_pv (string)

   The name of a pseudovariable to hold the maximum encountered MOS value
   for the call. The value typically has a range of 1.0 through 5.0.

   There is no default value.

   This value is filled in after invoking“rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Example 1.30. Set mos_max_pv parameter
...
modparam("rtpengine", "mos_max_pv", "$avp(mos_max)")
...

4.30. mos_max_at_pv (string)

   The name of a pseudovariable to hold the timestamp of when the maximum
   MOS value was encountered during the call, such as “0:30” for 30
   seconds after the start of the call.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Example 1.31. Set mos_max_at_pv parameter
...
modparam("rtpengine", "mos_max_at_pv", "$avp(mos_max_at)")
...

4.31. mos_max_packetloss_pv (string)

   The name of a pseudovariable to hold the amount of packetloss in
   percent at the time the maximum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Example 1.32. Set mos_max_packetloss_pv parameter
...
modparam("rtpengine", "mos_max_packetloss_pv", "$avp(mos_max_packetloss)")
...

4.32. mos_max_jitter_pv (string)

   The name of a pseudovariable to hold the amount of jitter in
   milliseconds at the time the maximum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Example 1.33. Set mos_max_jitter_pv parameter
...
modparam("rtpengine", "mos_max_jitter_pv", "$avp(mos_max_jitter)")
...

4.33. mos_max_roundtrip_pv (string)

   The name of a pseudovariable to hold the packet round-trip time in
   milliseconds at the time the maximum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Example 1.34. Set mos_max_roundtrip_pv parameter
...
modparam("rtpengine", "mos_max_roundtrip_pv", "$avp(mos_max_roundtrip)")
...

4.34. mos_average_pv (string)

   The name of a pseudovariable to hold the average (median) MOS value for
   the call. The value typically has a range of 1.0 through 5.0.

   There is no default value.

   This value is filled in after invoking“rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Example 1.35. Set mos_average_pv parameter
...
modparam("rtpengine", "mos_average_pv", "$avp(mos_average)")
...

4.35. mos_average_packetloss_pv (string)

   The name of a pseudovariable to hold the average (median) amount of
   packetloss in percent present throughout the call.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Example 1.36. Set mos_average_packetloss_pv parameter
...
modparam("rtpengine", "mos_average_packetloss_pv", "$avp(mos_average_packetloss)
")
...

4.36. mos_average_jitter_pv (string)

   The name of a pseudovariable to hold the average (median) amount of
   jitter in milliseconds present throughout the call.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Example 1.37. Set mos_average_jitter_pv parameter
...
modparam("rtpengine", "mos_average_jitter_pv", "$avp(mos_average_jitter)")
...

4.37. mos_average_roundtrip_pv (string)

   The name of a pseudovariable to hold the average (median) packet
   round-trip time in milliseconds present throughout the call.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Example 1.38. Set mos_average_roundtrip_pv parameter
...
modparam("rtpengine", "mos_average_roundtrip_pv", "$avp(mos_average_roundtrip)")
...

4.38. mos_average_samples_pv (string)

   The name of a pseudovariable to hold the number of samples used to
   determine the other “average” MOS data points.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Example 1.39. Set mos_average_samples_pv parameter
...
modparam("rtpengine", "mos_average_samples_pv", "$avp(mos_average_samples)")
...

4.39. mos_A_label_pv (string)

   The name of a pseudovariable to hold a custom label used in rtpengine
   signalling. If set, all the statistics pseudovariables with the “_A”
   suffix will be filled in with statistics only from the call legs that
   match the label given in this variable.

   There is no default value.

   Example 1.40. Set mos_A_label_pv parameter
...
modparam("rtpengine", "mos_A_label_pv", "$avp(mos_A_label)")
...

4.40. mos_min_A_pv (string)

   The name of a pseudovariable to hold the minimum encountered MOS value
   for the call. The value typically has a range of 1.0 through 5.0.

   There is no default value.

   This value is filled in after invoking“rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_A_label_pv” will be used in calculating this statistics value.

   Example 1.41. Set mos_min_A_pv parameter
...
modparam("rtpengine", "mos_min_A_pv", "$avp(mos_min_A)")
...

4.41. mos_min_at_A_pv (string)

   The name of a pseudovariable to hold the timestamp of when the minimum
   MOS value was encountered during the call, such as “0:30” for 30
   seconds after the start of the call.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_A_label_pv” will be used in calculating this statistics value.

   Example 1.42. Set mos_min_at_A_pv parameter
...
modparam("rtpengine", "mos_min_at_A_pv", "$avp(mos_min_at_A)")
...

4.42. mos_min_packetloss_A_pv (string)

   The name of a pseudovariable to hold the amount of packetloss in
   percent at the time the minimum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_A_label_pv” will be used in calculating this statistics value.

   Example 1.43. Set mos_min_packetloss_A_pv parameter
...
modparam("rtpengine", "mos_min_packetloss_A_pv", "$avp(mos_min_packetloss_A)")
...

4.43. mos_min_jitter_A_pv (string)

   The name of a pseudovariable to hold the amount of jitter in
   milliseconds at the time the minimum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_A_label_pv” will be used in calculating this statistics value.

   Example 1.44. Set mos_min_jitter_A_pv parameter
...
modparam("rtpengine", "mos_min_jitter_A_pv", "$avp(mos_min_jitter_A)")
...

4.44. mos_min_roundtrip_A_pv (string)

   The name of a pseudovariable to hold the packet round-trip time in
   milliseconds at the time the minimum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_A_label_pv” will be used in calculating this statistics value.

   Example 1.45. Set mos_min_roundtrip_A_pv parameter
...
modparam("rtpengine", "mos_min_roundtrip_A_pv", "$avp(mos_min_roundtrip_A)")
...

4.45. mos_max_A_pv (string)

   The name of a pseudovariable to hold the maximum encountered MOS value
   for the call. The value typically has a range of 1.0 through 5.0.

   There is no default value.

   This value is filled in after invoking“rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_A_label_pv” will be used in calculating this statistics value.

   Example 1.46. Set mos_max_A_pv parameter
...
modparam("rtpengine", "mos_max_A_pv", "$avp(mos_max_A)")
...

4.46. mos_max_at_A_pv (string)

   The name of a pseudovariable to hold the timestamp of when the maximum
   MOS value was encountered during the call, such as “0:30” for 30
   seconds after the start of the call.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_A_label_pv” will be used in calculating this statistics value.

   Example 1.47. Set mos_max_at_A_pv parameter
...
modparam("rtpengine", "mos_max_at_A_pv", "$avp(mos_max_at_A)")
...

4.47. mos_max_packetloss_A_pv (string)

   The name of a pseudovariable to hold the amount of packetloss in
   percent at the time the maximum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_A_label_pv” will be used in calculating this statistics value.

   Example 1.48. Set mos_max_packetloss_A_pv parameter
...
modparam("rtpengine", "mos_max_packetloss_A_pv", "$avp(mos_max_packetloss_A)")
...

4.48. mos_max_jitter_A_pv (string)

   The name of a pseudovariable to hold the amount of jitter in
   milliseconds at the time the maximum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_A_label_pv” will be used in calculating this statistics value.

   Example 1.49. Set mos_max_jitter_A_pv parameter
...
modparam("rtpengine", "mos_max_jitter_A_pv", "$avp(mos_max_jitter_A)")
...

4.49. mos_max_roundtrip_A_pv (string)

   The name of a pseudovariable to hold the packet round-trip time in
   milliseconds at the time the maximum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_A_label_pv” will be used in calculating this statistics value.

   Example 1.50. Set mos_max_roundtrip_A_pv parameter
...
modparam("rtpengine", "mos_max_roundtrip_A_pv", "$avp(mos_max_roundtrip_A)")
...

4.50. mos_average_A_pv (string)

   The name of a pseudovariable to hold the average (median) MOS value for
   the call. The value typically has a range of 1.0 through 5.0.

   There is no default value.

   This value is filled in after invoking“rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_A_label_pv” will be used in calculating this statistics value.

   Example 1.51. Set mos_average_A_pv parameter
...
modparam("rtpengine", "mos_average_A_pv", "$avp(mos_average_A)")
...

4.51. mos_average_packetloss_A_pv (string)

   The name of a pseudovariable to hold the average (median) amount of
   packetloss in percent present throughout the call.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_A_label_pv” will be used in calculating this statistics value.

   Example 1.52. Set mos_average_packetloss_A_pv parameter
...
modparam("rtpengine", "mos_average_packetloss_A_pv", "$avp(mos_average_packetlos
s_A)")
...

4.52. mos_average_jitter_A_pv (string)

   The name of a pseudovariable to hold the average (median) amount of
   jitter in milliseconds present throughout the call.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_A_label_pv” will be used in calculating this statistics value.

   Example 1.53. Set mos_average_jitter_A_pv parameter
...
modparam("rtpengine", "mos_average_jitter_A_pv", "$avp(mos_average_jitter_A)")
...

4.53. mos_average_roundtrip_A_pv (string)

   The name of a pseudovariable to hold the average (median) packet
   round-trip time in milliseconds present throughout the call.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_A_label_pv” will be used in calculating this statistics value.

   Example 1.54. Set mos_average_roundtrip_A_pv parameter
...
modparam("rtpengine", "mos_average_roundtrip_A_pv", "$avp(mos_average_roundtrip_
A)")
...

4.54. mos_average_samples_A_pv (string)

   The name of a pseudovariable to hold the number of samples used to
   determine the other “average” MOS data points.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_A_label_pv” will be used in calculating this statistics value.

   Example 1.55. Set mos_average_samples_A_pv parameter
...
modparam("rtpengine", "mos_average_samples_A_pv", "$avp(mos_average_samples_A)")
...

4.55. mos_B_label_pv (string)

   The name of a pseudovariable to hold a custom label used in rtpengine
   signalling. If set, all the statistics pseudovariables with the “_B”
   suffix will be filled in with statistics only from the call legs that
   match the label given in this variable.

   There is no default value.

   Example 1.56. Set mos_B_label_pv parameter
...
modparam("rtpengine", "mos_B_label_pv", "$avp(mos_B_label)")
...

4.56. mos_min_B_pv (string)

   The name of a pseudovariable to hold the minimum encountered MOS value
   for the call. The value typically has a range of 1.0 through 5.0.

   There is no default value.

   This value is filled in after invoking“rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_B_label_pv” will be used in calculating this statistics value.

   Example 1.57. Set mos_min_B_pv parameter
...
modparam("rtpengine", "mos_min_B_pv", "$avp(mos_min_B)")
...

4.57. mos_min_at_B_pv (string)

   The name of a pseudovariable to hold the timestamp of when the minimum
   MOS value was encountered during the call, such as “0:30” for 30
   seconds after the start of the call.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_B_label_pv” will be used in calculating this statistics value.

   Example 1.58. Set mos_min_at_B_pv parameter
...
modparam("rtpengine", "mos_min_at_B_pv", "$avp(mos_min_at_B)")
...

4.58. mos_min_packetloss_B_pv (string)

   The name of a pseudovariable to hold the amount of packetloss in
   percent at the time the minimum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_B_label_pv” will be used in calculating this statistics value.

   Example 1.59. Set mos_min_packetloss_B_pv parameter
...
modparam("rtpengine", "mos_min_packetloss_B_pv", "$avp(mos_min_packetloss_B)")
...

4.59. mos_min_jitter_B_pv (string)

   The name of a pseudovariable to hold the amount of jitter in
   milliseconds at the time the minimum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_B_label_pv” will be used in calculating this statistics value.

   Example 1.60. Set mos_min_jitter_B_pv parameter
...
modparam("rtpengine", "mos_min_jitter_B_pv", "$avp(mos_min_jitter_B)")
...

4.60. mos_min_roundtrip_B_pv (string)

   The name of a pseudovariable to hold the packet round-trip time in
   milliseconds at the time the minimum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_B_label_pv” will be used in calculating this statistics value.

   Example 1.61. Set mos_min_roundtrip_B_pv parameter
...
modparam("rtpengine", "mos_min_roundtrip_B_pv", "$avp(mos_min_roundtrip_B)")
...

4.61. mos_max_B_pv (string)

   The name of a pseudovariable to hold the maximum encountered MOS value
   for the call. The value typically has a range of 1.0 through 5.0.

   There is no default value.

   This value is filled in after invoking“rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_B_label_pv” will be used in calculating this statistics value.

   Example 1.62. Set mos_max_B_pv parameter
...
modparam("rtpengine", "mos_max_B_pv", "$avp(mos_max_B)")
...

4.62. mos_max_at_B_pv (string)

   The name of a pseudovariable to hold the timestamp of when the maximum
   MOS value was encountered during the call, such as “0:30” for 30
   seconds after the start of the call.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_B_label_pv” will be used in calculating this statistics value.

   Example 1.63. Set mos_max_at_B_pv parameter
...
modparam("rtpengine", "mos_max_at_B_pv", "$avp(mos_max_at_B)")
...

4.63. mos_max_packetloss_B_pv (string)

   The name of a pseudovariable to hold the amount of packetloss in
   percent at the time the maximum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_B_label_pv” will be used in calculating this statistics value.

   Example 1.64. Set mos_max_packetloss_B_pv parameter
...
modparam("rtpengine", "mos_max_packetloss_B_pv", "$avp(mos_max_packetloss_B)")
...

4.64. mos_max_jitter_B_pv (string)

   The name of a pseudovariable to hold the amount of jitter in
   milliseconds at the time the maximum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_B_label_pv” will be used in calculating this statistics value.

   Example 1.65. Set mos_max_jitter_B_pv parameter
...
modparam("rtpengine", "mos_max_jitter_B_pv", "$avp(mos_max_jitter_B)")
...

4.65. mos_max_roundtrip_B_pv (string)

   The name of a pseudovariable to hold the packet round-trip time in
   milliseconds at the time the maximum MOS value was encountered;

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_B_label_pv” will be used in calculating this statistics value.

   Example 1.66. Set mos_max_roundtrip_B_pv parameter
...
modparam("rtpengine", "mos_max_roundtrip_B_pv", "$avp(mos_max_roundtrip_B)")
...

4.66. mos_average_B_pv (string)

   The name of a pseudovariable to hold the average (median) MOS value for
   the call. The value typically has a range of 1.0 through 5.0.

   There is no default value.

   This value is filled in after invoking“rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_B_label_pv” will be used in calculating this statistics value.

   Example 1.67. Set mos_average_B_pv parameter
...
modparam("rtpengine", "mos_average_B_pv", "$avp(mos_average_B)")
...

4.67. mos_average_packetloss_B_pv (string)

   The name of a pseudovariable to hold the average (median) amount of
   packetloss in percent present throughout the call.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_B_label_pv” will be used in calculating this statistics value.

   Example 1.68. Set mos_average_packetloss_B_pv parameter
...
modparam("rtpengine", "mos_average_packetloss_B_pv", "$avp(mos_average_packetlos
s_B)")
...

4.68. mos_average_jitter_B_pv (string)

   The name of a pseudovariable to hold the average (median) amount of
   jitter in milliseconds present throughout the call.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_B_label_pv” will be used in calculating this statistics value.

   Example 1.69. Set mos_average_jitter_B_pv parameter
...
modparam("rtpengine", "mos_average_jitter_B_pv", "$avp(mos_average_jitter_B)")
...

4.69. mos_average_roundtrip_B_pv (string)

   The name of a pseudovariable to hold the average (median) packet
   round-trip time in milliseconds present throughout the call.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_B_label_pv” will be used in calculating this statistics value.

   Example 1.70. Set mos_average_roundtrip_B_pv parameter
...
modparam("rtpengine", "mos_average_roundtrip_B_pv", "$avp(mos_average_roundtrip_
B)")
...

4.70. mos_average_samples_B_pv (string)

   The name of a pseudovariable to hold the number of samples used to
   determine the other “average” MOS data points.

   There is no default value.

   This value is filled in after invoking “rtpengine_delete”,
   “rtpengine_query”, or “rtpengine_manage” if the command resulted in a
   deletion of the call (or call branch).

   Only call legs matching the rtpengine label given in the
   “mos_B_label_pv” will be used in calculating this statistics value.

   Example 1.71. Set mos_average_samples_B_pv parameter
...
modparam("rtpengine", "mos_average_samples_B_pv", "$avp(mos_average_samples_B)")
...

4.71. control_cmd_tos (integer)

   The parameter is used to set the value of “type of service (tos)” for
   the control commands (such as rtpengine_offer(), rtpengine_answer()
   etc).

   There is no default value. By default this feature is not used.

   The values not falling into the range “0-255” will be simply ignored.

   Example 1.72. Set control_cmd_tos parameter
...
modparam("rtpengine", "control_cmd_tos", 144)
...

4.72. hash_algo (integer)

   Hashing algorithm to be used in node selection algorithm. Now there are
   2 possibilities: legacy algorithm - 0(very basic hash over callid) or
   SHA1 - 1(apply sha1 over the callid and calculate hash).

   Default value is 0, legacy algorithm.

   The values not falling into the range “0-1” are ignored.

   Example 1.73. Set hash_algo parameter
...
### use SHA1 instead of legacy algorithm
modparam("rtpengine", "hash_algo", 1)
...

5. Functions

   5.1. set_rtpengine_set(setid[, setid])
   5.2. rtpengine_offer([flags])
   5.3. rtpengine_answer([flags])
   5.4. rtpengine_info([flags])
   5.5. rtpengine_delete([flags])
   5.6. rtpengine_query([flags])
   5.7. rtpengine_manage([flags])
   5.8. start_recording([flags])
   5.9. stop_recording([flags])
   5.10. block_dtmf([flags])
   5.11. unblock_dtmf([flags])
   5.12. block_media([flags])
   5.13. unblock_media([flags])
   5.14. start_forwarding([flags])
   5.15. stop_forwarding([flags])
   5.16. play_media([flags])
   5.17. stop_media([flags])
   5.18. play_dtmf([flags])

5.1.  set_rtpengine_set(setid[, setid])

   Sets the ID of the RTP proxy set to be used for the next
   rtpengine_delete(), rtpengine_offer(), rtpengine_answer() or
   rtpengine_manage() command. The parameter can be an integer or a config
   variable holding an integer.

   A second set ID can be specified to daisy-chain two RTP proxies. The
   two set IDs must be distinct from each other and there must not be any
   overlap in the proxies present in both sets. In this use case, the
   request (offer, answer, etc) is first sent to an RTP proxy from the
   first set, which rewrites the SDP body and sends it back to the module.
   The rewritten SDP body is then used to make another request to an RTP
   proxy from the second set, which rewrites the SDP body another time and
   sends it back to the module to be placed back into the SIP message.
   This is useful if you have a set of RTP proxies that the caller must
   use, and another distinct set of RTP proxies that the callee must use.
   This is supported by all rtpengine commands except rtpengine_manage().

   This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
   BRANCH_ROUTE.

   Example 1.74. set_rtpengine_set usage
...
set_rtpengine_set("2");
rtpengine_offer();
...

5.2.  rtpengine_offer([flags])

   Rewrites SDP body to ensure that media is passed through an RTP proxy.
   To be invoked on INVITE for the cases the SDP bodies are in INVITE and
   200 OK and on 200 OK when SDP bodies are in 200 OK and ACK.

   The function will return true on success and false (-1) on various
   failures, like using rtp_engine_offer() on a SIP MESSAGE request or
   communication with rtpengine fails.

   Meaning of the parameters is as follows:
     * flags - flags to turn on some features.
       The “flags” string is a list of space-separated items. Each item is
       either an individual token, or a token in “key=value” format. The
       possible tokens are described below.
          + via-branch=... - Include the “branch” value of one of the
            “Via” headers in the request to the RTP proxy. Possible values
            are: “1” - use the first “Via” header; “2” - use the second
            “Via” header; “auto” - use the first “Via” header if this is a
            request, or the second one if this is a reply; “extra” - don't
            take the value from a header, but instead use the value of the
            “extra_id_pv” variable; “next” - use the branch ID generated
            by Kamailio for the next outgoing branch; “auto-next” - use
            “next” in requests and “1” in replies; “auto-extra” - use
            “extra” in requests and “1” in replies. This can be used to
            create one media session per branch on the RTP proxy. When
            sending a subsequent “delete” command to the RTP proxy, you
            can then stop just the session for a specific branch when
            passing the flag '1' or '2' in the “rtpengine_delete”, 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 the RTP proxy gets an “offer”
            command for a new branch, and then a “delete” command for the
            previous branch, which would otherwise delete the full call,
            breaking the subsequent “answer” for the new branch. This flag
            is only supported by the Sipwise rtpengine RTP proxy at the
            moment!
          + asymmetric - flags that UA from which message is received
            doesn't support symmetric RTP. Disables learning of endpoint
            addresses in the Sipwise rtpengine proxy.
          + no-redis-update - this flag can be used by Kamailio in order
            to tell rtpengine not to persist the call into Redis upon
            receiving offer/answer() control commands. If flag is not set,
            default action is rtpengine persists call to redis.
          + force-answer - force “answer”, 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.
          + direction=... - this option specifies a logical network
            interface and should be given exactly twice. It enables RTP
            bridging between different addresses or networks of the same
            family (e.g. IPv4 to IPv4). The first instance of the option
            specifies the interface that the originator of this message
            should be using, while the second instance specifies the
            interface that the target should be using. For example, if the
            SIP message was sent by an endpoint on a private network and
            will be sent to an endpoint on the public internet, you would
            use “direction=priv direction=pub” if those two logical
            network interfaces were called “priv” and “pub” in your RTP
            proxy's configuration respectively. The direction must only be
            specified in for initial SDP offer; answers or subsequent
            offers can omit this option.
          + internal, external - shorthand for “direction=internal” and
            “direction=external” respectively. Useful for brevity or as
            legacy option if the RTP proxy only supports two network
            interfaces instead of multiple, arbitrarily named ones.
          + address-family=... - instructs the RTP proxy that the
            recipient of this SDP body expects to see addresses of a
            particular family. Possible values are “IP4” and “IP6”. For
            example, if the SDP body contains IPv4 addresses but the
            recipient only speaks IPv6, you would use “address-family=IP6”
            to bridge between the two address families.
            Sipwise rtpengine remembers the address family preference of
            each party after it has seen an SDP body from them. This means
            that normally it is only necessary to explicitly specify the
            address family in the “offer”, but not in the “answer”.
            Note: Please note, that this will only work properly with
            non-dual-stack user-agents or with dual-stack clients
            according to RFC6157 (which suggest ICE for Dual-Stack
            implementations). This short-cut will not work properly with
            RFC4091 (ANAT) compatible clients, which suggests having
            different m-lines with different IP-protocols grouped
            together.
          + force - instructs the RTP proxy to ignore marks inserted by
            another RTP proxy in transit to indicate that the session is
            already goes through another proxy. Allows creating a chain of
            proxies. Not supported and ignored by Sipwise rtpengine.
          + trust-address - flags that IP address in SDP should be
            trusted. Starting with rtpengine 3.8, this is the default
            behaviour. In older versions, without this flag the RTP proxy
            ignores the address in the SDP and uses source address of the
            SIP message as media address which is passed to the RTP proxy.
          + SIP-source-address - the opposite of trust-address. Restores
            the old default behaviour of ignoring endpoint addresses in
            the SDP body.
          + replace-origin - flags that IP from the origin description
            (o=) should be also changed.
          + replace-session-connection - flags to change the session-level
            SDP connection (c=) IP if media description also includes
            connection information.
          + symmetric - flags that for the UA from which message is
            received, support symmetric RTP must be forced. Does nothing
            with the Sipwise rtpengine proxy as it is the default.
          + repacketize=NN - requests the RTP proxy to perform
            re-packetization of RTP traffic coming from the UA which has
            sent the current message to increase or decrease payload size
            per each RTP packet forwarded if possible. The NN is the
            target payload size in ms, for the most codecs its value
            should be in 10ms increments, however for some codecs the
            increment could differ (e.g. 30ms for GSM or 20ms for G.723).
            The RTP proxy would select the closest value supported by the
            codec. This feature could be used for significantly reducing
            bandwith overhead for low bitrate codecs, for example with
            G.729 going from 10ms to 100ms saves two thirds of the network
            bandwith. Not supported by Sipwise rtpengine.
          + ICE=... - controls the RTP proxy's behaviour regarding ICE
            attributes within the SDP body. Possible values are: “force” -
            discard any ICE attributes already present in the SDP body and
            then generate and insert new ICE data, leaving itself as the
            only ICE candidates; “force-relay” - discard any “relay” type
            ICE attributes already present in the SDP body and then
            generate and insert itself as the only ICE “relay” candidates;
            “remove” instructs the RTP proxy to discard any ICE attributes
            and not insert any new ones into the SDP. The default (if no
            “ICE=...” is given at all), new ICE data will only be
            generated if no ICE was present in the SDP originally;
            otherwise the RTP proxy will only insert itself as additional
            ICE candidate. Other SDP substitutions (c=, m=, etc) are
            unaffected by this flag.
          + RTP, SRTP, DTLS, AVP, AVPF - These flags control the RTP
            transport protocol that should be used towards the recipient
            of the SDP. If none of them are specified, the protocol given
            in the SDP is left untouched. Otherwise, the “SRTP” flag
            indicates that SRTP should be used, while “RTP” indicates that
            SRTP should not be used. “AVPF” indicates that the advanced
            RTCP profile with feedback messages should be used, and “AVP”
            indicates that the regular RTCP profile should be used. See
            also the next set of flags below.
          + RTP/AVP, RTP/SAVP, UDP/TLS/RTP/SAVP, RTP/AVPF, RTP/SAVPF,
            UDP/TLS/RTP/SAVPF - these serve as an alternative, more
            explicit way to select between the different RTP protocols and
            profiles supported by the RTP proxy. For example, giving the
            flag “RTP/SAVPF” has the same effect as giving the two flags
            “SRTP AVPF”.
          + to-tag - force inclusion of the “To” tag. Normally, the “To”
            tag is always included when present, except for “delete”
            messages. Including the “To” tag in a “delete” messages allows
            you to be more selective about which dialogues within a call
            are being torn down.
          + to-tag=... - use the specified string as “To” tag instead of
            the actual “To” tag from the SIP message, and force inclusion
            of the tag in the message as per above.
          + from-tag=... - use the specified string as “From” tag instead
            of the actual “From” tag from the SIP message.
          + call-id=... - use the specified string as “Call-ID” instead of
            the actual “Call-ID” from the SIP message.
          + rtcp-mux-demux - if rtcp-mux (RFC 5761) was offered, make the
            RTP proxy accept the offer, but not offer it to the recipient
            of this message.
          + rtcp-mux-reject - if rtcp-mux was offered, make the RTP proxy
            reject the offer, but still offer it to the recipient. Can be
            combined with “rtcp-mux-offer” to always offer it.
          + rtcp-mux-offer - make the RTP proxy offer rtcp-mux to the
            recipient of this message, regardless of whether it was
            offered originally or not.
          + rtcp-mux-accept - if rtcp-mux was offered, make the RTP proxy
            accept the offer and also offer it to the recipient of this
            message. Can be combined with “rtcp-mux-offer” to always offer
            it.
          + media-address=... - force a particular media address to be
            used in the SDP body. Address family is detected
            automatically.
          + TOS=... - change the IP TOS value for all outgoing RTP packets
            within the entire call in both directions. Only honoured in an
            “offer”, ignored for an “answer”. Valid values are 0 through
            255, given in decimal. If this option is not specified, the
            TOS value will revert to the default TOS (normally 184). A
            value of -1 may be used to leave the currently used TOS
            unchanged.
          + delete-delay=... - override the default delay (in seconds)
            before a call is actually deleted from memory. Can be set to
            zero to effectuate immediate deletion. This option only makes
            sense for delete operations.
          + strict-source - instructs the RTP proxy to check the source
            addresses of all incoming RTP packets and drop the packets if
            the address doesn't match.
          + media-handover - the antithesis of strict-source. Instructs
            the RTP proxy not only to accept mismatching RTP source
            addresses (as it normally would), but also to accept them as
            the new endpoint address of the opposite media flow. Not
            recommended as it allows media streams to be hijacked by an
            attacker.
          + DTLS=... - influence the behaviour of DTLS-SRTP. Possible
            values are “no” or “off” to suppress offering or accepting
            DTLS-SRTP, and “passive” to prefer participating in DTLS-SRTP
            in a passive role.
          + SDES-off - don't offer SDES when it normally would. In an SRTP
            context, this leaves DTLS-SRTP as the only other option.
          + SDES-unencrypted_srtp, SDES-unencrypted_srtcp,
            SDES-unauthenticated_srtp - these directly reflect the SDES
            session parameters from RFC 4568 and will make the RTP proxy
            offer these parameters when offering SDES.
          + SDES-encrypted_srtp, SDES-encrypted_srtcp,
            SDES-authenticated_srtp - the opposites of the flags above.
            Useful if accepting these parameters is not desired and they
            should be rejected instead.
          + unidirectional - allows kernelization of one-way streams in
            the Sipwise rtpengine proxy. This is especially useful when
            the first call leg is handled by some rtpengine machine while
            the second call leg is handled by other rtpengine machine.
          + record-call=on - instructs RTPEngine to record the session.
            Use it in rtpengine_offer() to start recording immediately and
            save the call metadata, as alternative to start_recording().
          + metadata - a generic metadata string. The metadata will be
            used when recording calls to provide custom additional
            information. More details about this are found in the
            rtpengine README.
          + codec-transcode=... - allows codecs to be added to the list of
            offered codecs even if they were not present in the original
            list of codecs. In this case, the transcoding engine will be
            engaged. Only codecs that are supported for both decoding and
            encoding can be added in this manner. More details about this
            are found in the rtpengine README.
          + codec-strip=... - strips given codec from sdp
          + codec-offer=... - offer given codec from sdp. More details
            about this are found in the rtpengine README.
          + codec-mask=... - Similar to strip except that codecs listed
            here will still be accepted and used for transcoding on the
            offering side.Useful only in combination with codec-transcode.
            all keyword can be used to mask all offered codecs
          + T.38=decode - If the offered SDP contains a media section
            advertising T.38 over UDPTL, translate it to a regular audio
            media section over RTP. By default, PCMU and PCMA will be used
            as audio codecs, but that can be overriden using the codec
            options described above. Other transport protocols (e.g. SRTP)
            can also be selected in the same way. If the offered SDP does
            not contain a T.38 section, then this flag has no effect.
          + T.38=force - Any audio media section (over RTP) in the offered
            SDP will be translated into a T.38 section over UDPTL.
          + T.38=stop - Stops a previously established T.38 to audio
            gateway and reverts the session back to media passthrough.
            This is useful when handling a rejected T.38 offer.
       Check also the documentation of RTPEngine, these flags are
       documented there as well: https://github.com/sipwise/rtpengine.

   This function can be used from ANY_ROUTE.

   Example 1.75. rtpengine_offer usage
route {
...
    if (is_method("INVITE")) {
        if (has_body("application/sdp")) {
            if (rtpengine_offer())
                t_on_reply("1");
        } else {
            t_on_reply("2");
        }
    }
    if (is_method("ACK") && has_body("application/sdp"))
        rtpengine_answer();
...
}

onreply_route[1]
{
...
    if (has_body("application/sdp"))
        rtpengine_answer();
...
}

onreply_route[2]
{
...
    if (has_body("application/sdp"))
        rtpengine_offer();
...
}
...
if (has_body("application/sdp")) {
                if (rtpengine_offer("codec-mask=all codec-transcode=PCMU codec-t
ranscode=PCMA"))
                                t_on_reply("1");
}

...

5.3.  rtpengine_answer([flags])

   Rewrites SDP body to ensure that media is passed through an RTP proxy.
   To be invoked on 200 OK for the cases the SDP bodies are in INVITE and
   200 OK and on ACK when SDP bodies are in 200 OK and ACK.

   See rtpengine_offer() function description above for the meaning of the
   parameters.

   This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
   FAILURE_ROUTE, BRANCH_ROUTE.

   Example 1.76. rtpengine_answer usage

   See rtpengine_offer() function example above for example.

5.4.  rtpengine_info([flags])

   Send an updated offer to rtpengine. This is meant to be used when
   processing Trickle ICE SDP Fragments that are carried in SIP INFO
   messages and are proxied to endpoints that do not support ICE. With a
   matching content type, the SDP fragment is used to update rtpengine's
   list of ICE candidates. No new SDP is returned and so the SIP INFO
   message should be consumed after calling this function.

   While this function supports the same flags as “rtpengine_offer” et al,
   it is not normally necessary to provide any.

   This function can be used from ANY_ROUTE.

   Example 1.77. rtpengine_info usage
...
rtpengine_info();
...

5.5.  rtpengine_delete([flags])

   Tears down the RTP proxy session for the current call. This populates
   the statistics pseudovariables (such “mos_min_pv” etc).

   See rtpengine_offer() function description above for the meaning of the
   parameters. Note that not all flags make sense for a “delete”.

   This function can be used from ANY_ROUTE.

   Example 1.78. rtpengine_delete usage
...
rtpengine_delete();
...

5.6.  rtpengine_query([flags])

   Queries the RTP proxy about the current status and statistics of a
   running call. This populates the statistics pseudovariables (such
   “mos_min_pv” etc).

   See rtpengine_offer() function description above for the meaning of the
   parameters. Note that not all flags make sense for a “query”.

   This function can be used from ANY_ROUTE.

   Example 1.79. rtpengine_query usage
...
rtpengine_query();
...

5.7.  rtpengine_manage([flags])

   Manage the RTPEngine session - it combines the functionality of
   rtpengine_offer(), rtpengine_answer() and rtpengine_delete(), detecting
   internally based on message type and method which one to execute.

   It can take the same parameters as rtpengine_offer(). The flags
   parameter to rtpengine_manage() can be a configuration variable
   containing the flags as a string.

   Functionality:
     * If INVITE with SDP, then do rtpengine_offer()
     * If INVITE with SDP, when the tm module is loaded, mark transaction
       with internal flag FL_SDP_BODY to know that the 1xx and 2xx are for
       rtpengine_answer()
     * If ACK with SDP, then do rtpengine_answer()
     * If BYE or CANCEL, or called within a FAILURE_ROUTE[], then call
       rtpengine_delete(). Be careful with calling this function after
       resuming a suspended transaction (e.g., after t_continue()),
       because the context of executed route is FAILURE ROUTE (in other
       words, rtpengine_manage() in the route block of t_continue() does
       the same as in failure_route; use a branch route to engage
       rtpengine for a forwarded branch after resuming the transaction).
     * It does nothing if used inside event_route[tm:branch-failure:...]
     * If reply to INVITE with code >= 300 do rtpengine_delete()
     * If reply with SDP to INVITE having code 1xx and 2xx, then do
       rtpengine_answer() if the request had SDP or tm is not loaded,
       otherwise do rtpengine_offer()

   This function can be used from ANY_ROUTE.

   Example 1.80. rtpengine_manage usage
...
rtpengine_manage();
...

5.8.  start_recording([flags])

   This function will send a signal to the RTP relay to record the RTP
   stream flowing through it. See also the option “record-call=on” for
   rtpengine_manage()/rtpengine_offer(), which offers an alternative for
   call recording, saving also call metadata from SDP.

   It can take the same parameters as rtpengine_manage(). The flags
   parameter to start_recording can be a configuration variable containing
   the flags as a string. The call-id flag can be used to start recording
   for a different call.

   This function can be used from REQUEST_ROUTE and ONREPLY_ROUTE.

   Example 1.81. start_recording usage
...
start_recording();
...

5.9.  stop_recording([flags])

   This function will send a signal to the RTP relay to stop recording the
   RTP stream flowing through it. See also the option “record-call=off”
   for rtpengine_manage()/rtpengine_offer(), which offers an alternative
   for call recording.

   It can take the same parameters as rtpengine_manage(). The flags
   parameter to start_recording can be a configuration variable containing
   the flags as a string. The call-id flag can be used to stop recording
   for a different call.

   This function can be used from REQUEST_ROUTE and ONREPLY_ROUTE.

   Example 1.82. stop_recording usage
...
stop_recording();
...

5.10.  block_dtmf([flags])

   This function will instruct the RTP proxy to start blocking DTMF event
   packets (RFC 4733). DTMF events will still be processed by the RTP
   proxy, but they won't be forwarded to the receiving peer.

   The call-id flag can be used to block DTMF for a different call.

   Without any flags given, DTMF events will be blocked for the entire
   call. It's possible to block DTMF directionally only for individual
   participants. If the “directional” flag is given, DTMF events will be
   blocked for the UA with the currently matching “From” tag. Events can
   be blocked for a different UA either by specifying an alternative
   “from-tag=...”, or by matching UAs against the media address they
   advertised in the SDP using the “address=...” flag (which can contain
   either an IPv4 or IPv6 address).

   This function can be used from REQUEST_ROUTE and ONREPLY_ROUTE.

   Example 1.83. block_dtmf usage
...
block_dtmf();
block_dtmf("directional");
block_dtmf("address=192.168.42.42");
...

5.11.  unblock_dtmf([flags])

   Reverses the effects of a previously issued block_dtmf call. See above
   for a description of which flags can be used.

   If DTMF events were previously blocked for individual UAs, then
   unblocking DTMF events for the entire call (i.e. no flags given) will
   not remove these blocks. The flag “all” can be used to achieve this.

   Example 1.84. unblock_dtmf usage
...
unblock_dtmf();
unblock_dtmf("all");
...

5.12.  block_media([flags])

   Analogous to “block_dtmf”, but blocks media RTP packets instead of DTMF
   events. When media is blocked, DTMF events still pass through the RTP
   proxy.

   See “block_dtmf” for a description of the flags that can be used.

   Example 1.85. block_media usage
...
block_media();
block_media("directional");
block_media("address=192.168.42.42");
...

5.13.  unblock_media([flags])

   Analogous to “unblock_dtmf”, but applies to media RTP packets instead
   of DTMF events.

   See “unblock_dtmf” for a description of the flags that can be used.

   Example 1.86. unblock_media usage
...
unblock_media();
unblock_media("all");
...

5.14.  start_forwarding([flags])

   Controls the PCM forwarding feature of the recording daemon. Unlike the
   recording feature, PCM forwarding can be done directionally for
   individual call participants only, therefore this command takes the
   same flags as the media/DTMF blocking commands above.

   See “block_dtmf” for a description of the flags that can be used.

   Example 1.87. start_forwarding usage
...
start_forwarding();
start_forwarding("directional");
start_forwarding("address=192.168.42.42");
...

5.15.  stop_forwarding([flags])

   Analogous to “unblock_dtmf”, but controls the PCM forwarding feature
   instead of DTMF blocking.

   See “unblock_dtmf” for a description of the flags that can be used.

   Example 1.88. stop_forwarding usage
...
stop_forwarding();
stop_forwarding("all");
...

5.16.  play_media([flags])

   Instructs rtpengine to play a prerecorded announcement to the selected
   call participant, either from a local file or from a file stored in a
   database. The participant must be selected using the same flags as are
   described under the “block_dtmf” function. If none of these flags are
   given, then the “From” tag from the current SIP message context is
   used.

   If successful, the “media_duration” pseudovariable is filled in with
   the duration of the media being played, expressed in milliseconds. If
   the length of the media could not be determined, it's set to -1.

   Example 1.89. play_media usage
...
play_media("file=/use/share/media/hello.wav");
play_media("from-tag=tfugklbildfydrtuykgfv db-id=12345");
...

5.17.  stop_media([flags])

   Stops the playback of media previously started by “play_media”. Media
   playback is automatically stopped when the end of the media file is
   reached, so this function is only useful to prematurely stop playback.

   Example 1.90. stop_media usage
...
stop_media();
stop_media("from-tag=5yqaeriguhxcikxj");
...

5.18.  play_dtmf([flags])

   Injects a DTMF event into the media stream. Depending on which codecs
   were negotiated, this either injects an RFC 2833/4733 DTMF event, or an
   in-band PCM DTMF tone into the audio stream. The flag “inject DTMF”
   must have been present in both offer and answer messages when the call
   was established, which forces all audio to go through rtpengine's
   transcoding engine.

   Usage is similar to “play_media” with the following exceptions. The
   selected party is not the party that will receive the DTMF event, but
   rather the party which is generating the event. This is to support DTMF
   events that are carried in SIP INFO messages. Instead of specifying a
   media file, a DTMF event code must be specified, as well as optionally
   a duration and the volume. The “code” can be a number 0 through 15, or
   a DTMF digit (0-9, A-D, *, #). The “duration” is specified in
   milliseconds and defaults to 250, within a range of 100-5000. The
   “volume” is specified in absolute decibels, with a default of -8 db.

   Multiple consecutive DTMF events can be queued up by calling this
   function multiple times consecutively. RTPengine will play out the DTMF
   events in sequence, separated by a default pause of 100 ms. An
   alternative pause length can be given through the “pause” option,
   between 100 and 5000 ms.

   Example 1.91. play_dtmf usage
...
play_dtmf("from-tag=5yqaeriguhxcikxj code=#");
play_dtmf("code=1 volume=5 duration=300 pause=150");
...

6. Exported Pseudo Variables

   6.1. $rtpstat

6.1. $rtpstat

   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
   packet counters. The statistics must be retrieved before the session is
   deleted (before rtpengine_delete()).

   Example 1.92. $rtpstat Usage
...
    append_hf("X-RTP-Statistics: $rtpstat\r\n");
...

7. RPC Commands

   7.1. rtpengine.reload
   7.2. rtpengine.enable proxy_url/all 0/1
   7.3. rtpengine.show proxy_url/all
   7.4. rtpengine.ping proxy_url/all
   7.5. rtpengine.get_hash_total

7.1. rtpengine.reload

   Reloads the database node table content if configured. Returns specific
   message related to success, failure and no db_url configured.

   NOTE: The current behaviour updates the nodes state or creates new ones
   or hides old ones, based on the database content. If allow_op modparam
   is enabled, the sessions are still allowed to finish for the hidden old
   nodes.

   Example 1.93.  rtpengine.reload usage
...
$ kamcmd rtpengine.reload
...

7.2. rtpengine.enable proxy_url/all 0/1

   Enables a RTP proxy if the second parameter value is greater than 0.
   Disables it if a zero value is given. The first parameter is either a
   specific RTP proxy url (exactly as defined in the config file) or the
   keyword all. The second parameter value must be a number in decimal.

   When try to enable the RTP proxy, an application ping command is sent
   to it. If it fails, the proxy is not enabled. Displays success or fail
   when try to enable/disable.

   NOTE: If a RTP proxy is defined multiple times (in the same or diferent
   sets), all of its instances will be enabled/disabled.

   NOTE: If a RTP proxy is in the disabled permanent state and one tries
   to enable it, even if the ping fails, it is moved to a disabled
   temporary state and a recheck_ticks are given to it. While the
   recheck_ticks are grater than 0, the proxy is considered disabled
   temporary, and it is not taken into consideration for sending data.
   When the recheck_ticks are 0, the proxy is retested when trying to send
   data (not automatically retested), and data can be send to it on
   success.

   NOTE: If you specify an IPv6 RTP, the proxy url must be prefixed with
   :: to escape the :: from the IPv6 address. See the example below.

   Example 1.94.  rtpengine.enable usage
...
$ kamcmd rtpengine.enable udp:192.168.2.133:8081 0
$ kamcmd rtpengine.enable ::udp6:fe80::9a90:96ff:fea8:fd99:9999 1
$ kamcmd rtpengine.enable all 1
...

7.3. rtpengine.show proxy_url/all

   Displays all the RTP proxies and their information: set and status
   (disabled or not, weight and recheck_ticks). If a RTP proxy has been
   disabled by nh_enable_rtpp mi command a "(permanent)" quote will appear
   when printing the disabled status. This is to differentiate from a
   temporary disable due to the proxy being not found responsive by
   kamailio. In addition, when disabled permanent, recheck_ticks have no
   meaning and "N\A" is printed instead of the value.

   It takes either a specific RTP proxy url (exactly as defined in the
   config file) or the keyword all as a parameter.

   NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to
   escape the :: from the IPv6 address. See the example below.

   Example 1.95.  rtpengine.show usage
...
$ kamcmd rtpengine.show udp:192.168.2.133:8081
$ kamcmd rtpengine.show ::udp6:fe80::9a90:96ff:fea8:fd99:9999
$ kamcmd rtpengine.show all
...

7.4. rtpengine.ping proxy_url/all

   Sends an application ping command to the RTP proxy. If the proxy does
   not respond, it will be disabled, but not permanent. If the proxy
   responds, no action is taken. Displays the ping result, i.e. success or
   fail when try to ping.

   It takes either a specific RTP proxy url (exactly as defined in the
   config file) or the keyword all as a parameter.

   NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to
   escape the :: from the IPv6 address. See the example below.

   Example 1.96.  rtpengine.ping usage
...
$ kamcmd rtpengine.ping udp:192.168.2.133:8081
$ kamcmd rtpengine.ping ::udp6:fe80::9a90:96ff:fea8:fd99:9999
$ kamcmd rtpengine.ping all
...

7.5. rtpengine.get_hash_total

   Print the total number of hash entries in the hash table at a given
   moment.

   Example 1.97.  rtpengine.get_hash_total usage
...
$ kamcmd rtpengine.get_hash_total
...

Chapter 2. Frequently Asked Questions

   2.1. How do I migrate from “rtpproxy” or “rtpproxy-ng” to “rtpengine”?
   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.

   How do I migrate from “rtpproxy” or “rtpproxy-ng” to “rtpengine”?

   For the most part, only the names of the functions have changed, with
   “rtpproxy” in each name replaced with “rtpengine”. For example,
   “rtpproxy_manage()” has become “rtpengine_manage()”. A few name
   duplications have also been resolved, for example there is now a single
   “rtpengine_delete()” instead of “unforce_rtp_proxy()” and the identical
   “rtpproxy_destroy()”.

   The largest difference to the old module is how flags are passed to
   “rtpengine_offer()”, “rtpengine_answer()”, “rtpengine_manage()” and
   “rtpengine_delete()”. Instead of having a string of single-letter
   flags, they now take a string of space-separated items, with each item
   being either a single token (word) or a “key=value” pair.

   For example, if you had a call “rtpproxy_offer("FRWOC+PS");”, this
   would then become:
rtpengine_offer("force trust-address symmetric replace-origin replace-session-co
nnection ICE=force RTP/SAVPF");

   Finally, if you were using the second parameter (explicit media
   address) to any of these functions, this has been replaced by the
   “media-address=...” option within the first string of flags.

   2.2.

   Where can I find more about Kamailio?

   Take a look at https://www.kamailio.org/.

   2.3.

   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 -
       https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users
     * Developer Mailing List -
       https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev

   E-mails regarding any stable Kamailio release should be sent to
   <sr-users@lists.kamailio.org> and e-mails regarding development
   versions should be sent to <sr-dev@lists.kamailio.org>.

   2.4.

   How can I report a bug?

   Please follow the guidelines provided at:
   https://github.com/kamailio/kamailio/issues.
