Browse code

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

Kamailio Dev authored on 25/02/2019 04:31:36
Showing 1 changed files
... ...
@@ -35,22 +35,22 @@ Julien Chavanton
35 35
 
36 36
         4. Functions
37 37
 
38
-              4.1. rms_answer ()
38
+              4.1. rms_answer (event_route)
39 39
               4.2. rms_hangup ()
40
-              4.3. rms_bridge ()
40
+              4.3. rms_bridge (target URI, event_route)
41 41
               4.4. rms_session_check ()
42 42
               4.5. rms_sip_request ()
43
-              4.6. rms_play ()
43
+              4.6. rms_play (file, event_route)
44 44
 
45 45
    List of Examples
46 46
 
47 47
    1.1. log_file_name example
48
-   1.2. usage example
49
-   1.3. usage example
50
-   1.4. usage example
51
-   1.5. usage example
52
-   1.6. usage example
53
-   1.7. usage example
48
+   1.2. rms_answer usage example
49
+   1.3. rms_hangup usage example
50
+   1.4. rms_bridge usage example
51
+   1.5. rms_session_check usage example
52
+   1.6. rms_sip_request usage example
53
+   1.7. rms_play usage example
54 54
 
55 55
 Chapter 1. Admin Guide
56 56
 
... ...
@@ -68,12 +68,12 @@ Chapter 1. Admin Guide
68 68
 
69 69
    4. Functions
70 70
 
71
-        4.1. rms_answer ()
71
+        4.1. rms_answer (event_route)
72 72
         4.2. rms_hangup ()
73
-        4.3. rms_bridge ()
73
+        4.3. rms_bridge (target URI, event_route)
74 74
         4.4. rms_session_check ()
75 75
         4.5. rms_sip_request ()
76
-        4.6. rms_play ()
76
+        4.6. rms_play (file, event_route)
77 77
 
78 78
 1. Overview
79 79
 
... ...
@@ -139,21 +139,21 @@ modparam("rtp_media_server", "log_file_name", "/var/log/rms/rms_ortp.log")
139 139
 
140 140
 4. Functions
141 141
 
142
-   4.1. rms_answer ()
142
+   4.1. rms_answer (event_route)
143 143
    4.2. rms_hangup ()
144
-   4.3. rms_bridge ()
144
+   4.3. rms_bridge (target URI, event_route)
145 145
    4.4. rms_session_check ()
146 146
    4.5. rms_sip_request ()
147
-   4.6. rms_play ()
147
+   4.6. rms_play (file, event_route)
148 148
 
149
-4.1. rms_answer ()
149
+4.1. rms_answer (event_route)
150 150
 
151
-   Create a session and a call leg and call the event_route[rms:start]
151
+   Create a session and a call leg and call the event_route
152 152
 
153 153
    This function can be used from REQUEST_ROUTE, REPLY_ROUTE and
154 154
    FAILURE_ROUTE.
155 155
 
156
-   Example 1.2. usage example
156
+   Example 1.2. rms_answer usage example
157 157
 ...
158 158
 event_route[rms:start] {
159 159
         xnotice("[rms:start] play ...\n");
... ...
@@ -172,7 +172,7 @@ route {
172 172
         }
173 173
         t_check_trans();
174 174
         if (is_method("INVITE") && !has_totag()) {
175
-                if (!rms_answer()) {
175
+                if (!rms_answer("rms:start")) {
176 176
                         t_reply("503", "server error");
177 177
                 }
178 178
         }
... ...
@@ -185,12 +185,12 @@ route {
185 185
 
186 186
    This function can be used from EVENT_ROUTE.
187 187
 
188
-   Example 1.3. usage example
188
+   Example 1.3. rms_hangup usage example
189 189
 ...
190 190
         rms_hangup();
191 191
 ...
192 192
 
193
-4.3. rms_bridge ()
193
+4.3. rms_bridge (target URI, event_route)
194 194
 
195 195
    Bridge the incoming call, create a second call leg using a UAC in a
196 196
    B2BUA manner, this is needed in case we want to un-bridge later, a
... ...
@@ -199,7 +199,7 @@ route {
199 199
 
200 200
    This function can be used from REQUEST_ROUTE.
201 201
 
202
-   Example 1.4. usage example
202
+   Example 1.4. rms_bridge usage example
203 203
 ...
204 204
 event_route[rms:bridged] {
205 205
         xnotice("[rms:bridged] !\n");
... ...
@@ -230,7 +230,7 @@ he in-dialog request needs to be handled by it.
230 230
    This function can be used from REQUEST_ROUTE, REPLY_ROUTE and
231 231
    FAILURE_ROUTE.
232 232
 
233
-   Example 1.5. usage example
233
+   Example 1.5. rms_session_check usage example
234 234
 ...
235 235
         if (rms_session_check()) {
236 236
                 xnotice("This session is handled by the RMS module\n");
... ...
@@ -250,14 +250,14 @@ he in-dialog request needs to be handled by it.
250 250
    This function can be used from REQUEST_ROUTE, REPLY_ROUTE and
251 251
    FAILURE_ROUTE.
252 252
 
253
-   Example 1.6. usage example
253
+   Example 1.6. rms_sip_request usage example
254 254
 ...
255 255
         if (rms_session_check()) {
256 256
                 rms_sip_request();
257 257
         }
258 258
 ...
259 259
 
260
-4.6. rms_play ()
260
+4.6. rms_play (file, event_route)
261 261
 
262 262
    Play a wav file, a resampler is automaticaly configured to resample and
263 263
    convert stereo to mono if needed.
... ...
@@ -267,7 +267,7 @@ he in-dialog request needs to be handled by it.
267 267
 
268 268
    This function can be used from EVENT_ROUTE.
269 269
 
270
-   Example 1.7. usage example
270
+   Example 1.7. rms_play usage example
271 271
 ...
272 272
         rms_play("file.wav", "event_route_name");
273 273
 ...