TANDBERG 3.0 - Manual (Page 28)

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 24
Parameter Type Comments
form suitable for a widescreen (16:9) display.
videoTxMaxResolution String One of:
cif
,
4cif
or
max
.
videoRxMaxResolution String Same as above.
autoConnect Boolean If this is true and a participant whose e164, dns, or
IP address matches this participant’s address dials
into the MCU, it will be moved directly to this
conference. In order to stop the MCU dialing out
to the participant, as the conference starts, use
deferConnection.
autoDisconnect Boolean When set to true, the participant will be
disconnected from the conference if another
participant disconnects and only participants
configured to be automatically disconnected remain
in the conference.
borderWidth Integer 0 (no border), or 1, 2, or 3 for +1/+2/+3.
suppressDtmf Boolean Whether inband DTMF tones should be suppressed
(removed) from the audio stream being received
from this participant.
linkType String Currently, must be one of:
cascadeSlaveToMaster
or
default
. (Currently
this is only taken note of if participantType is
by_address).
All participants in a conference must have a “participantName” that is unique to the conference but it need not
be unique across all conferences.
Participants can be added before or during a conference. A participant which is added at any time via the API
will be added to the configured list of participants, and thus will be called at the start of the conference by the
MCU for any conference which has any sort of repetition; to avoid this, a participant must be removed directly
using participant.remove.
Note: If a “participantName” matches the name of an endpoint in the list of configured endpoints (via the web
interface, go to
Endpoints
) the two are treated as unrelated. This is because in the web interface named,
configured, endpoints have the “participantType” value
by_name
, whereas API participants are of type
by_address
.
4.11 participant.remove
This call removes a participant from the database of configured participants, and also removes this participant
from any conferences. It will also remove all records of this participant's presence in a conference.
Parameter Type Comments
conferenceName String
autoAttendantUniqueId String
participantName String
participantProtocol String
participantType String Participant identification as described above.