Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated to GIT-15-9149bb498f

...

Option Name

Type

Default Value

Regular Expression

Description

type

None

 

false

Define this configuration category as a user profile.

admin

Boolean

no

false

Sets if the user is an admin or not

send_events

Boolean

no

false

Sets if events are send to the user

echo_events

Boolean

no

false

Sets if events are echoed back to the user that triggered them

marked

Boolean

no

false

Sets if this is a marked user or not

startmuted

Boolean

no

false

Sets if all users should start out muted

music_on_hold_when_empty

Boolean

no

false

Play MOH when user is alone or waiting on a marked user

quiet

Boolean

no

false

Silence enter/leave prompts and user intros for this user

announce_user_count

Boolean

no

false

Sets if the number of users should be announced to the user

announce_user_count_all

Custom

no

false

Announce user count to all the other users when this user joins

announce_only_user

Boolean

yes

false

Announce to a user when they join an empty conference

wait_marked

Boolean

no

false

Sets if the user must wait for a marked user to enter before joining a conference

end_marked

Boolean

no

false

Kick the user from the conference when the last marked user leaves

talk_detection_events

Boolean

no

false

Set whether or not notifications of when a user begins and ends talking should be sent out as events over AMI

dtmf_passthrough

Boolean

no

false

Sets whether or not DTMF should pass through the conference

announce_join_leave

Boolean

no

false

Prompt user for their name when joining a conference and play it to the conference when they enter

announce_join_leave_review

Boolean

no

false

Prompt user for their name when joining a conference and play it to the conference when they enter. The user will be asked to review the recording of their name before entering the conference.

pin

String

 

false

Sets a PIN the user must enter before joining the conference

music_on_hold_class

String

 

false

The MOH class to use for this user

announcement

String

 

false

Sound file to play to the user when they join a conference

denoise

Boolean

no

false

Apply a denoise filter to the audio before mixing

dsp_drop_silence

Boolean

no

false

Drop what Asterisk detects as silence from audio sent to the bridge

dsp_silence_threshold

Unsigned Integer

2500

false

The number of milliseconds of silence necessary to declare talking stopped.

dsp_talking_threshold

Unsigned Integer

160

false

Average magnitude threshold to determine talking.

jitterbuffer

Boolean

no

false

Place a jitter buffer on the user's audio stream before audio mixing is performed

template

Custom

 

false

When using the CONFBRIDGE dialplan function, use a user profile as a template for creating a new temporary profile

timeout

Unsigned Integer

0

false

Kick the user out of the conference after this many seconds. 0 means there is no timeout for the user.

...

  • user - Configure the context as a user_profile
  • bridge - Configure the context as a bridge_profile
  • menu - Configure the context as a menu

Anchor
user_profile_send_events
user_profile_send_events

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.

Anchor
user_profile_echo_events
user_profile_echo_events

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.

Anchor
user_profile_announce_user_count_all
user_profile_announce_user_count_all

...

Option Name

Type

Default Value

Regular Expression

Description

type

None

 

false

Define this configuration category as a bridge profile

jitterbuffer

Boolean

no

false

Place a jitter buffer on the conference's audio stream

internal_sample_rate

Unsigned Integer

0

false

Set the internal native sample rate for mixing the conference

language

String

en

false

The language used for announcements to the conference.

mixing_interval

Custom

20

false

Sets the internal mixing interval in milliseconds for the bridge

binaural_active

Boolean

no

false

If true binaural conferencing with stereo audio is active

record_conference

Boolean

no

false

Record the conference starting with the first active user's entrance and ending with the last active user's exit

record_file

String

confbridge-name of conference bridge-start time.wav

false

The filename of the conference recording

record_file_append

Boolean

yes

false

Append to record file when starting/stopping on same conference recording

record_file_timestamp

Boolean

yes

false

Append the start time to the record_file name so that it is unique.

record_options

String

 

false

Pass additional options to MixMonitor when recording

record_command

String

 

false

Execute a command after recording ends

regcontext

String

 

false

The name of the context into which to register the name of the conference bridge as NoOP() at priority 1

video_mode

Custom

 

false

Sets how confbridge handles video distribution to the conference participants

max_members

Unsigned Integer

0

false

Limit the maximum number of participants for a single conference

sound_

Custom

 

false

Override the various conference bridge sound files

video_update_discard

Unsigned Integer

2000

false

Sets the amount of time in milliseconds after sending a video update to discard subsequent video updates

remb_send_interval

Unsigned Integer

0

false

Sets the interval in milliseconds that a combined REMB frame will be sent to video sources

remb_behavior

Custom

average

false

Sets how REMB reports are generated from multiple sources

enable_events

Boolean

no

false

Enables events for this bridge

template

Custom

 

false

When using the CONFBRIDGE dialplan function, use a bridge profile as a template for creating a new temporary profile

...

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

Anchor
bridge_profile_enable_events
bridge_profile_enable_events

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.

menu

A conference user menu

...

Option Name

Type

Default Value

Regular Expression

Description

type

None

 

false

Define this configuration category as a menu

template

Custom

 

false

When using the CONFBRIDGE dialplan function, use a menu profile as a template for creating a new temporary profile

0-9A-D*#

Custom

 

true

DTMF sequences to assign various confbridge actions to

...

This documentation was imported from Asterisk Version GIT-15-7d9f085cb89149bb498f