modules: readme files regenerated - rtp_media_server ... [skip ci]
authorKamailio Dev <kamailio.dev@kamailio.org>
Mon, 25 Feb 2019 04:31:36 +0000 (05:31 +0100)
committerKamailio Dev <kamailio.dev@kamailio.org>
Mon, 25 Feb 2019 04:31:36 +0000 (05:31 +0100)
src/modules/rtp_media_server/README

index ac8e871..3ed260c 100644 (file)
@@ -35,22 +35,22 @@ Julien Chavanton
 
         4. Functions
 
-              4.1. rms_answer ()
+              4.1. rms_answer (event_route)
               4.2. rms_hangup ()
-              4.3. rms_bridge ()
+              4.3. rms_bridge (target URI, event_route)
               4.4. rms_session_check ()
               4.5. rms_sip_request ()
-              4.6. rms_play ()
+              4.6. rms_play (file, event_route)
 
    List of Examples
 
    1.1. log_file_name example
-   1.2. usage example
-   1.3. usage example
-   1.4. usage example
-   1.5. usage example
-   1.6. usage example
-   1.7. usage example
+   1.2. rms_answer usage example
+   1.3. rms_hangup usage example
+   1.4. rms_bridge usage example
+   1.5. rms_session_check usage example
+   1.6. rms_sip_request usage example
+   1.7. rms_play usage example
 
 Chapter 1. Admin Guide
 
@@ -68,12 +68,12 @@ Chapter 1. Admin Guide
 
    4. Functions
 
-        4.1. rms_answer ()
+        4.1. rms_answer (event_route)
         4.2. rms_hangup ()
-        4.3. rms_bridge ()
+        4.3. rms_bridge (target URI, event_route)
         4.4. rms_session_check ()
         4.5. rms_sip_request ()
-        4.6. rms_play ()
+        4.6. rms_play (file, event_route)
 
 1. Overview
 
@@ -139,21 +139,21 @@ modparam("rtp_media_server", "log_file_name", "/var/log/rms/rms_ortp.log")
 
 4. Functions
 
-   4.1. rms_answer ()
+   4.1. rms_answer (event_route)
    4.2. rms_hangup ()
-   4.3. rms_bridge ()
+   4.3. rms_bridge (target URI, event_route)
    4.4. rms_session_check ()
    4.5. rms_sip_request ()
-   4.6. rms_play ()
+   4.6. rms_play (file, event_route)
 
-4.1. rms_answer ()
+4.1. rms_answer (event_route)
 
-   Create a session and a call leg and call the event_route[rms:start]
+   Create a session and a call leg and call the event_route
 
    This function can be used from REQUEST_ROUTE, REPLY_ROUTE and
    FAILURE_ROUTE.
 
-   Example 1.2. usage example
+   Example 1.2. rms_answer usage example
 ...
 event_route[rms:start] {
         xnotice("[rms:start] play ...\n");
@@ -172,7 +172,7 @@ route {
         }
         t_check_trans();
         if (is_method("INVITE") && !has_totag()) {
-                if (!rms_answer()) {
+                if (!rms_answer("rms:start")) {
                         t_reply("503", "server error");
                 }
         }
@@ -185,12 +185,12 @@ route {
 
    This function can be used from EVENT_ROUTE.
 
-   Example 1.3. usage example
+   Example 1.3. rms_hangup usage example
 ...
         rms_hangup();
 ...
 
-4.3. rms_bridge ()
+4.3. rms_bridge (target URI, event_route)
 
    Bridge the incoming call, create a second call leg using a UAC in a
    B2BUA manner, this is needed in case we want to un-bridge later, a
@@ -199,7 +199,7 @@ route {
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1.4. usage example
+   Example 1.4. rms_bridge usage example
 ...
 event_route[rms:bridged] {
         xnotice("[rms:bridged] !\n");
@@ -230,7 +230,7 @@ he in-dialog request needs to be handled by it.
    This function can be used from REQUEST_ROUTE, REPLY_ROUTE and
    FAILURE_ROUTE.
 
-   Example 1.5. usage example
+   Example 1.5. rms_session_check usage example
 ...
         if (rms_session_check()) {
                 xnotice("This session is handled by the RMS module\n");
@@ -250,14 +250,14 @@ he in-dialog request needs to be handled by it.
    This function can be used from REQUEST_ROUTE, REPLY_ROUTE and
    FAILURE_ROUTE.
 
-   Example 1.6. usage example
+   Example 1.6. rms_sip_request usage example
 ...
         if (rms_session_check()) {
                 rms_sip_request();
         }
 ...
 
-4.6. rms_play ()
+4.6. rms_play (file, event_route)
 
    Play a wav file, a resampler is automaticaly configured to resample and
    convert stereo to mono if needed.
@@ -267,7 +267,7 @@ he in-dialog request needs to be handled by it.
 
    This function can be used from EVENT_ROUTE.
 
-   Example 1.7. usage example
+   Example 1.7. rms_play usage example
 ...
         rms_play("file.wav", "event_route_name");
 ...