app_confbridge: Conference Bridge Application¶

This configuration documentation is for functionality provided by app_confbridge.

Configuration File: confbridge.conf¶

[global]: Unused, but reserved.¶

[user_profile]: A named profile to apply to specific callers.¶

Callers in a ConfBridge have a profile associated with them that determine their options. A configuration section is determined to be a user_profile when the 'type' parameter has a value of 'user'.

Configuration Option Reference¶

Configuration Option Descriptions¶

announce_user_count_all¶

Sets if the number of users should be announced to all the other users in the conference when this user joins. This option can be either set to 'yes' or a number. When set to a number, the announcement will only occur once the user count is above the specified number.

denoise¶

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 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 the conference and does come at the cost of a slight performance hit.

dsp_drop_silence¶

This option drops what Asterisk detects as silence from entering into the bridge. Enabling this option will drastically improve performance and help remove the buildup of background noise from the conference. Highly recommended for large conferences due to its performance enhancements.

dsp_silence_threshold¶

The time in milliseconds of sound falling below the dsp_talking_threshold option when a user is considered to stop talking. This value affects several operations and should not be changed unless the impact on call quality is fully understood.

What this value affects internally:

1. When talk detection AMI events are enabled, this value determines when the user has stopped talking after a period of talking. If this value is set too low AMI events indicating the user has stopped talking may get falsely sent out when the user briefly pauses during mid sentence.
   

2. The drop_silence option depends on this value to determine when the user's audio should begin to be dropped from the conference bridge after the user stops talking. If this value is set too low the user's audio stream may sound choppy to the other participants. This is caused by the user transitioning constantly from silence to talking during mid sentence.
   

The best way to approach this option is to set it slightly above the maximum amount of milliseconds of silence a user may generate during natural speech.

Valid values are 1 through 2^31.

dsp_talking_threshold¶

The minimum average magnitude per sample in a frame for the DSP to consider talking/noise present. A value below this level is considered silence. This value affects several operations and should not be changed unless the impact on call quality is fully understood.

What this value affects internally:

1. Audio is only mixed out of a user's incoming audio stream if talking is detected. If this value is set too high the user will hear himself talking.
   

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 low AMI events may be falsely triggered by variants in room noise.
   

3. The drop_silence option depends on this value to determine when the user's audio should be mixed into the bridge after periods of silence. If this value is too high the user's speech will get discarded as they will be considered silent.
   

Valid values are 1 through 2^15.

echo_events¶

If events are enabled for this user and this option is set, the user will receive events they trigger, talking, mute, etc. If not set, they will not receive their own events.

jitterbuffer¶

Enabling this option places a jitterbuffer on the user's audio stream before audio mixing is performed. This is highly recommended but will add a slight delay to the audio. This option is using the 'JITTERBUFFER' dialplan function's default adaptive jitterbuffer. For a more fine tuned jitterbuffer, disable this option and use the 'JITTERBUFFER' dialplan function on the user before entering the ConfBridge application.

send_events¶

If events are enabled for this bridge and this option is set, users will receive events like join, leave, talking, etc. via text messages. For users accessing the bridge via chan_pjsip, this means in-dialog MESSAGE messages. This is most useful for WebRTC participants where the browser application can use the messages to alter the user interface.

text_messaging¶

If text messaging is enabled for this user then text messages will be sent to it. These may be events or from other participants in the conference bridge. If disabled then no text messages are sent to the user.

type¶

The type parameter determines how a context in the configuration file is interpreted.

• user - Configure the context as a user_profile
  

• bridge - Configure the context as a bridge_profile
  

• menu - Configure the context as a menu
  

[bridge_profile]: A named profile to apply to specific bridges.¶

ConfBridge bridges have a profile associated with them that determine their options. A configuration section is determined to be a 'bridge_profile' when the 'type' parameter has a value of 'bridge'.

Configuration Option Reference¶

Configuration Option Descriptions¶

binaural_active¶

Activates binaural mixing for a conference bridge. Binaural features are disabled by default.

enable_events¶

If enabled, recipients who joined the bridge via a channel driver that supports Enhanced Messaging (currently only chan_pjsip) will receive in-dialog messages containing a JSON body describing the event. The Content-Type header will be 'text/x-ast-confbridge-event'. This feature must also be enabled in user profiles.

internal_sample_rate¶

Sets the internal native sample rate the conference is mixed at. This is set to automatically adjust the sample rate to the best quality by default. Other values can be anything from 8000-192000. If a sample rate is set that Asterisk does not support, the closest sample rate Asterisk does support to the one requested will be used.

