New HD ConfBridge conferencing application.
[asterisk/asterisk.git] / configs / confbridge.conf.sample
1 [general]
2 ; The general section of this config
3 ; is not currently used, but reserved
4 ; for future use.
5
6 ;
7 ; --- Default Information ---
8 ; The default_user and default_bridge sections are applied
9 ; automatically to all ConfBridge instances invoked without
10 ; a user, or bridge argument.  No menu is applied by default.
11 ;
12
13 ; --- ConfBridge User Profile Options ---
14 [default_user]
15 type=user
16 ;admin=yes     ; Sets if the user is an admin or not. Off by default.
17 ;marked=yes    ; Sets if this is a marked user or not. Off by default.
18 ;startmuted=yes; Sets if all users should start out muted. Off by default
19 ;music_on_hold_when_empty=yes  ; Sets whether MOH should be played when only
20                                ; one person is in the conference or when the
21                                ; the user is waiting on a marked user to enter
22                                ; the conference. Off by default.
23 ;music_on_hold_class=default   ; The MOH class to use for this user.
24 ;quiet=yes     ; When enabled enter/leave prompts and user intros are not played.
25                ; There are some prompts, such as the prompt to enter a PIN number,
26                ; that must be played regardless of what this option is set to.
27                ; Off by default
28 ;announce_user_count=yes  ; Sets if the number of users should be announced to the
29                           ; caller.  Off by default.
30 ;announce_user_count_all=yes ; Sets if the number of users should be announced to
31                              ; all the other users in the conference when someone joins.
32                              ; This option can be either set to 'yes' or a number.
33                              ; When set to a number, the announcement will only occur
34                              ; once the user count is above the specified number.
35 ;announce_only_user=yes   ; Sets if the only user announcement should be played
36                           ; when a channel enters a empty conference.  On by default.
37 ;wait_marked=yes   ; Sets if the user must wait for a marked user to enter before
38                    ; joining the conference. Off by default.
39 ;end_marked=yes ; This option will kick every user with this option set in their
40                 ; user profile after the last Marked user exists the conference.
41
42 ;dsp_drop_silence=yes  ; This option drops what Asterisk detects as silence from
43                        ; entering into the bridge.  Enabling this option will drastically
44                        ; improve performance and help remove the buildup of background
45                        ; noise from the conference. Highly recommended for large conferences
46                        ; due to its performance enhancements.
47
48 ;dsp_talking_threshold=128  ; The time in milliseconds of sound above what the dsp has
49                             ; established as base line silence for a user before a user
50                             ; is considered to be talking.  This value affects several
51                             ; operations and should not be changed unless the impact on
52                             ; call quality is fully understood.
53                             ;
54                             ; What this value affects internally:
55                             ;
56                             ; 1. Audio is only mixed out of a user's incoming audio stream
57                             ;    if talking is detected.  If this value is set too
58                             ;    loose the user will hear themselves briefly each
59                             ;    time they begin talking until the dsp has time to
60                             ;    establish that they are in fact talking.
61                             ; 2. When talk detection AMI events are enabled, this value 
62                             ;    determines when talking has begun which results in
63                             ;    an AMI event to fire.  If this value is set too tight
64                             ;    AMI events may be falsely triggered by variants in
65                             ;    room noise.
66                             ; 3. The drop_silence option depends on this value to determine
67                             ;    when the user's audio should be mixed into the bridge
68                             ;    after periods of silence.  If this value is too loose
69                             ;    the beginning of a user's speech will get cut off as they
70                             ;    transition from silence to talking.
71                             ;
72                             ; By default this value is 160 ms. Valid values are 1 through 2^31
73
74 ;dsp_silence_threshold=2000 ; The time in milliseconds of sound falling within the what
75                             ; the dsp has established as baseline silence before a user
76                             ; is considered be silent.  This value affects several
77                             ; operations and should not be changed unless the impact
78                             ; on call quality is fully understood.
79                             ;
80                             ; What this value affects internally:
81                             ;
82                             ; 1. When talk detection AMI events are enabled, this value
83                             ;    determines when the user has stopped talking after a
84                             ;    period of talking.  If this value is set too low
85                             ;    AMI events indicating the user has stopped talking
86                             ;    may get falsely sent out when the user briefly pauses
87                             ;    during mid sentence.
88                             ; 2. The drop_silence option depends on this value to
89                             ;    determine when the user's audio should begin to be
90                             ;    dropped from the conference bridge after the user
91                             ;    stops talking.  If this value is set too low the user's
92                             ;    audio stream may sound choppy to the other participants.
93                             ;    This is caused by the user transitioning constantly from
94                             ;    silence to talking during mid sentence.
95                             ;
96                             ; The best way to approach this option is to set it slightly above
97                             ; the maximum amount of ms of silence a user may generate during
98                             ; natural speech.
99                             ;
100                             ; By default this value is 2500ms. Valid values are 1 through 2^31
101
102 ;talk_detection_events=yes ; This option sets whether or not notifications of when a user
103                            ; begins and ends talking should be sent out as events over AMI.
104                            ; By default this option is off.
105
106 ;denoise=yes ; Sets whether or not a denoise filter should be applied
107              ; to the audio before mixing or not.  Off by default. Requires
108              ; codec_speex to be built and installed.  Do not confuse this option
109              ; with drop_silence.  Denoise is useful if there is a lot of background
110              ; noise for a user as it attempts to remove the noise while preserving
111              ; the speech.  This option does NOT remove silence from being mixed into
112              ; the conference and does come at the cost of a slight performance hit.
113
114 ;jitterbuffer=yes  ; Enabling this option places a jitterbuffer on the user's audio stream
115                    ; before audio mixing is performed.  This is highly recommended but will
116                    ; add a slight delay to the audio.  This option is using the JITTERBUFFER
117                    ; dialplan function's default adaptive jitterbuffer.  For a more fine tuned
118                    ; jitterbuffer, disable this option and use the JITTERBUFFER dialplan function
119                    ; on the user before entering the ConfBridge application.
120
121 ;pin=1234  ; Sets if this user must enter a PIN number before entering
122            ; the conference.  The PIN will be prompted for.
123 ;announce_join_leave=yes ; When enabled, this option will prompt the user for a
124                          ; name when entering the conference.  After the name is
125                          ; recorded, it will be played as the user enters and exists
126                          ; the conference. This option is off by default.
127 ;dtmf_passthrough=yes  ; Sets whether or not DTMF should pass through the conference.
128                        ; This option is off by default.
129
130 ; --- ConfBridge Bridge Profile Options ---
131 [default_bridge]
132 type=bridge
133 ;max_members=50                ; This option limits the number of participants for a single
134                                ; conference to a specific number.  By default conferences
135                                ; have no participant limit. After the limit is reached, the
136                                ; conference will be locked until someone leaves.  Note however
137                                ; that an Admin user will always be alowed to join the conference
138                                ; regardless if this limit is reached or not.
139
140 ;record_conference=yes         ; Records the conference call starting when the first user
141                                ; enters the room, and ending when the last user exits the room.
142                                ; The default recorded filename is
143                                ; 'confbridge-<name of conference bridge>-<start time>.wav
144                                ; and the default format is 8khz slinear.  This file will be
145                                ; located in the configured monitoring directory in asterisk.conf.
146
147 ;record_file=</path/to/file>   ; When record_conference is set to yes, the specific name of the
148                                ; record file can be set using this option.  Note that since multiple
149                                ; conferences may use the same bridge profile, this may cause issues
150                                ; depending on the configuration.  It is recommended to only use this
151                                ; option dynamically with the CONFBRIDGE() dialplan function. This
152                                ; allows the record name to be specified and a unique name to be chosen.
153                                ; By default, the record_file is stored in Asterisk's spool/monitor directory
154                                ; with a unique filename starting with the 'confbridge' prefix.
155
156 ;internal_sample_rate=auto     ; Sets the internal native sample rate the
157                                ; conference is mixed at.  This is set to automatically
158                                ; adjust the sample rate to the best quality by default.
159                                ; Other values can be anything from 8000-192000.  If a
160                                ; sample rate is set that Asterisk does not support, the
161                                ; closest sample rate Asterisk does support to the one requested
162                                ; will be used.
163
164 ;mixing_interval=40     ; Sets the internal mixing interval in milliseconds for the bridge.  This
165                         ; number reflects how tight or loose the mixing will be for the conference.
166                         ; In order to improve performance a larger mixing interval such as 40ms may
167                         ; be chosen.  Using a larger mixing interval comes at the cost of introducing
168                         ; larger amounts of delay into the bridge.  Valid values here are 10, 20, 40,
169                         ; or 80.  By default 20ms is used.
170
171 ; All sounds in the conference are customizable using the bridge profile options below.
172 ; Simply state the option followed by the filename or full path of the filename after
173 ; the option.  Example: sound_had_joined=conf-hasjoin  This will play the conf-hasjoin
174 ; sound file found in the sounds directory when announcing someone's name is joining the
175 ; conference.
176
177 ;sound_join  ; The sound played to everyone when someone enters the conference.
178 ;sound_leave ; The sound played to everyone when someone leaves the conference.
179 ;sound_has_joined ; The sound played before announcing someone's name has
180                   ; joined the conference. This is used for user intros.
181                   ; Example "_____ has joined the conference"
182 ;sound_has_left ; The sound played when announcing someone's name has
183                 ; left the conference. This is used for user intros.
184                 ; Example "_____ has left the conference"
185 ;sound_kicked ; The sound played to a user who has been kicked from the conference.
186 ;sound_muted  ; The sound played when the mute option it toggled on.
187 ;sound_unmuted  ; The sound played when the mute option it toggled off.
188 ;sound_only_person ; The sound played when the user is the only person in the conference.
189 ;sound_only_one ; The sound played to a user when there is only one other
190                 ; person is in the conference.
191 ;sound_there_are  ; The sound played when announcing how many users there
192                   ; are in a conference.
193 ;sound_other_in_party; ; This file is used in conjunction with 'sound_there_are"
194                        ; when announcing how many users there are in the conference.
195                        ; The sounds are stringed together like this.
196                        ; "sound_there_are" <number of participants> "sound_other_in_party"
197 ;sound_place_into_conference ; The sound played when someone is placed into the conference
198                              ; after waiting for a marked user.
199 ;sound_wait_for_leader  ; The sound played when a user is placed into a conference that
200                         ; can not start until a marked user enters.
201 ;sound_leader_has_left  ; The sound played when the last marked user leaves the conference.
202 ;sound_get_pin ; The sound played when prompting for a conference pin number.
203 ;sound_invalid_pin ; The sound played when an invalid pin is entered too many times.
204 ;sound_locked ; The sound played to a user trying to join a locked conference.
205 ;sound_locked_now ; The sound played to an admin after toggling the conference to locked mode.
206 ;sound_unlocked_now; The sound played to an admin after toggling the conference to unlocked mode.
207 ;sound_error_menu ; The sound played when an invalid menu option is entered.
208
209 ; --- ConfBridge Menu Options ---
210 ; The ConfBridge application also has the ability to
211 ; apply custom DTMF menus to each channel using the
212 ; application.  Like the User and Bridge profiles
213 ; a menu is passed in to ConfBridge as an argument in
214 ; the dialplan.
215 ;
216 ; Below is a list of menu actions that can be assigned
217 ; to a DTMF sequence.
218 ;
219 ; A single DTMF sequence can have multiple actions associated with it. This is
220 ; accomplished by stringing the actions together and using a ',' as the delimiter.
221 ; Example:  Both listening and talking volume is reset when '5' is pressed.
222 ; 5=reset_talking_volume, reset_listening_volume
223 ;
224 ; playback(<name of audio file>&<name of audio file>)
225                                        ; Playback will play back an audio file to a channel
226                                        ; and then immediately return to the conference.
227                                        ; This file can not be interupted by DTMF.
228                                        ; Mutliple files can be chained together using the
229                                        ; '&' character.
230 ; playback_and_continue(<name of playback prompt>&<name of playback prompt>)
231                                        ; playback_and_continue will
232                                        ; play back a prompt while continuing to
233                                        ; collect the dtmf sequence.  This is useful
234                                        ; when using a menu prompt that describes all
235                                        ; the menu options.  Note however that any DTMF
236                                        ; during this action will terminate the prompts
237                                        ; playback.  Prompt files can be chained together
238                                        ; using the '&' character as a delimiter.
239 ; toggle_mute      ; Toggle turning on and off mute.  Mute will make the user silent
240                    ; to everyone else, but the user will still be able to listen in.
241                    ; continue to collect the dtmf sequence.
242 ; no_op ; This action does nothing (No Operation). Its only real purpose exists for
243         ; being able to reserve a sequence in the config as a menu exit sequence.
244 ; decrease_listening_volume ; Decreases the channel's listening volume.
245 ; increase_listening_volume ; Increases the channel's listening volume.
246 ; reset_listening_volume    ; Reset channel's listening volume to default level.
247
248 ; decrease_talking_volume ; Decreases the channel's talking volume.
249 ; increase_talking_volume ; Icreases the channel's talking volume.
250 ; reset_talking_volume    ; Reset channel's talking volume to default level.
251 ;
252 ; dialplan_exec(context,exten,priority)  ; The dialplan_exec action allows a user
253                                          ; to escape from the conference and execute
254                                          ; commands in the dialplan.  Once the dialplan
255                                          ; exits the user will be put back into the
256                                          ; conference.  The possibilities are endless!
257 ; leave_conference ; This action allows a user to exit the conference and continue
258                    ; execution in the dialplan.
259 ;
260 ; admin_kick_last  ; This action allows an Admin to kick the last participant from the
261                    ; conference. This action will only work for admins which allows
262                    ; a single menu to be used for both users and admins.
263 ;
264 ; admin_toggle_conference_lock ; This action allows an Admin to toggle locking and
265                                ; unlocking the conference.  Non admins can not use
266                                ; this action even if it is in their menu.
267
268 [sample_user_menu]
269 type=menu
270 *=playback_and_continue(conf-usermenu)
271 *1=toggle_mute
272 1=toggle_mute
273 *4=decrease_listening_volume
274 4=decrease_listening_volume
275 *6=increase_listening_volume
276 6=increase_listening_volume
277 *7=decrease_talking_volume
278 7=decrease_talking_volume
279 *8=no_op
280 8=no_op
281 *9=increase_talking_volume
282 9=increase_talking_volume
283
284 [sample_admin_menu]
285 type=menu
286 *=playback_and_continue(conf-adminmenu)
287 *1=toggle_mute
288 1=toggle_mute
289 *2=admin_toggle_conference_lock ; only applied to admin users
290 2=admin_toggle_conference_lock  ; only applied to admin users
291 *3=admin_kick_last       ; only applied to admin users
292 3=admin_kick_last        ; only applied to admin users
293 *4=decrease_listening_volume
294 4=decrease_listening_volume
295 *6=increase_listening_volume
296 6=increase_listening_volume
297 *7=decrease_talking_volume
298 7=decrease_talking_volume
299 *8=no_op
300 8=no_op
301 *9=increase_talking_volume
302 9=increase_talking_volume