Ctrl K
ring2all.com

Conference Profiles Module Documentation

Table of Contents

  1. Module Overview (Technical)
  2. Module Overview (Commercial/Business)
  3. Module Overview (End User/Administrator)
  4. Configuration Tabs
  5. Settings Reference
  6. Common Scenarios & Examples
  7. Limitations & Important Notes
  8. Troubleshooting Tips
  9. Glossary

---

1. Module Overview (Technical)

What Are Conference Profiles?

Conference Profiles are FreeSWITCH mod_conference configuration templates that define how conference rooms behave. They control audio quality, video settings, participant sounds, DTMF controls, and advanced conference flags.

Architecture

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Conference Profiles Architecture                  │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Admin Panel                                                    │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Conference Profiles                               │   │
│  │                                                          │   │
│  │  Tabs:                                                   │   │
│  │  ├─ Basic (name, rate, channels, energy)                │   │
│  │  ├─ Audio (MOH, comfort noise)                          │   │
│  │  ├─ Video (mode, layout, codec, max participants)       │   │
│  │  ├─ Sounds (enter, exit, mute, alone, kicked)           │   │
│  │  ├─ Advanced (flags, controls)                          │   │
│  │  └─ Caller Controls (DTMF mappings)                     │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Generates XML                                          │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        conference.conf.xml                               │   │
│  │                                                          │   │
│  │  <profile name="standard">                               │   │
│  │    <param name="rate" value="16000"/>                   │   │
│  │    <param name="video-mode" value="mux"/>               │   │
│  │    <param name="caller-controls" value="default"/>      │   │
│  │  </profile>                                              │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Used by conferences                                    │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Conference Room (Conferences Module)              │   │
│  │                                                          │   │
│  │  Conference ABC → Profile: standard                     │   │
│  │  Settings applied to all participants                   │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Tables

TablePurpose
public.conference_profilesProfile definitions

Key Files

FileDescription
modules/conferenceProfiles/Frontend module
FreeSWITCH conference.conf.xmlGenerated configuration
---

2. Module Overview (Commercial/Business)

Business Value

Conference Profiles provides customized conferencing:

Without ProfilesWith Profiles
Default settingsCustom audio/video
One-size-fits-allDifferent profiles
No controlFull customization
Fixed soundsBranded sounds

Use Cases

  1. High-Quality Audio

- HD audio (16kHz+)

- Stereo conferences

  1. Video Conferencing

- Video layouts (2x2, 3x3)

- Codec selection

  1. Branded Experience

- Custom entry/exit sounds

- Custom MOH

  1. Moderated Conferences

- Wait for moderator

- Moderator controls

Feature Highlights

FeatureBenefit
Audio QualitySample rate, channels
Video ModeMux, bridge, transcode
Video LayoutGrid layouts
Custom SoundsBranded experience
DTMF ControlsParticipant self-service
Conference FlagsFine-tune behavior
---

3. Module Overview (End User/Administrator)

What Can You Do?

  • Create conference profile templates
  • Configure audio sample rate and channels
  • Set video mode and layout
  • Customize entry/exit sounds
  • Configure DTMF controls
  • Set moderator controls
  • Define conference flags

Conference Profiles Interface

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Conference Profiles                                │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Manage FreeSWITCH conference profiles                          │
│                                                                 │
│  [+ Create Profile]                                             │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │ Name          │ Description         │ Type   │ Status    │  │
│  ├───────────────┼─────────────────────┼────────┼───────────┤  │
│  │ default       │ Standard conferences│ System │ ✓ Enabled │  │
│  │ hd-audio      │ High-quality audio  │ Custom │ ✓ Enabled │  │
│  │ video-4x4     │ 4x4 video grid      │ Custom │ ✓ Enabled │  │
│  │ moderated     │ Wait for moderator  │ Custom │ ✓ Enabled │  │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Profile Edit View

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Edit Conference Profile                            │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  [Basic] [Audio] [Video] [Sounds] [Advanced] [Caller Controls] │
│  ─────────────────────────────────────────────────────────────  │
│                                                                 │
│  Basic Information                                              │
│  Profile Name: [hd-audio                     ]                 │
│  Description: [High-quality audio conferencing]                │
│  Enabled: ✓                                                     │
│                                                                 │
│  Basic Audio Settings                                           │
│  Sample Rate: [16000 ▼]                                        │
│    8000 (Narrowband) / 16000 (Wideband) / 48000 (Fullband)     │
│                                                                 │
│  Channels (Audio): [1 ▼]                                       │
│    1 = Mono / 2 = Stereo                                       │
│                                                                 │
│  Energy Level: [100             ]                              │
│    Minimum audio energy (0-500). Higher = less background noise │
│                                                                 │
│  [Save] [View XML] [Cancel]                                     │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP
Sample Rate: Use 16000 for HD audio, 48000 for maximum quality.
TIP
Energy Level: Increase to reduce background noise pickup.
NOTE
System Profiles: Cannot be deleted but can be edited.

---

4. Configuration Tabs

Basic Tab

