Conference room module - Revision history

Monica at 10:35, 4 November 2013

2013-11-04T10:35:24Z

2013-05-16T12:42:00Z

2013-05-16T12:41:10Z

2013-04-12T10:27:09Z

2013-04-12T10:22:01Z

2013-04-12T10:21:08Z

2013-04-11T10:54:56Z

‎Messages

2013-04-08T09:13:50Z

‎Examples

2013-04-08T09:13:00Z

‎Conference room capabilities

2013-04-08T09:12:48Z

‎Examples

← Older revision		Revision as of 10:35, 4 November 2013
Line 117:		Line 117:
	* [[Pbxassist\|Pbxassist module]]		* [[Pbxassist\|Pbxassist module]]
	* [[Conference PBX]]		* [[Conference PBX]]
		+
		+	[[Category:PBX]] [[Category:Conference]]

@@ Line 1: / Line 1: @@
 A conference room is an N-way audio mixer to which an arbitrary number of conference legs are attached.<br>
 Parameters that are needed for conference room are taken from [[call.execute]] and [[call.conference]] messages.<br>
@@ Line 19: / Line 10: @@
 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.
-=== Conference leg capabilities===
+== Conference leg capabilities==
 Each conference leg has the following capabilities that are controlled by the parameters of the [[call.execute]] or [[call.conference]] message:
@@ Line 32: / Line 23: @@
 * ''player'' (default false) marks the conference leg as music player
-=== Conference room capabilities===
+== Conference room capabilities==
 The conference room itself has a set of capabilities that are taken from the parameters of the message that created the room:

@@ Line 1: / Line 1: @@
 Yate can be used as a Conference Server in two ways:
-* you can execute a conference directly from routing module (e.g [[Regular_expressions|regexroute.conf]]), as you can see in the [[#Examples|examples]]
+* you can execute a conference directly from routing module (e.g [[Regular_expressions|regexroute.conf]]), as you can see in the [[#Examples|examples]],
 * or you can do it programmatically using [[call.conference]] message from an external script or by using [[Pbxassist| module Pbxassist]], that has the capability of doing [[Conference PBX|PBX operations]] for conference on receiving DTMF sequences.

@@ Line 1: / Line 1: @@
 Yate can be used as a Conference Server in two ways:
-* or execute a conference directly from routing module (e.g [[Regular_expressions|regexroute.conf]]), as you can see in the [[#Examples|examples]]
+* you can execute a conference directly from routing module (e.g [[Regular_expressions|regexroute.conf]]), as you can see in the [[#Examples|examples]]
-* you can do it programmatically using [[call.conference]] message from an external script or by using [[Pbxassist| module Pbxassist]], that has the capability of doing [[Conference PBX|PBX operations]] for conference on receiving DTMF sequences.
+* or you can do it programmatically using [[call.conference]] message from an external script or by using [[Pbxassist| module Pbxassist]], that has the capability of doing [[Conference PBX|PBX operations]] for conference on receiving DTMF sequences.

@@ Line 1: / Line 1: @@
 Yate can be used as a Conference Server in two ways:
 * you can do it programmatically using [[call.conference]] message from an external script or by using [[Pbxassist| module Pbxassist]], that has the capability of doing [[Conference PBX|PBX operations]] for conference on receiving DTMF sequences.
 == Conference room module ==

@@ Line 44: / Line 44: @@
 * ''interval'' - time interval for receiving chan.notify with event ''speaking''. Default value is 3 sec.
-== Messages ==
+== Messages to send to conference ==
-The conference module handles two messages:
+The conference can be started by using:
-* ''[[call.execute]]'' creates or attaches to an existing conference
+* ''[[call.execute]]'' message - that creates or attaches to an existing conference
-* ''[[call.conference]]'' creates a conference from an existing call allowing to add more call legs to it
+* ''[[call.conference]]'' messages - that 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.

@@ Line 106: / Line 106: @@
    $m->params["maxusers"] = $maxusers;
    $m->params["smart"] = "t";
-−
    if ($is_organizer == "1") {
        $m->params["record"] = "external/nodata/conference.php";

@@ Line 41: / Line 41: @@
 * ''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
-* ''speakers'' - true/false/interger value(0-8). If true or integer between 0-8, module notifies who speaks in the conference at some point. This must be used with parameter ''interval''. The value for ''speakers'' can't be more then 8. If true, value defaults to 3.
+* ''speakers'' - true/false/interger value(0-8). If true or integer between 0-8, module notifies who speaks in the conference at some point. This must be used with parameter ''interval''. If true, value defaults to 3.
 * ''interval'' - time interval for receiving chan.notify with event ''speaking''. Default value is 3 sec.

← Older revision		Revision as of 09:12, 8 April 2013
Line 93:		Line 93:

	In this scenario calls to numbers 70x can create or join a room while calls to 71x can join a room only if already populated.		In this scenario calls to numbers 70x can create or join a room while calls to 71x can join a room only if already populated.
		+
		+	* make a conference from an external module
		+
		+	$m = new Yate("chan.masquerade");
		+	$m->id = "";
		+	$m->params["message"] = "call.execute";
		+	$m->params["id"] = $partycallid;
		+	$m->params["callto"] = "conf/cs-$conference_id";
		+	$m->params["notify"] = "conf-monitor/cs-$conference_id";
		+	$m->params["billing"] = "true";
		+	$m->params["lonely"] = "true";
		+	$m->params["maxusers"] = $maxusers;
		+	$m->params["smart"] = "t";
		+
		+	if ($is_organizer == "1") {
		+	$m->params["record"] = "external/nodata/conference.php";
		+	// set this so that script can play warnings in conference
		+	$m->params["recordwarn"] = "-";
		+	$m->params["speakers"] = $speakers;
		+	$m->params["interval"] = $interval_notifications;
		+	$m->params["waitlock"] = -200;
		+	} else {
		+	$m->params["existing"] = "t";
		+	}
		+	$m->Dispatch();