Browse code

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

Kamailio Dev authored on 28/07/2020 06:46:33
Showing 1 changed files
... ...
@@ -24,23 +24,27 @@ Julien Chavanton
24 24
    1. Admin Guide
25 25
 
26 26
         1. Overview
27
-        2. Dependencies
27
+        2. Quick start, how-to build on debian
28 28
 
29
-              2.1. Kamailio Modules
30
-              2.2. External Libraries or Applications
29
+              2.1. Building on Debian, Dockerfile and docker image
31 30
 
32
-        3. Parameters
31
+        3. Dependencies
33 32
 
34
-              3.1. log_file_name (string)
33
+              3.1. Kamailio Modules
34
+              3.2. External Libraries or Applications
35 35
 
36
-        4. Functions
36
+        4. Parameters
37 37
 
38
-              4.1. rms_answer (event_route)
39
-              4.2. rms_hangup ()
40
-              4.3. rms_bridge (target URI, event_route)
41
-              4.4. rms_dialog_check ()
42
-              4.5. rms_sip_request ()
43
-              4.6. rms_play (file, event_route)
38
+              4.1. log_file_name (string)
39
+
40
+        5. Functions
41
+
42
+              5.1. rms_answer (event_route)
43
+              5.2. rms_hangup ()
44
+              5.3. rms_bridge (target URI, event_route)
45
+              5.4. rms_dialog_check ()
46
+              5.5. rms_sip_request ()
47
+              5.6. rms_play (file, event_route)
44 48
 
45 49
    List of Examples
46 50
 
... ...
@@ -57,23 +61,27 @@ Chapter 1. Admin Guide
57 61
    Table of Contents
58 62
 
59 63
    1. Overview
60
-   2. Dependencies
64
+   2. Quick start, how-to build on debian
65
+
66
+        2.1. Building on Debian, Dockerfile and docker image
67
+
68
+   3. Dependencies
61 69
 
62
-        2.1. Kamailio Modules
63
-        2.2. External Libraries or Applications
70
+        3.1. Kamailio Modules
71
+        3.2. External Libraries or Applications
64 72
 
65
-   3. Parameters
73
+   4. Parameters
66 74
 
67
-        3.1. log_file_name (string)
75
+        4.1. log_file_name (string)
68 76
 
69
-   4. Functions
77
+   5. Functions
70 78
 
71
-        4.1. rms_answer (event_route)
72
-        4.2. rms_hangup ()
73
-        4.3. rms_bridge (target URI, event_route)
74
-        4.4. rms_dialog_check ()
75
-        4.5. rms_sip_request ()
76
-        4.6. rms_play (file, event_route)
79
+        5.1. rms_answer (event_route)
80
+        5.2. rms_hangup ()
81
+        5.3. rms_bridge (target URI, event_route)
82
+        5.4. rms_dialog_check ()
83
+        5.5. rms_sip_request ()
84
+        5.6. rms_play (file, event_route)
77 85
 
78 86
 1. Overview
79 87
 
... ...
@@ -92,18 +100,29 @@ Chapter 1. Admin Guide
92 100
    mediastreamer2 is also providing a framework to create custom
93 101
    mediaprocessing modules.
94 102
 
95
-2. Dependencies
103
+2. Quick start, how-to build on debian
104
+
105
+   2.1. Building on Debian, Dockerfile and docker image
106
+
107
+2.1. Building on Debian, Dockerfile and docker image
108
+
109
+   The module includes Dockerfile that can also be use as a reference on
110
+   how to build everything from source on Debian, the of libmediastreamer
111
+   on Linux is usually outdated. A docker image is also available from
112
+   dockerhub https://hub.docker.com/r/jchavanton/rtp_media_server
113
+
114
+3. Dependencies
96 115
 
97
-   2.1. Kamailio Modules
98
-   2.2. External Libraries or Applications
116
+   3.1. Kamailio Modules
117
+   3.2. External Libraries or Applications
99 118
 
100
-2.1. Kamailio Modules
119
+3.1. Kamailio Modules
101 120
 