language¶

By default, announcements to a conference use English. Which means the prompts played to all users within the conference will be English. By changing the language of a bridge, this will change the language of the prompts played to all users.

max_members¶

This option limits the number of participants for a single conference to a specific number. By default conferences have no participant limit. After the limit is reached, the conference will be locked until someone leaves. Note however that an Admin user will always be alowed to join the conference regardless if this limit is reached or not.

maximum_sample_rate¶

Sets the maximum native sample rate the conference is mixed at. This is set to not have a maximum by default. If a sample rate is specified, though, the native sample rate will never exceed it.

mixing_interval¶

Sets the internal mixing interval in milliseconds for the bridge. This number reflects how tight or loose the mixing will be for the conference. In order to improve performance a larger mixing interval such as 40ms may be chosen. Using a larger mixing interval comes at the cost of introducing larger amounts of delay into the bridge. Valid values here are 10, 20, 40, or 80.

record_command¶

Executes the specified command when recording ends. Any strings matching '^{X}' will be unescaped to X. All variables will be evaluated at the time ConfBridge is called.

record_conference¶

Records the conference call starting when the first user enters the room, and ending when the last user exits the room. The default recorded filename is 'confbridge-${name of conference bridge}-${start time}.wav' and the default format is 8khz slinear. This file will be located in the configured monitoring directory in asterisk.conf.

record_file¶

When record_conference is set to yes, the specific name of the record file can be set using this option. Note that since multiple conferences may use the same bridge profile, this may cause issues depending on the configuration. It is recommended to only use this option dynamically with the 'CONFBRIDGE()' dialplan function. This allows the record name to be specified and a unique name to be chosen. By default, the record_file is stored in Asterisk's spool/monitor directory with a unique filename starting with the 'confbridge' prefix.

record_file_append¶

When record_file_append is set to yes, stopping and starting recording on a conference adds the new portion to end of current record_file. When this is set to no, a new record_file is generated every time you start then stop recording on a conference.

record_file_timestamp¶

When record_file_timestamp is set to yes, the start time is appended to record_file so that the filename is unique. This allows you to specify a record_file but not overwrite existing recordings.

record_options¶

Pass additional options to MixMonitor when record_conference is set to yes. See 'MixMonitor' for available options.

regcontext¶

When set this will cause the name of the created conference to be registered into the named context at priority 1 with an operation of NoOP(). This can then be used in other parts of the dialplan to test for the existence of a specific conference bridge. You should be aware that there are potential races between testing for the existence of a bridge, and taking action upon that information, consider for example two callers executing the check simultaneously, and then taking special action as "first caller" into the bridge. The same for exiting, directly after the check the bridge can be destroyed before the new caller enters (creating a new bridge), for example, and the "first member" actions could thus be missed.

remb_behavior¶

Sets how REMB reports are combined from multiple sources to form one. A REMB report consists of information about the receiver estimated maximum bitrate. As a source stream may be forwarded to multiple receivers the reports must be combined into a single one which is sent to the sender.

• average - The average of all estimated maximum bitrates is taken and sent to the sender.
  

• lowest - The lowest estimated maximum bitrate is forwarded to the sender.
  

• highest - The highest estimated maximum bitrate is forwarded to the sender.
  

• average_all - The average of all estimated maximum bitrates is taken from all receivers in the bridge and a single value is sent to each sender.
  

• lowest_all - The lowest estimated maximum bitrate of all receivers in the bridge is taken and sent to each sender.
  

• highest_all - The highest estimated maximum bitrate of all receivers in the bridge is taken and sent to each sender.
  

• force - The bitrate configured in 'remb_estimated_bitrate' is sent to each sender.
  

remb_estimated_bitrate¶

When 'remb_behavior' is set to 'force', this options sets the estimated bitrate (in bits per second) sent to each participant in REMB reports.

remb_send_interval¶

Sets the interval in milliseconds that a combined REMB frame will be sent to video sources. This is done by taking all REMB frames that have been received since the last REMB frame was sent, making a combined value, and sending it to the source. A REMB frame contains receiver estimated maximum bitrate information. By creating a combined REMB frame the sender of video can be influenced on the bitrate they choose, allowing better quality for all receivers.

sound_¶

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' sound file found in the sounds directory when announcing someone's name is joining the conference.

• sound_join - The sound played to everyone when someone enters the conference.
  

• sound_leave - The sound played to everyone when someone leaves the conference.
  