FieldDescription
Profile NameUnique identifier
DescriptionPurpose notes
EnabledActive/inactive
Sample RateAudio quality (Hz)
ChannelsMono (1) or Stereo (2)
Energy LevelVoice detection threshold

Audio Tab

FieldDescription
Music on HoldPlayed when alone/on hold
Comfort NoiseSoft noise during silence

Video Tab

FieldDescription
Video Modemux, bridge, transcode
Video Layout1x1, 2x2, 3x3, 4x4, etc.
Video CodecVP8, VP9, H.264, H.265
Max Video ParticipantsVideo stream limit

Sounds Tab

FieldDescription
Enter SoundPlayed on join
Exit SoundPlayed on leave
Muted SoundWhen muted
Unmuted SoundWhen unmuted
Alone SoundWhen only participant
Kicked SoundWhen removed

Advanced Tab

FieldDescription
Conference FlagsBehavior flags
Caller ControlsDTMF control group
Moderator ControlsMod control group
Member FlagsParticipant flags

Caller Controls Tab

ControlDefaultDescription
Mute/Unmute0Toggle microphone
Deaf+MuteMute all audio
Energy Up9Less sensitive
Energy Reset8Default sensitivity
Energy Down7More sensitive
Mic Volume Up3Boost outgoing
Mic Volume Reset2Default mic
Mic Volume Down1Lower outgoing
Speaker Up6Boost incoming
Speaker Reset5Default speaker
Speaker Down4Lower incoming
Hangup#Leave conference
---

5. Settings Reference

Sample Rates

RateQualityUse Case
8000NarrowbandBasic calls
16000WidebandHD audio
32000Ultra-widebandHigh quality
48000FullbandMaximum

Video Modes

ModeDescription
muxVideo mixing (grid layout)
bridgeDirect video passthrough
transcodeCodec transcoding

Video Layouts

LayoutGrid
1x1Single video
2x24 participants
3x39 participants
4x416 participants
group:gridAuto-arrange

Common Conference Flags

FlagDescription
wait-modWait for moderator
audio-alwaysAlways mix audio
video-bridgeVideo bridge mode
video-floor-onlyShow speaker's video
---

6. Common Scenarios & Examples

Scenario 1: HD Audio Profile

  1. Create new profile
  2. Set Sample Rate = 16000
  3. Set Channels = 1 (mono)
  4. Set Energy Level = 150
  5. Enable Comfort Noise
  6. Save

Scenario 2: Video Conference

  1. Create new profile
  2. Set Video Mode = mux
  3. Set Video Layout = 3x3
  4. Set Video Codec = VP8
  5. Set Max Video Participants = 9
  6. Save

Scenario 3: Moderated Conference

  1. Create new profile
  2. Add conference-flags = wait-mod
  3. Set Moderator Controls
  4. Customize announcements
  5. Save

Scenario 4: Branded Conference

  1. Create new profile
  2. Set Enter Sound = custom/welcome.wav
  3. Set Exit Sound = custom/goodbye.wav
  4. Set MOH = local_stream://branded_moh
  5. Save

---

7. Limitations & Important Notes

Technical Notes

NOTE
Profile Assignment: Profiles are assigned in Conferences module.
NOTE
System Profiles: Cannot be deleted but can be edited.
WARNING
Video CPU: Higher video quality requires more CPU.

Best Practices

  1. Start with Default: Clone system profile
  2. Test Audio Quality: Verify sample rate works
  3. Energy Level: 100-200 for typical rooms
  4. Video Layout: Match expected participant count
  5. Custom Sounds: Use professional recordings

Caller Control Defaults

KeyAction
0Mute/unmute
1-3Mic volume
4-6Speaker volume
7-9Energy level
Deaf+mute
#Hangup
---

8. Troubleshooting Tips

Common Issues

SymptomPossible CauseSolution
Bad audioLow sample rateIncrease to 16000+
EchoEnergy level lowIncrease energy level
No videoVideo mode offSet video-mode = mux
Video lagToo many participantsLower max-video-participants
DTMF not workingWrong controlsCheck caller-controls

XML Preview

Use "View XML" to see generated configuration and verify settings.

Check Profile

Sql
SELECT 
  name,
  enabled,
  settings
FROM public.conference_profiles
WHERE name = 'profile-name';

---

9. Glossary

TermDefinition
Conference ProfileRoom behavior template
Sample RateAudio frequency (Hz)
Energy LevelVoice detection threshold
Video MuxVideo grid mixing
Comfort NoiseBackground noise fill
Caller ControlsDTMF key mappings
ModeratorConference leader
---

Lua Script Status ℹ️

Configuration Module

ComponentStatus
Conference Profilesℹ️ Configuration module - generates FreeSWITCH conference.conf.xml
Conference Profiles is a configuration module. Settings are stored and used to generate FreeSWITCH conference configuration. The conference Lua handler applies these profiles when participants join.

---

Documentation last updated: January 2026
AI Assistant

👋 Hello! I'm your Ring2All documentation assistant. I can help you find information about configuring and using the Ring2All PBX platform.

How can I help you today?