B.63. MeetMe()

Places the caller in a MeetMe conference.
MeetMe([conference][,options[,PIN]])
Connects the caller in the current channel to a MeetMe conference defined by conferenceNo. If this is not specified, the application asks the caller to enter a conference number.
If PIN is correctly set to the PIN (personal identification number) of the conference (set statically in meetme.conf or dynamically by the conference operator) the caller is placed directly into the conference; otherwise, the caller must enter the PIN first.

Important

MeetMe conferences require a Zaptel interface to be installed in the Asterisk server; these provide a time source for synchronization of the participating channels. If no Zaptel interface is available, the ztdummy driver may be used.
MeetMe conferences always use the ulaw codec internally. The more conference participants use other codecs such as GSM or alaw, the higher the processor load due to transcoding.
Valid options include:
a
Sets admin mode.
A
Marks the joining user as a special participant (see w and x).
b
Starts the AGI script defined in ${MEETME_AGI_BACKGROUND}, conf-background.agi by default. (Works only if all the channels in the conference are Zap channels.) The script is passed all DTMF keypresses; will not work in combination with options that also capture DTMF (such as p).
c
Announces the number of participants to a joining user.
d
Dynamically allocates a new conference.
D
Dynamically allocates a new conference but asks the user to set a PIN (if no PIN is desired, the user must press "#").
e
Selects an empty conference.
E
Selects an empty conference that does not require a PIN.
i
Announces join and exit of new participants with review (works only with Zap channels).
I
Announces join and exit of new participants without review (works only with Zap channels).
m
Listen-only mode.
M
Music-on-hold mode. Plays music-on-hold if there is only one participant in the conference.
o
Sets talker optimization. Improves conference quality and reduces transcoding overhead by muting participants who are not currently speaking.
p
Participants may leave by pressing "#".
P
Requests a PIN even if it is provided in the command.
q
Quiet mode. Does not play entry/exit notification tones.
r
Records a conference. File: ${MEETME_RECORDINGFILE}, format: ${MEETME_RECORDINGFORMAT}. Default filename is meetme-conf-rec-${conference}-${uniqueID}. The default format is wav. (Works only with Zap channels.)
s
Switches to menu (user or admin) "*" is pressed.
t
Talk-only mode.
T
Talker detection. (Information is sent to the Manager interface and displayed in the MeetMe list in the CLI.)
v
Video mode (not yet implemented).
w
Wait until the marked participant joins the conference. Until this point, the other participants will hear music-on-hold.
x
Ends the conference when the last marked participant exits (see A).
X
Participants may exit the conference by dialling a single-digit extension in the ${MEETME_EXIT_CONTEXT} context, or the current context if this variable is not defined. Option X does not work with p or s.
1
Does not play the "You are currently the only person in this conference" message when the first conference participant enters.
You can use e (or E) together with d (or D) to dynamically open a new conference. This means you will have to find a way of distributing the conference number to the other users, or employ some dialplan logic to accomplish the same objective.

Note

The options d or D dynamically open conferences; conferences are defined statically in meetme.conf.
exten => 123,1,Answer()
; Place the caller in conference 333 (with PIN 1234):
exten => 123,n,MeetMe(333,DpM,1234)
Commands in the CLI
The following commands are for administering conferences from the CLI. (The value participant is the number of participant as displayed in the participant list):
MeetMe
List all conferences.
MeetMe list conference
List the participants in the specified conference.
MeetMe kick conference participant
Kicks a participant out of the conference.
MeetMe kick conference
Kicks all participants out of the conference.
MeetMe lock conference
Locks a conference to new participants.
MeetMe unlock conference
Unlocks a previous lock (see above).
MeetMe mute conference participant
Mute a conference participant.
MeetMe unmute conference participant
Unmute a conference participant (see above).

Note

Internal help for this application in Asterisk 1.4:
  -= Info about application 'MeetMe' =- 

[Synopsis]
MeetMe conference bridge

