config: Allow ConfBridge DTMF menus to have '#' as the first digit.
[asterisk/asterisk.git] / configs / confbridge.conf.sample
index 1781b88..94739a6 100644 (file)
@@ -9,6 +9,10 @@
 ; automatically to all ConfBridge instances invoked without
 ; a user, or bridge argument.  No menu is applied by default.
 ;
+; Note that while properties of the default_user or default_bridge
+; profile can be overridden, if removed, they will be automatically
+; added and made available to the dialplan upon module load.
+;
 
 ; --- ConfBridge User Profile Options ---
 [default_user]
@@ -58,7 +62,7 @@ type=user
                             ;    loose the user will hear themselves briefly each
                             ;    time they begin talking until the dsp has time to
                             ;    establish that they are in fact talking.
-                            ; 2. When talk detection AMI events are enabled, this value 
+                            ; 2. When talk detection AMI events are enabled, this value
                             ;    determines when talking has begun which results in
                             ;    an AMI event to fire.  If this value is set too tight
                             ;    AMI events may be falsely triggered by variants in
@@ -105,7 +109,7 @@ type=user
 
 ;denoise=yes ; Sets whether or not a denoise filter should be applied
              ; to the audio before mixing or not.  Off by default. Requires
-             ; codec_speex to be built and installed.  Do not confuse this option
+             ; func_speex to be built and installed.  Do not confuse this option
              ; with drop_silence.  Denoise is useful if there is a lot of background
              ; noise for a user as it attempts to remove the noise while preserving
              ; the speech.  This option does NOT remove silence from being mixed into
@@ -126,6 +130,7 @@ type=user
                          ; the conference. This option is off by default.
 ;dtmf_passthrough=yes  ; Sets whether or not DTMF should pass through the conference.
                        ; This option is off by default.
+;announcement=</path/to/file> ; Play a sound file to the user when they join the conference.
 
 ; --- ConfBridge Bridge Profile Options ---
 [default_bridge]
@@ -168,6 +173,33 @@ type=bridge
                         ; larger amounts of delay into the bridge.  Valid values here are 10, 20, 40,
                         ; or 80.  By default 20ms is used.
 
+;video_mode = follow_talker; Sets how confbridge handles video distribution to the conference participants.
+                           ; Note that participants wanting to view and be the source of a video feed
+                           ; _MUST_ be sharing the same video codec.  Also, using video in conjunction with
+                           ; with the jitterbuffer currently results in the audio being slightly out of sync
+                           ; with the video.  This is a result of the jitterbuffer only working on the audio
+                           ; stream.  It is recommended to disable the jitterbuffer when video is used.
+                           ;
+                           ; --- MODES ---
+                           ; none: No video sources are set by default in the conference. It is still
+                           ;       possible for a user to be set as a video source via AMI or DTMF action
+                           ;       at any time.
+                           ;
+                           ; follow_talker: The video feed will follow whoever is talking and providing video.
+                           ;
+                           ; last_marked: The last marked user to join the conference with video capabilities
+                           ;              will be the single source of video distributed to all participants.
+                           ;              If multiple marked users are capable of video, the last one to join
+                           ;              is always the source, when that user leaves it goes to the one who
+                           ;              joined before them.
+                           ;
+                           ; first_marked: The first marked user to join the conference with video capabilities
+                           ;               is the single source of video distribution among all participants. If
+                           ;               that user leaves, the marked user to join after them becomes the source.
+
+;language=en               ; Set the language used for announcements to the conference.
+                           ; Default is en (English).
+
 ; All sounds in the conference are customizable using the bridge profile options below.
 ; Simply state the option followed by the filename or full path of the filename after
 ; the option.  Example: sound_had_joined=conf-hasjoin  This will play the conf-hasjoin
@@ -216,6 +248,11 @@ type=bridge
 ; Below is a list of menu actions that can be assigned
 ; to a DTMF sequence.
 ;
+; To have the first DTMF digit in a sequence be the '#' character, you need to
+; escape it.  If it is not escaped then normal config file processing will
+; think it is a directive like #include.  For example:
+; \#1=toggle_mute                      ; Pressing #1 will toggle the mute setting.
+;
 ; A single DTMF sequence can have multiple actions associated with it. This is
 ; accomplished by stringing the actions together and using a ',' as the delimiter.
 ; Example:  Both listening and talking volume is reset when '5' is pressed.
@@ -238,7 +275,7 @@ type=bridge
                                        ; using the '&' character as a delimiter.
 ; toggle_mute      ; Toggle turning on and off mute.  Mute will make the user silent
                    ; to everyone else, but the user will still be able to listen in.
-                   ; continue to collect the dtmf sequence.
+
 ; no_op ; This action does nothing (No Operation). Its only real purpose exists for
         ; being able to reserve a sequence in the config as a menu exit sequence.
 ; decrease_listening_volume ; Decreases the channel's listening volume.
@@ -265,6 +302,32 @@ type=bridge
                                ; unlocking the conference.  Non admins can not use
                                ; this action even if it is in their menu.
 
+; set_as_single_video_src   ; This action allows any user to set themselves as the
+                            ; single video source distributed to all participants.
+                            ; This will make the video feed stick to them regardless
+                            ; of what the video_mode is set to.
+
+; release_as_single_video_src ; This action allows a user to release themselves as
+                              ; the video source.  If video_mode is not set to "none"
+                              ; this action will result in the conference returning to
+                              ; whatever video mode the bridge profile is using.
+                              ;
+                              ; Note that this action will have no effect if the user
+                              ; is not currently the video source.  Also, the user is
+                              ; not guaranteed by using this action that they will not
+                              ; become the video source again.  The bridge will return
+                              ; to whatever operation the video_mode option is set to
+                              ; upon release of the video src.
+
+; admin_toggle_mute_participants ; This action allows an administrator to toggle the mute
+                                 ; state for all non-admins within a conference.  All
+                                 ; admin users are unaffected by this option.  Note that all
+                                 ; users, regardless of their admin status, are notified
+                                 ; that the conference is muted.
+
+; participant_count        ; This action plays back the number of participants currently
+                           ; in a conference
+
 [sample_user_menu]
 type=menu
 *=playback_and_continue(conf-usermenu)
@@ -276,8 +339,8 @@ type=menu
 6=increase_listening_volume
 *7=decrease_talking_volume
 7=decrease_talking_volume
-*8=no_op
-8=no_op
+*8=leave_conference
+8=leave_conference
 *9=increase_talking_volume
 9=increase_talking_volume