Home

Resources

Products

Developers

Main • Conference

Conference room module

The conference room is an N-way audio mixer to which an arbitrary number of conference legs are attached.

The name of the conference room to connect to depends of the message:

  • for call.execute the callto parameter must be of the form "conf/NAME" (default empty) sets a specific room name, if the NAME is empty a new, unique conference room name is generated
  • for call.conference the room parameter (default empty) sets a specific room name instead of generating a new, unique one

In both cases the actual name of the conference is returned in the room parameter as "conf/NAME" like it should be used for further references.

The automatically generated room names are of the form "x-NUMBER" where NUMBER is incremented for each new room created. You must never make assumptions about the next room number, you must use the returned room parameter.

Each conference leg has the following capabilities that are controlled by the parameters of the call.execute or call.conference message:

  • existing (default false) forces using an existing room else the call fails
  • smart (default true) computes energy and supresses noise
  • echo (default false) hear back own voice in the conference's global mix
  • voice (default true) can speak to the conference, else can only hear it
  • counted (default true) conference leg is counted as regular user
  • billing (default false) emits messages needed to bill conference participants
  • utility (default false) creates a housekeeping conference leg that doesn't emit notifications and defaults to smart=false, echo=true, counted=false
  • player (default false) marks the conference leg as music player

The conference room itself has a set of capabilities that are taken from the parameters of the message that created the room:

  • maxusers (default 10) sets a limit to the number of users that can join a room
  • lonely (default false) allows the conference room to persist even when there is only one user connected
  • record (default empty) allows specifying a route that will make an outgoing record-only call
  • notify (default empty) enables generating notification messages for conference events
  • recordwarn (default empty) allows specifying an override source for the recording channel so that the participants are warned
  • rate (default 8000) sample rate used in mixing, must be 8000, 16000 or 32000 for transcoders to work properly

Messages

The conference module handles two messages:

  • call.execute creates or attaches to an existing conference
  • call.conference creates a conference from an existing call allowing to add more call legs to it

A call.conference without a channel can be used to control recording. A record parameter that is "off" or "false" or "disable" will stop recording, else the old recorder is stopped and a new one created.

Besides the normal channel messages the conference rooms can generate chan.notify messages with the following parameters:

  • targetid - ID of the notification requestor
  • event - name of the event that created the message - "created", "destroyed", "joined" or "left"
  • room - name of the conference room
  • users - number of users currently in conference (only for "joined" or "left" events)
  • player - ID of the music player conference leg, if any
  • caller, called, billid, username - only for the "created" event

Configuration

There is no configuration file for this module. All parameters are taken from the call.execute or call.conference message.

Example

A simple conference can be executed via regexroute.conf like this

^701$ = conf/sales

Here 701 number will join people in conference.

^880$ = conf/test;lonely=true;maxusers=50

Here 800 will join people into a conference which is limited to 50 users, and where if there is only one person, they will remain in it (where the parameter lonelytimeout in pbxassist.conf specify the default global timeouts etc.)

Other information

July 2014:
Yate 5.4 and YateBTS 4 launched. Added JSON and DNS support in Javascript, Handover support in YateBTS.

March 2014:
YateBTS 2.0 launched. Added authentication and WebGUI. Added USSD support in commercial version.

March 2014:
Yate 5.2 launched. Better JavaScript support and a fixed memory leak.

Jan 2014:
YateBTS 1.0 launched. The first GSM Basestation which works with an IMS/VoLTE core network.

Jan 2014:
Yate 5.1 launched. Better JavaScript support and added libygsm. Elisa chatbot added in RManager

Oct 2013:
OpenHSS is the Yate based HLR/HSS solution for MVNO and LTE carriers.

Oct 2013:
Yate 5 released. Added IPv6 support in SIP for LTE. Improved JavaScript support. Download NOW

Jan 2013:
Yate 4.3 released: Added XML support in Javascript. SCCP - GTT routing between different networks. Stability improvements.
Download NOW

Aug 2012:
Yate 4.2 released: SIP flood protection. Better Jabber/Google Voice support. Usable Javascript. Fixed SIGTRAN links fluctuations.
Download NOW

Apr 2012:
YateClient was accepted in the Mac Store.

Yate 4.1 released: better Gvoice support, iSAC codec, support for new Wanpipe drivers. Fixes T.38 and Mac client issues.

Mar 2012:
SS7Cloud is launched today, 1st March, 2012, by NullTeam, Yate creators. Having all you need to be a US CLEC, it brings SS7 services in a cloud.

Feb 2012:
Yate 4.0 released.
SCCP, TCAP, MAP and CAMEL, TCP and TLS in SIP, Javascript fast prototyping of telephony applications and brand new face for YateClient.

Nov 2011:
Here is a video that, quote "demonstrates the truly awesome power of the YATE engine, as it easily handles 3 simultaneous calls to an audio player application including dtmf (button press) handling "(from PaintedRockComm).

Nov 2011:
Yate will attend ORR - OPENRHEINRUHR (November 12 - 13).

04 May 2011:
sipgate chooses open source project Yate for core infrastructure.

12 Apr 2011:
Yate 3.3.2 released.
Fix for Jingle calls to Google Voice dropping after 5 minutes.
4 Apr 2011:
Yate 3.3 released.
Support for GMail chat conference, fixes for internal microphone in MacOS. Minor fixes in SS7 M2PA and ANSI. Fixes in H.323, SIP and RTP.

9 Mar 2011:
Yate 3.2 released.
Bug fixes in SIGTRAN/MGCP/SS7 and added support for CNAM/LNP lookup by SIP INVITE/3xx.

Feb 2011:
Yate will attend FOSDEM and XMPP summit.

31 Jan 2011:
Yate 3.1 released.
Yate client support for Google Voice. Support for any country tones in tonegen.

20 Dec 2010:
Yate 3.0 released.
SS7 ITU certified. SS7 STP added. Client supports Jabber IM (Google Talk + Facebook).

3 May 2010:
Yate 3.0.0 alpha 3 released. Featuring the new Jabber server and wideband audio.

8 March 2010:
Yate 2.2 released. Mostly bug fixes. Dahdi compatible. Latest 2 release before 3.0.

6-7 February 2010:
Yate booth at FOSDEM 2010. Free CD with Freesentral available.

2 Nov 2009:
Yate 2.1 launched. Can replace a Cisco PGW2200 to control a Cisco AS54xx.

6 Aug 2008:
Yate and OpenSIPS (former OpenSER) join to build IP based clusters.

4 Aug 2008:
Yate 2 launched.


EditHistoryBacklinksRecent ChangesSearch