[Description]
  MeetMe([confno][,[options][,pin]]): Enters the user into a specified MeetMe
conference.  If the conference number is omitted, the user will be prompted
to enter one.  User can exit the conference by hangup, or if the 'p' option
is specified, by pressing '#'.
Please note: The Zaptel kernel modules and at least one hardware driver (or ztdummy)
             must be present for conferencing to operate properly. In addition, the chan_zap
             channel driver must be loaded for the 'i' and 'r' options to operate at all.

The option string may contain zero or more of the following characters:
      'a' -- set admin mode
      'A' -- set marked mode
      'b' -- run AGI script specified in ${MEETME_AGI_BACKGROUND}
             Default: conf-background.agi  (Note: This does not work with
             non-Zap channels in the same conference)
      'c' -- announce user(s) count on joining a conference
      'd' -- dynamically add conference
      'D' -- dynamically add conference, prompting for a PIN
      'e' -- select an empty conference
      'E' -- select an empty pinless conference
      'i' -- announce user join/leave with review
      'I' -- announce user join/leave without review
      'l' -- set listen only mode (Listen only, no talking)
      'm' -- set initially muted
      'M' -- enable music on hold when the conference has a single caller
      'o' -- set talker optimization - treats talkers who aren't speaking as
             being muted, meaning (a) No encode is done on transmission and
             (b) Received audio that is not registered as talking is omitted
             causing no buildup in background noise
      'p' -- allow user to exit the conference by pressing '#'
      'P' -- always prompt for the pin even if it is specified
      'q' -- quiet mode (don't play enter/leave sounds)
      'r' -- Record conference (records as ${MEETME_RECORDINGFILE}
             using format ${MEETME_RECORDINGFORMAT}). Default filename is
             meetme-conf-rec-${CONFNO}-${UNIQUEID} and the default format is
             wav.
      's' -- Present menu (user or admin) when '*' is received ('send' to menu)
      't' -- set talk only mode. (Talk only, no listening)
      'T' -- set talker detection (sent to manager interface and meetme list)
      'w[(<secs>)]'
          -- wait until the marked user enters the conference
      'x' -- close the conference when last marked user exits
      'X' -- allow user to exit the conference by entering a valid single
             digit extension ${MEETME_EXIT_CONTEXT} or the current context
             if that variable is not defined.
      '1' -- do not play message when first person enters
diff output to internal help in Asterisk 1.2:
8,11c8,11
<   MeetMe([confno][,[options][,pin]]): Enters the user into a specified MeetMe
< conference.  If the conference number is omitted, the user will be prompted
< to enter one.  User can exit the conference by hangup, or if the 'p' option
< is specified, by pressing '#'.
---
>   MeetMe([confno][,[options][,pin]]): Enters the user into a specified MeetMe conference.
> If the conference number is omitted, the user will be prompted to enter
> one. 
> User can exit the conference by hangup, or if the 'p' option is specified, by pressing '#'.
20,21c20,21
<              Default: conf-background.agi  (Note: This does not work with
<              non-Zap channels in the same conference)
---
>              Default: conf-background.agi
>              (Note: This does not work with non-Zap channels in the same conference)
27,30c27,28
<       'i' -- announce user join/leave with review
<       'I' -- announce user join/leave without review
<       'l' -- set listen only mode (Listen only, no talking)
<       'm' -- set initially muted
---
>       'i' -- announce user join/leave
>       'm' -- set monitor only mode (Listen only, no talking)
32,35d29
<       'o' -- set talker optimization - treats talkers who aren't speaking as
<              being muted, meaning (a) No encode is done on transmission and
<              (b) Received audio that is not registered as talking is omitted
<              causing no buildup in background noise
41,42c35
<              meetme-conf-rec-${CONFNO}-${UNIQUEID} and the default format is
<              wav.
---
>              meetme-conf-rec-${CONFNO}-${UNIQUEID} and the default format is wav.
52d44
<       '1' -- do not play message when first person enters