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