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

src/modules/jsonrpcs/README

@@ -421,6 +421,8 @@ event_route[xhttp:request] {
 ...
 jsonrpc_exec('{"jsonrpc": "2.0", "method": "dispatcher.reload", "id": 1}');
 xlog("jsonrpc response code: $jsonrpl(code) - the body is: $jsonrpl(body)\n");
+jsonrpc_exec('{"jsonrpc": "2.0", "method": "corex.debug", "params": [ 2 ], "id":
+ 1}');
 ...
 
 6. JSONRPC Commands

src/modules/rtpengine/README

@@ -1036,7 +1036,7 @@ modparam("rtpengine", "media_duration", "$avp(MEDIA_DURATION)")
 
    There is no default value.
 
-   This value is filled in after invoking“rtpengine_delete”,
+   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).
 
@@ -1117,7 +1117,7 @@ modparam("rtpengine", "mos_min_roundtrip_pv", "$avp(mos_min_roundtrip)")
 
    There is no default value.
 
-   This value is filled in after invoking“rtpengine_delete”,
+   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).
 
@@ -1198,7 +1198,7 @@ modparam("rtpengine", "mos_max_roundtrip_pv", "$avp(mos_max_roundtrip)")
 
    There is no default value.
 
-   This value is filled in after invoking“rtpengine_delete”,
+   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).
 
@@ -1277,7 +1277,10 @@ modparam("rtpengine", "mos_average_samples_pv", "$avp(mos_average_samples)")
    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.
+   match the label given in this variable. You need to fill this variable
+   before invoking “rtpengine_delete”, “rtpengine_query”, or
+   “rtpengine_manage”. Variable value should match the label= flag on
+   “rtpengine_offer”, “rtpengine_answer”, or “rtpengine_manage”.
 
    There is no default value.
 
@@ -1293,7 +1296,7 @@ modparam("rtpengine", "mos_A_label_pv", "$avp(mos_A_label)")
 
    There is no default value.
 
-   This value is filled in after invoking“rtpengine_delete”,
+   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).
 
@@ -1410,7 +1413,7 @@ A)")
 
    There is no default value.
 
-   This value is filled in after invoking“rtpengine_delete”,
+   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).
 
@@ -1527,7 +1530,7 @@ A)")
 
    There is no default value.
 
-   This value is filled in after invoking“rtpengine_delete”,
+   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).
 
@@ -1643,7 +1646,10 @@ modparam("rtpengine", "mos_average_samples_A_pv", "$avp(mos_average_samples_A)")
    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.
+   match the label given in this variable. You need to fill this variable
+   before invoking “rtpengine_delete”, “rtpengine_query”, or
+   “rtpengine_manage”. Variable value should match the label= flag on
+   “rtpengine_offer”, “rtpengine_answer”, or “rtpengine_manage”.
 
    There is no default value.
 
@@ -1659,7 +1665,7 @@ modparam("rtpengine", "mos_B_label_pv", "$avp(mos_B_label)")
 
    There is no default value.
 
-   This value is filled in after invoking“rtpengine_delete”,
+   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).
 
@@ -1776,7 +1782,7 @@ B)")
 
    There is no default value.
 
-   This value is filled in after invoking“rtpengine_delete”,
+   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).
 
@@ -1893,7 +1899,7 @@ B)")
 
    There is no default value.
 
-   This value is filled in after invoking“rtpengine_delete”,
+   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).
 
@@ -2424,33 +2430,36 @@ rtpengine_offer();
             about this are found in the rtpengine README.
           + codec-except=... - same as codec-offer but preserves original
             order
-          + codec-mask=... - Similar to strip except that codecs listed
+          + 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
-          + codec-accept=... - Similar to `mask` and `consume` but doesn't
+          + codec-accept=... - similar to `mask` and `consume` but doesn't
             remove the codec from the list of offered codecs. This means
             that a codec listed under `accept` will still be offered to
             the remote peer, but if the remote peer rejects it, it will
             still be accepted towards the original offerer and then used
             for transcoding. It is a more selective version of what the
             `always transcode` flag does.
-          + codec-consume=... - Identical to mask but enables the
+          + codec-consume=... - identical to mask but enables the
             transcoding engine even if no other transcoding related
             options are given.
-          + T.38=decode - If the offered SDP contains a media section
+          + 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 overridden 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
+          + 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
+          + 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.
+          + label=... - adds a label to a current stream, that later can
+            be used to get call quality stats, see “mos_A_label_pv” and
+            “mos_B_label_pv” parameters.
        Check also the documentation of RTPEngine, these flags are
        documented there as well: https://github.com/sipwise/rtpengine.
 

src/modules/siprepo/README

@@ -48,7 +48,7 @@ Daniel-Constantin Mierla
    1.6. sr_msg_pull() usage
    1.7. sr_msg_async_pull() usage
    1.8. sr_msg_rm() usage
-   1.9. sr_msg_checkj() usage
+   1.9. sr_msg_check() usage
 
 Chapter 1. Admin Guide
 
@@ -228,7 +228,7 @@ request_route {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.9. sr_msg_checkj() usage
+   Example 1.9. sr_msg_check() usage
 ...
 request_route {
     ...

src/modules/tm/README

@@ -1275,16 +1275,17 @@ Note
 
    See also: t_set_fr(), fr_timer.
 
-   In Kamailio compatibility mode (defined by #!KAMAILIO), the value of
-   the parameter must be the name of an AVP in pseudo-variable format:
-   $avp(name). In SER compatibility mode it must be just AVP name.
+   In Kamailio compatibility mode (defined by #!KAMAILIO, which is
+   default), the value of the parameter must be the name of an AVP in
+   pseudo-variable format: $avp(name). In SER compatibility mode (defined
+   by #!SER) it must be just AVP name.
 
    Example 1.28. Set fr_timer_avp parameter
 ...
-# Kamailio mode
-modparam("tm", "fr_timer_avp", "$avp(i:708)")
-# Old SER mode
-modparam("tm", "fr_timer_avp", "i:708")
+# default Kamailio compatibility mode
+modparam("tm", "fr_timer_avp", "$avp(frtimer)")
+# old SER compatibility mode
+modparam("tm", "fr_timer_avp", "frtimer")
 ...
 
 3.28. fr_inv_timer_avp (string)
@@ -1309,15 +1310,16 @@ Note
 
    See also: t_set_fr(), fr_inv_timer.
 
-   In Kamailio compatibility mode (defined by #!KAMAILIO), the value of
-   the parameter must be the name of an AVP in pseudo-variable format:
-   $avp(name). In SER compatibility mode it must by just AVP name.
+   In Kamailio compatibility mode (defined by #!KAMAILIO, which is
+   default), the value of the parameter must be the name of an AVP in
+   pseudo-variable format: $avp(name). In SER compatibility mode (defined
+   by #!SER) it must by just AVP name.
 
    Example 1.29. Set fr_inv_timer_avp parameter
 ...
-# Kamailio mode
+# Kamailio compatibility mode
 modparam("tm", "fr_inv_timer_avp", "$avp(my_fr_inv_timer)")
-# Old SER mode
+# old SER compatibility mode
 modparam("tm", "fr_inv_timer_avp", "my_fr_inv_timer")
 ...