Browse code

updated doc

git-svn-id: http://svn.berlios.de/svnroot/repos/sems/trunk@258 8eb893ce-cfd4-0310-b710-fb5ebe64c474

Stefan Sayer authored on 05/03/2007 16:31:26
Showing 3 changed files
... ...
@@ -12,9 +12,15 @@ Introduction:
12 12
  Each module or plug-in extends your system. Audio
13 13
  plug-ins enable new codecs and file format whereby 
14 14
  application plug-ins implement the service's logic.
15
+ Some modules called component modules provide 
16
+ functionality for other modules to use.
15 17
 
16 18
  You can easely extend Sems by creating your own plug-ins.
17 19
 
20
+ Applications can be written using the Sems framework API 
21
+ in C++, or in Python using an embedded python interpreter 
22
+ of the ivr or py_sems plugins.
23
+
18 24
  The following default applications are shipped with Sems :
19 25
 
20 26
  * voicemail: records voice messages and mails them as email
... ...
@@ -33,15 +39,14 @@ Introduction:
33 39
 		    connecting the callee in b2bua mode
34 40
 
35 41
  * announce_transfer: pre-call-announcement, plays an announcement 
36
-            and then transfers the caller
37
-            to the callee using REFER
42
+            and then transfers the caller to the callee using REFER
38 43
 
39 44
  * early_announce: pre-call announcement using early media (183)
40 45
 
41 46
  * conf_auth: collect a PIN number, verify it against an 
42 47
               XMLRPC authentication server and connect in b2bua mode
43 48
 
44
- * announce_auth: authenticated announcement
49
+ * pin_collect: collect a PIN, optionally verify it, and transfer the call
45 50
 
46 51
  Sems only support patent free codecs. Which means that we won't support codecs
47 52
  like g729. On the other hand, we have support for all important patent free
... ...
@@ -133,8 +138,7 @@ Bug report & Contact:
133 138
 
134 139
 Authors:
135 140
 
136
-  Raphael Coeffic (rco@iptel.org), 
137
-  Ulrich Abend (ullstar@iptel.org) &
141
+  Raphael Coeffic (rco@iptel.org),
138 142
   Stefan Sayer (stefan.sayer@iptego.de)
139 143
 
140 144
   and all contributors.
... ...
@@ -2,3 +2,10 @@ default_announce=/usr/local/lib/sems/audio/conference/first_participant.wav
2 2
 join_sound=/usr/local/lib/sems/audio/conference/beep.wav
3 3
 drop_sound=/usr/local/lib/sems/audio/conference/beep.wav
4 4
 dialout_suffix=@iptel.org
5
+
6
+# playout_type : select playout mechanism
7
+#  adaptive_playout : Adaptive Playout buffer (default, recommended)
8
+#  adaptive_jb      : Adaptive Jitter buffer
9
+#  simple           : simple (fifo) playout buffer
10
+#  
11
+playout_type=adaptive_playout
5 12
\ No newline at end of file
... ...
@@ -42,6 +42,15 @@ drop_sound: sound to be played to all the participants
42 42
 dialout_suffix: suffix to be append to the numbered entered by
43 43
                 the user. Example: @iptel.org
44 44
 
45
+playout_type:  adaptive_playout, adaptive_jb, or simple:
46
+   		select playout mechanism. 
47
+                adaptive_playout : Adaptive Playout buffer 
48
+                  (default, recommended)
49
+                adaptive_jb      : Adaptive Jitter buffer
50
+                simple           : simple (fifo) playout buffer
51
+	      See sems core documentation for an explanation of the 
52
+              methods.
53
+
45 54
 Adding participants with "Transfer" REFER:
46 55
 ------------------------------------------
47 56
  The "Transfer REFER" is a proprietary REFER call flow which transfers a