Browse Source

modules/mediaproxy: README fix and edits

- AVPs are available in Kamailio reply routes without setting any tm param.
Juha Heinanen 12 years ago
parent
commit
f1449adfb9
2 changed files with 24 additions and 31 deletions
  1. 15 18
      modules/mediaproxy/README
  2. 9 13
      modules/mediaproxy/doc/mediaproxy_admin.xml

+ 15 - 18
modules/mediaproxy/README

@@ -10,7 +10,7 @@ Dan Pascu
 
 
    <[email protected]>
    <[email protected]>
 
 
-   Copyright © 2004 Dan Pascu
+   Copyright © 2004 Dan Pascu
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -178,7 +178,7 @@ Chapter 1. Admin Guide
    mediaproxy is disabled, calls to its functions will have no effect,
    mediaproxy is disabled, calls to its functions will have no effect,
    allowing you to use the same configuration without changes.
    allowing you to use the same configuration without changes.
 
 
-   Default value is "0".
+   Default value is “0�.
 
 
    Example 1.1. Setting the disable parameter
    Example 1.1. Setting the disable parameter
 ...
 ...
@@ -190,7 +190,7 @@ modparam("mediaproxy", "disable", 1)
    It is the path to the filesystem socket where the mediaproxy dispatcher
    It is the path to the filesystem socket where the mediaproxy dispatcher
    listens for commands from the module.
    listens for commands from the module.
 
 
-   Default value is "/var/run/mediaproxy/dispatcher.sock".
+   Default value is “/var/run/mediaproxy/dispatcher.sock�.
 
 
    Example 1.2. Setting the mediaproxy_socket parameter
    Example 1.2. Setting the mediaproxy_socket parameter
 ...
 ...