102 121
    The module depends on the following modules (in the other words the
103 122
    listed modules must be loaded before this module):
104 123
      * tm - accounting module
105 124
 
106
-2.2. External Libraries or Applications
125
+3.2. External Libraries or Applications
107 126
 
108 127
    The following libraries or applications must be installed before
109 128
    running Kamailio with this module loaded:
... ...
@@ -121,11 +140,11 @@ Chapter 1. Admin Guide
121 140
        fork of the defunct project CUnit, with several fixes and patches
122 141
        applied. CUnit is a Unit testing framework for C.
123 142
 
124
-3. Parameters
143
+4. Parameters
125 144
 
126
-   3.1. log_file_name (string)
145
+   4.1. log_file_name (string)
127 146
 
128
-3.1. log_file_name (string)
147
+4.1. log_file_name (string)
129 148
 
130 149
    oRTP and MediaStreamer2 log file settings the log mask is not
131 150
    configurable : MESSAGE | WARNING | ERROR | FATAL levels are activated.
... ...
@@ -137,16 +156,16 @@ Chapter 1. Admin Guide
137 156
 modparam("rtp_media_server", "log_file_name", "/var/log/rms/rms_ortp.log")
138 157
 ...
139 158
 
140
-4. Functions
159
+5. Functions
141 160
 
142
-   4.1. rms_answer (event_route)
143
-   4.2. rms_hangup ()
144
-   4.3. rms_bridge (target URI, event_route)
145
-   4.4. rms_dialog_check ()
146
-   4.5. rms_sip_request ()
147
-   4.6. rms_play (file, event_route)
161
+   5.1. rms_answer (event_route)
162
+   5.2. rms_hangup ()
163
+   5.3. rms_bridge (target URI, event_route)
164
+   5.4. rms_dialog_check ()
165
+   5.5. rms_sip_request ()
166
+   5.6. rms_play (file, event_route)
148 167
 
149
-4.1. rms_answer (event_route)
168
+5.1. rms_answer (event_route)
150 169
 
151 170
    Create a call leg : with a SIP dialog and an RTP session call the
152 171
    event_route
... ...
@@ -180,7 +199,7 @@ route {
180 199
         rms_sip_request();
181 200
 ...
182 201
 
183
-4.2. rms_hangup ()
202
+5.2. rms_hangup ()
184 203
 
185 204
    Send a BYE, delete the RTP session and the media ressources.
186 205
 
... ...
@@ -191,7 +210,7 @@ route {
191 210
         rms_hangup();
192 211
 ...
193 212
 
194
-4.3. rms_bridge (target URI, event_route)
213
+5.3. rms_bridge (target URI, event_route)
195 214
 
196 215
    Bridge the incoming call, create a second call leg using a UAC in a
197 216
    B2BUA manner, this is needed in case we want to un-bridge later, a
... ...
@@ -223,7 +242,7 @@ e in-dialog request needs to be handled by it.
223 242
                 rms_sip_request();
224 243
 ...
225 244
 
226
-4.4. rms_dialog_check ()
245
+5.4. rms_dialog_check ()
227 246
 
228 247
    Returns true if the current SIP message it handled/known by the RMS
229 248
    module, else it may be handle in any other way by Kamailio.
... ...
@@ -239,7 +258,7 @@ e in-dialog request needs to be handled by it.
239 258
         }
240 259
 ...
241 260
 
242
-4.5. rms_sip_request ()
261
+5.5. rms_sip_request ()
243 262
 
244 263
    This should be called for every in-dialog SIP request, it will be
245 264
    forwarded behaving as a B2BUA, the transaction will be suspended until
... ...
@@ -258,7 +277,7 @@ e in-dialog request needs to be handled by it.
258 277
         }
259 278
 ...
260 279
 
261
-4.6. rms_play (file, event_route)
280
+5.6. rms_play (file, event_route)
262 281
 
263 282
    Play a wav file, a resampler is automaticaly configured to resample and
264 283
    convert stereo to mono if needed.