Browse code

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

Kamailio Dev authored on 22/02/2019 23:01:34
Showing 1 changed files
... ...
@@ -16,7 +16,7 @@ Julien Chavanton
16 16
    flowroute.com
17 17
    <jchavanton@gmail.com>
18 18
 
19
-   Copyright © 2017-2018 Flowroute.com
19
+   Copyright © 2017-2019 Flowroute.com
20 20
      __________________________________________________________________
21 21
 
22 22
    Table of Contents
... ...
@@ -37,9 +37,10 @@ Julien Chavanton
37 37
 
38 38
               4.1. rms_answer ()
39 39
               4.2. rms_hangup ()
40
-              4.3. rms_session_check ()
41
-              4.4. rms_sip_request ()
42
-              4.5. rms_play ()
40
+              4.3. rms_bridge ()
41
+              4.4. rms_session_check ()
42
+              4.5. rms_sip_request ()
43
+              4.6. rms_play ()
43 44
 
44 45
    List of Examples
45 46
 
... ...
@@ -49,6 +50,7 @@ Julien Chavanton
49 50
    1.4. usage example
50 51
    1.5. usage example
51 52
    1.6. usage example
53
+   1.7. usage example
52 54
 
53 55
 Chapter 1. Admin Guide
54 56
 
... ...
@@ -68,9 +70,10 @@ Chapter 1. Admin Guide
68 70
 
69 71
         4.1. rms_answer ()
70 72
         4.2. rms_hangup ()
71
-        4.3. rms_session_check ()
72
-        4.4. rms_sip_request ()
73
-        4.5. rms_play ()
73
+        4.3. rms_bridge ()
74
+        4.4. rms_session_check ()
75
+        4.5. rms_sip_request ()
76
+        4.6. rms_play ()
74 77
 
75 78
 1. Overview
76 79
 
... ...
@@ -138,14 +141,14 @@ modparam("rtp_media_server", "log_file_name", "/var/log/rms/rms_ortp.log")
138 141
 
139 142
    4.1. rms_answer ()
140 143
    4.2. rms_hangup ()
141
-   4.3. rms_session_check ()
142
-   4.4. rms_sip_request ()
143
-   4.5. rms_play ()
144
+   4.3. rms_bridge ()
145
+   4.4. rms_session_check ()
146
+   4.5. rms_sip_request ()
147
+   4.6. rms_play ()
144 148
 
145 149
 4.1. rms_answer ()
146 150
 
147 151
    Create a session and a call leg and call the event_route[rms:start]
148
-   config example
149 152
 
150 153
    This function can be used from REQUEST_ROUTE, REPLY_ROUTE and
151 154
    FAILURE_ROUTE.
... ...
@@ -187,7 +190,39 @@ route {
187 190
         rms_hangup();
188 191
 ...
189 192
 
190
-4.3. rms_session_check ()
193
+4.3. rms_bridge ()
194
+
195
+   Bridge the incoming call, create a second call leg using a UAC in a
196
+   B2BUA manner, this is needed in case we want to un-bridge later, a
197
+   feature not currently implemented Call the specified event_route,
198
+   defaulting to [rms:bridge].
199
+
200
+   This function can be used from REQUEST_ROUTE.
201
+
202
+   Example 1.4. usage example
203
+...
204
+event_route[rms:bridged] {
205
+        xnotice("[rms:bridged] !\n");
206
+};
207
+
208
+route {
209
+        if (t_precheck_trans()) {
210
+                t_check_trans();
211
+                exit;
212
+        }
213
+        t_check_trans();
214
+        if (is_method("INVITE") && !has_totag()) {
215
+                $var(target) = "sip:" + $rU + "@mydomain.com:5060;";
216
+                if (!rms_bridge("$var(target)", "rms:bridged")) {
217
+                        t_reply("503", "server error");
218
+                }
219
+        }
220
+        if(rms_session_check()) // If the dialog is managed by the RMS module, t
221
+he in-dialog request needs to be handled by it.
222
+                rms_sip_request();
223
+...
224
+
225
+4.4. rms_session_check ()
191 226
 
192 227
    Returns true if the current SIP message it handled/known by the RMS
193 228
    module, else it may be handle in any other way by Kamailio.
... ...
@@ -195,7 +230,7 @@ route {
195 230
    This function can be used from REQUEST_ROUTE, REPLY_ROUTE and
196 231
    FAILURE_ROUTE.
197 232
 
198
-   Example 1.4. usage example
233
+   Example 1.5. usage example
199 234
 ...
200 235
         if (rms_session_check()) {
201 236
                 xnotice("This session is handled by the RMS module\n");
... ...
@@ -203,7 +238,7 @@ route {
203 238
         }
204 239
 ...
205 240
 
206
-4.4. rms_sip_request ()
241
+4.5. rms_sip_request ()
207 242
 
208 243
    This should be called for every in-dialog SIP request, it will be
209 244
    forwarded behaving as a B2BUA, the transaction will be suspended until
... ...
@@ -215,14 +250,14 @@ route {
215 250
    This function can be used from REQUEST_ROUTE, REPLY_ROUTE and
216 251
    FAILURE_ROUTE.
217 252
 
218
-   Example 1.5. usage example
253
+   Example 1.6. usage example
219 254
 ...
220 255
         if (rms_session_check()) {
221 256
                 rms_sip_request();
222 257
         }
223 258
 ...
224 259
 
225
-4.5. rms_play ()
260
+4.6. rms_play ()
226 261
 
227 262
    Play a wav file, a resampler is automaticaly configured to resample and
228 263
    convert stereo to mono if needed.
... ...
@@ -232,7 +267,7 @@ route {
232 267
 
233 268
    This function can be used from EVENT_ROUTE.
234 269
 
235
-   Example 1.6. usage example
270
+   Example 1.7. usage example
236 271
 ...
237 272
         rms_play("file.wav", "event_route_name");
238 273
 ...