@@ -203,7 +203,7 @@ modparam("mediaproxy", "mediaproxy_socket", "/var/run/mediaproxy/dispatcher.sock
    How much time (in milliseconds) to wait for an answer from the
    How much time (in milliseconds) to wait for an answer from the
    mediaproxy dispatcher.
    mediaproxy dispatcher.
 
 
-   Default value is "500".
+   Default value is “500�.
 
 
    Example 1.3. Setting the mediaproxy_timeout parameter
    Example 1.3. Setting the mediaproxy_timeout parameter
 ...
 ...
@@ -225,11 +225,11 @@ modparam("mediaproxy", "mediaproxy_timeout", 500)
    to get the correct NAT IP address from where the SIP signaling
    to get the correct NAT IP address from where the SIP signaling
    originated.
    originated.
 
 
-   Default value is "$avp(s:signaling_ip)".
+   Default value is “$avp(signaling_ip)�.
 
 
    Example 1.4. Setting the signaling_ip_avp parameter
    Example 1.4. Setting the signaling_ip_avp parameter
 ...
 ...
-modparam("mediaproxy", "signaling_ip_avp", "$avp(s:nat_ip)")
+modparam("mediaproxy", "signaling_ip_avp", "$avp(nat_ip)")
 ...
 ...
 
 
 5.5. media_relay_avp (string)
 5.5. media_relay_avp (string)
@@ -240,11 +240,11 @@ modparam("mediaproxy", "signaling_ip_avp", "$avp(s:nat_ip)")
    before calling use_media_proxy(), it will be preferred by the
    before calling use_media_proxy(), it will be preferred by the
    dispatcher over the normal selection algorithm.
    dispatcher over the normal selection algorithm.
 
 
-   Default value is "$avp(s:media_relay)".
+   Default value is “$avp(media_relay)�.
 
 
    Example 1.5. Setting the media_relay_avp parameter
    Example 1.5. Setting the media_relay_avp parameter
 ...
 ...
-modparam("mediaproxy", "media_relay_avp", "$avp(s:media_relay)")
+modparam("mediaproxy", "media_relay_avp", "$avp(media_relay)")
 ...
 ...
 
 
 5.6. ice_candidate (string)
 5.6. ice_candidate (string)
@@ -255,7 +255,7 @@ modparam("mediaproxy", "media_relay_avp", "$avp(s:media_relay)")
    selected then a low priority candidate will be added and if
    selected then a low priority candidate will be added and if
    'high-priority' is selected a high priority one.
    'high-priority' is selected a high priority one.
 
 
-   Default value is "none".
+   Default value is “none�.
 
 
    Example 1.6. Setting the ice_candidate parameter
    Example 1.6. Setting the ice_candidate parameter
 ...
 ...
@@ -266,17 +266,14 @@ modparam("mediaproxy", "ice_candidate", "low-priority")
 
 
    Specification of the AVP which holds the ICE candidate that will be
    Specification of the AVP which holds the ICE candidate that will be
    inserted in the SDP. The value specified in this AVP will override the
    inserted in the SDP. The value specified in this AVP will override the
-   value in ice_candidate module parameter. Note that if use_media_proxy()
-   and end_media_session() functions are being used, the AVP will not be
-   available in the reply route unless you set onreply_avp_mode from the
-   tm module to '1', and if the AVP is not set, the default value will be
-   used.
+   value in ice_candidate module parameter. If the AVP is not set, the
+   default value will be used.
 
 
-   Default value is "$avp(s:ice_candidate)".
+   Default value is “$avp(ice_candidate)�.
 
 
    Example 1.7. Setting the ice_candidate_avp parameter
    Example 1.7. Setting the ice_candidate_avp parameter
 ...
 ...
-modparam("mediaproxy", "ice_candidate_avp", "$avp(s:ice_candidate)")
+modparam("mediaproxy", "ice_candidate_avp", "$avp(ice_candidate)")
 ...
 ...
 
 
 6. Functions
 6. Functions
@@ -315,7 +312,7 @@ modparam("mediaproxy", "ice_candidate_avp", "$avp(s:ice_candidate)")
 ...
 ...
 if (method==INVITE && !has_totag()) {
 if (method==INVITE && !has_totag()) {
     # We can also use a specific media relay if we need to
     # We can also use a specific media relay if we need to
-    #$avp(s:media_relay) = "1.2.3.4";
+    #$avp(media_relay) = "1.2.3.4";
     engage_media_proxy();
     engage_media_proxy();
 }
 }
 ...
 ...
@@ -344,7 +341,7 @@ if (method==INVITE && !has_totag()) {
 ...
 ...
 if (method==INVITE) {
 if (method==INVITE) {
     # We can also use a specific media relay if we need to
     # We can also use a specific media relay if we need to
-    #$avp(s:media_relay) = "1.2.3.4";
+    #$avp(media_relay) = "1.2.3.4";
     use_media_proxy();
     use_media_proxy();
 }
 }
 ...
 ...

+ 9 - 13
modules/mediaproxy/doc/mediaproxy_admin.xml

@@ -241,7 +241,7 @@ modparam("mediaproxy", "mediaproxy_timeout", 500)
 
 
       <para>
       <para>
         <emphasis>
         <emphasis>
-          Default value is <quote>$avp(s:signaling_ip)</quote>.
+          Default value is <quote>$avp(signaling_ip)</quote>.
         </emphasis>
         </emphasis>
       </para>
       </para>
 
 
@@ -249,7 +249,7 @@ modparam("mediaproxy", "mediaproxy_timeout", 500)
       <title>Setting the <varname>signaling_ip_avp</varname> parameter</title>
       <title>Setting the <varname>signaling_ip_avp</varname> parameter</title>
         <programlisting format="linespecific">
         <programlisting format="linespecific">
 ...
 ...
-modparam("mediaproxy", "signaling_ip_avp", "$avp(s:nat_ip)")
+modparam("mediaproxy", "signaling_ip_avp", "$avp(nat_ip)")
 ...
 ...
         </programlisting>
         </programlisting>
       </example>
       </example>
@@ -268,7 +268,7 @@ modparam("mediaproxy", "signaling_ip_avp", "$avp(s:nat_ip)")
 
 
       <para>
       <para>
         <emphasis>
         <emphasis>
-          Default value is <quote>$avp(s:media_relay)</quote>.
+          Default value is <quote>$avp(media_relay)</quote>.
         </emphasis>
         </emphasis>
       </para>
       </para>
 
 
@@ -276,7 +276,7 @@ modparam("mediaproxy", "signaling_ip_avp", "$avp(s:nat_ip)")
       <title>Setting the <varname>media_relay_avp</varname> parameter</title>
       <title>Setting the <varname>media_relay_avp</varname> parameter</title>
         <programlisting format="linespecific">
         <programlisting format="linespecific">
 ...
 ...
-modparam("mediaproxy", "media_relay_avp", "$avp(s:media_relay)")
+modparam("mediaproxy", "media_relay_avp", "$avp(media_relay)")
 ...
 ...
         </programlisting>
         </programlisting>
       </example>
       </example>
@@ -313,17 +313,13 @@ modparam("mediaproxy", "ice_candidate", "low-priority")
       <para>
       <para>
         Specification of the AVP which holds the ICE candidate that will be 
         Specification of the AVP which holds the ICE candidate that will be 
         inserted in the SDP. The value specified in this AVP will override 
         inserted in the SDP. The value specified in this AVP will override 
-        the value in ice_candidate module parameter.
-
-        Note that if use_media_proxy() and end_media_session() functions are
-        being used, the AVP will not be available in the reply route unless 
-        you set onreply_avp_mode from the tm module to '1', and if the AVP 
+        the value in ice_candidate module parameter.  If the AVP
         is not set, the default value will be used.
         is not set, the default value will be used.
       </para>
       </para>
 
 
       <para>
       <para>
         <emphasis>
         <emphasis>
-          Default value is <quote>$avp(s:ice_candidate)</quote>.
+          Default value is <quote>$avp(ice_candidate)</quote>.
         </emphasis>
         </emphasis>
       </para>
       </para>
 
 
@@ -331,7 +327,7 @@ modparam("mediaproxy", "ice_candidate", "low-priority")
       <title>Setting the <varname>ice_candidate_avp</varname> parameter</title>
       <title>Setting the <varname>ice_candidate_avp</varname> parameter</title>
         <programlisting format="linespecific">
         <programlisting format="linespecific">
 ...
 ...
-modparam("mediaproxy", "ice_candidate_avp", "$avp(s:ice_candidate)")
+modparam("mediaproxy", "ice_candidate_avp", "$avp(ice_candidate)")
 ...
 ...
         </programlisting>
         </programlisting>
       </example>
       </example>
@@ -381,7 +377,7 @@ modparam("mediaproxy", "ice_candidate_avp", "$avp(s:ice_candidate)")
 ...
 ...
 if (method==INVITE &amp;&amp; !has_totag()) {
 if (method==INVITE &amp;&amp; !has_totag()) {
     # We can also use a specific media relay if we need to
     # We can also use a specific media relay if we need to
-    #$avp(s:media_relay) = "1.2.3.4";
+    #$avp(media_relay) = "1.2.3.4";
     engage_media_proxy();
     engage_media_proxy();
 }
 }
 ...
 ...
@@ -430,7 +426,7 @@ if (method==INVITE &amp;&amp; !has_totag()) {
 ...
 ...
 if (method==INVITE) {
 if (method==INVITE) {
     # We can also use a specific media relay if we need to
     # We can also use a specific media relay if we need to
-    #$avp(s:media_relay) = "1.2.3.4";
+    #$avp(media_relay) = "1.2.3.4";
     use_media_proxy();
     use_media_proxy();
 }
 }
 ...
 ...