Call.conference

From Yate Documentation
Jump to: navigation, search

call.conference is sent from an existing channel to the conference module to request that the call is converted to a conference.

If the message succeeds the two call endpoints are disconnected and connected each as a conference leg to the same room. The name of the room is returned in the message and can be used to attach more call legs making it an N-way conference.

Message parameters

room
the name of the room. If present, it must be like room/SOMETHING.
utility
(boolean, default: false) true creates a channel that is used for housekeeping tasks like recording or playing prompts to everybody
counted
(boolean, default: opposite of "utility") set to false (default for utility) to not count the conference leg against maxusers or disconnect criteria
existing
(boolean) set to true to always attach to an existing conference; the call will fail if a conference with that name doesn't exist
reason
??? (string, default: "conference")
confowner
if "true" adds room owner, if "false" removes room owner, if other string adds specified channel as room owner.
billing
(bool, default: false) set to true to generate "chan.startup" and "chan.hangup" messages for billing purposes
keeptarget
??? (bool, default: false)
smart
(bool, default: opposite of "utility") set to false to disable energy and noise level calculation
echo
(bool, default: same as "utility") set to true to hear back the voice this channel has injected in the conference
voice
(bool, default: true) set to false to have the conference leg just listen to the voice mix without being able to talk
timeout
??? (integer, default: ???)
player
??? (bool, default: false)

Upon successfull return, room and peerid paramters will be updated and the following parameters will be added:

newroom
true if new room was created
users
number of user in this room


See also

Personal tools
Namespaces

Variants
Actions
Preface
Configuration
Administrators
Developers