Codian MCU 4200 Series Remote Management API
2.5 conference.participant.add
Parameter Type Comments
conferenceName string The name of the conference to which to add the
participant.
participantName string (<32 chars) The name of the participant to be added. This must be a
unique value, i.e. not the same as any existing participant.
participantProtocol
(optional)
string If present, must be “h323” – this is the only protocol that
the API can currently use.
participantType (optional) string If present, must be “by_address”.
address string (< 32 chars) The participant’s E.164 directory number, hostname or IP
address.
gatewayAddress (optional) string (< 32 chars) IP address or hostname of an H.323 gateway
deferConnection
(optional)
boolean If true, means don’t call out to this participant immediately,
but wait for a “[conference.]participant.connect”
command.
All of the following parameters are optional, and control the conferencing behaviour of the MCU with respect
to the endpoint in question, for example the maximum resolution of the video streams used, or whether the
participant is able to control the conference view layout that they see.
maxBitRateToMCU int The maximum bit rate to the MCU specified as kBit/s
maxBitRateFromMCU int The maximum bit rate from the MCU specified as kBit/s
displayNameOverrideStatus Boolean If true, means use the specified
“displayNameOverrideValue” text as the participant’s
display name during the conference.
displayNameOverrideValue string (< 32 chars) Value to use as the participant’s display name (if
“displayNameOverrideStatus” set to true).
cpLayout string This sets the initial conference view layout for video sent
to this participant. Refer to Appendix A for the full list of
available layouts.
layoutControlEnabled boolean Controls whether this participant is able to change the
conference view layout that they see; 1 (true) means that
the participant can change the layout using FECC or
DTMF, 0 (false) means that they cannot.
audioRxMuted boolean 1 (true) means that audio from this participant will not be
heard by other conference participants.
audioRxGainMode string one of:
none – no extra gain applied
automatic – automatic gain control applied
fixed – fixed number of dBs of gain applied
audioRxGainMillidB int if audio gain mode “fixed”, this is the number of decibels
of gain applied, multiplied by 1000, and can be a negative
value
videoRxMuted boolean true means that video from this participant will not be
seen by other conference participants
videoTxWidescreen boolean if true, means that video sent to this participant will be in a
form suitable for a widescreen (16:9) display
videoTxMaxResolution string one of:
cif
4cif
max
videoRxMaxResolution string same as above
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 11
Manymanuals.com
Manymanuals.de
Manymanuals.fr
Manymanuals.it
Manymanuals.pl
Manymanuals.cz
Manymanuals.es
Manymanuals-pt.com
Commenti su questo manuale