• sound_has_joined - The sound played before announcing someone's name has joined the conference. This is used for user intros. Example '"_____ has joined the conference"'
  

• sound_has_left - The sound played when announcing someone's name has left the conference. This is used for user intros. Example '"_____ has left the conference"'
  

• sound_kicked - The sound played to a user who has been kicked from the conference.
  

• sound_muted - The sound played when the mute option it toggled on.
  

• sound_unmuted - The sound played when the mute option it toggled off.
  

• sound_binaural_on - The sound played when binaural audio is turned on.
  

• sound_binaural_off - The sound played when the binaural audio is turned off.
  

• sound_only_person - The sound played when the user is the only person in the conference.
  

• sound_only_one - The sound played to a user when there is only one other person is in the conference.
  

• sound_there_are - The sound played when announcing how many users there are in a conference.
  

• sound_other_in_party - This file is used in conjunction with 'sound_there_are' when announcing how many users there are in the conference. The sounds are stringed together like this. '"sound_there_are" ${number of participants} "sound_other_in_party"'
  

• sound_place_into_conference - The sound played when someone is placed into the conference after waiting for a marked user.
  

• sound_wait_for_leader - The sound played when a user is placed into a conference that can not start until a marked user enters.
  

• sound_leader_has_left - The sound played when the last marked user leaves the conference.
  

• sound_get_pin - The sound played when prompting for a conference pin number.
  

• sound_invalid_pin - The sound played when an invalid pin is entered too many times.
  

• sound_locked - The sound played to a user trying to join a locked conference.
  

• sound_locked_now - The sound played to an admin after toggling the conference to locked mode.
  

• sound_unlocked_now - The sound played to an admin after toggling the conference to unlocked mode.
  

• sound_error_menu - The sound played when an invalid menu option is entered.
  

type¶

The type parameter determines how a context in the configuration file is interpreted.

• user - Configure the context as a user_profile
  

• bridge - Configure the context as a bridge_profile
  

• menu - Configure the context as a menu
  

video_mode¶

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.

• 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.
  

• sfu - Selective Forwarding Unit - Sets multi-stream operation for a multi-party video conference.
  

video_update_discard¶

Sets the amount of time in milliseconds after sending a video update request that subsequent video updates should be discarded. This means that if we send a video update we will discard any other video update requests until after the configured amount of time has elapsed. This prevents flooding of video update requests from clients.

[menu]: A conference user menu¶

Conference users, as defined by a conf_user, can have a DTMF menu assigned to their profile when they enter the 'ConfBridge' application.

Configuration Option Reference¶

Configuration Option Descriptions¶

0-9A-D*¶

The ConfBridge application also has the ability to apply custom DTMF menus to each channel using the application. Like the User and Bridge profiles a menu is passed in to ConfBridge as an argument in the dialplan.

Below is a list of menu actions that can be assigned to a DTMF sequence.

• playback(filename&filename2&...) - 'playback' will play back an audio file to a channel and then immediately return to the conference. This file can not be interupted by DTMF. Multiple files can be chained together using the '&' character.
  

• playback_and_continue(filename&filename2&...) - 'playback_and_continue' will play back a prompt while continuing to collect the dtmf sequence. This is useful when using a menu prompt that describes all the menu options. Note however that any DTMF during this action will terminate the prompts playback. Prompt files can be chained together 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.
  

• toggle_binaural - Toggle turning on and off binaural audio processing.
  

• 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.
  

• increase_listening_volume - Increases the channel's listening volume.
  

• reset_listening_volume - Reset channel's listening volume to default level.
  

• decrease_talking_volume - Decreases the channel's talking volume.
  

• increase_talking_volume - Increases the channel's talking volume.
  

• reset_talking_volume - Reset channel's talking volume to default level.
  

• dialplan_exec(context,exten,priority) - The 'dialplan_exec' action allows a user to escape from the conference and execute commands in the dialplan. Once the dialplan exits the user will be put back into the conference. The possibilities are endless!
  

• leave_conference - This action allows a user to exit the conference and continue execution in the dialplan.
  

• admin_kick_last - This action allows an Admin to kick the last participant from the conference. This action will only work for admins which allows a single menu to be used for both users and admins.
  

• admin_toggle_conference_lock - This action allows an Admin to toggle locking and 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
  

type¶

The type parameter determines how a context in the configuration file is interpreted.

• user - Configure the context as a user_profile
  

• bridge - Configure the context as a bridge_profile
  

• menu - Configure the context as a menu
  

Generated Version¶

This documentation was generated from Asterisk branch 16 using version GIT