Codian MCU 4200 Series User manual

MCU 4200 Series Remote Management API
This specification may be subject to change without notice
Codian Confidential
Version 2.0.1
April 2006

Codian MCU 4200 Series Remote Management API
Contents
Introduction..................................................................................................................................................... 3
1.1 HTTP..........................................................................................................................................3
1.2 XML-RPC ...................................................................................................................................3
1.3 Authentication.............................................................................................................................3
1.4 Message Flow.............................................................................................................................3
2Messages.............................................................................................................................................. 6
Authentication....................................................................................................................................6
2.1 conference.create.......................................................................................................................6
2.2 conference.modify ......................................................................................................................8
2.3 conference.destroy.....................................................................................................................9
2.4 conference.end.........................................................................................................................10
2.5 conference.participant.add .......................................................................................................11
2.6 conference.participant.remove..................................................................................................12
2.7 conference.participant.modify...................................................................................................13
2.8 participant.connect....................................................................................................................13
2.9 participant.disconnect...............................................................................................................14
2.10 device.query.........................................................................................................................14
2.11 participant.enumerate ..........................................................................................................14
2.12 conference.enumerate.........................................................................................................16
2.13 autoAttendant.enumerate ....................................................................................................18
2.14 autoAttendant.destroy..........................................................................................................18
2.15 participant.fecc.....................................................................................................................19
2.16 participant.message.............................................................................................................19
2.17 participant.diagnostics .........................................................................................................19
3Deprecated messages......................................................................................................................... 21
3.1 system.query ............................................................................................................................21
3.2 conference.query......................................................................................................................21
4Required user privileges...................................................................................................................... 23
5Fault Codes......................................................................................................................................... 24
6Participant disconnect reasons............................................................................................................ 25
7References.......................................................................................................................................... 26
Appendix A - Conference Layouts ......................................................................................................... 27
Appendix B - Linking conferences across MCUs................................................................................... 30
B.1 Example message 1 - creating conference "linked1" on "mcu1"...............................................30
B.2 Example message 2 - creating conference "linked2" on "mcu2"...............................................31
B.3 Example message 3 - calling into "linked2" from "linked1" .......................................................31
B.4 Example message 4 - setting the new "linked2" participant to use a full screen view layout....32
B.5 Message responses..................................................................................................................33
Revision History
Version Date Author Comments
1.0 20 Apr 2005 MKL, AP Initial release detailing the API support in version 1.2(1) of
the MCU 4200 series software.
2.0 6 Feb 2006 MKL, AP, AB Draft including the API enhancements to be released in
version 1.4(1) of the MCU 4200 series software.
2.0.1 4 Apr 2006 AP, MKL Corrections and additional information.
Updated Appendix A, removed outdated Appendix B
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 2

Codian MCU 4200 Series Remote Management API
Introduction
The Codian MCU 4200 series products are controllable via messages sent using the XML-RPC
protocol.
Please note that the Management API option key must be loaded before an MCU 4200
series device will respond to API commands.
XML-RPC is a simple protocol for remote procedure calling using HTTP as the transport and XML as the
encoding. It is designed to be as simple as possible, whilst allowing complex data structures to be
transmitted, processed and returned. XML-RPC has no platform or software dependence. XML-RPC
was chosen over SOAP due to its simplicity.
The interface is stateless. Currently there is no mechanism for the Codian MCU to call back the
controlling application and therefore the controlling application must poll the MCU for status as required.
A future enhancement may provide a mechanism for signaling MCU status changes to the controlling
application.
1.1 HTTP
The Codian MCU expects to receive HTTP communication over TCP/IP connections to port 80. The
HTTP messages should be “POST”s to the URL “/RPC2”.
The MCU implements HTTP/1.1 as defined by RFC 2616 [2].
1.2 XML-RPC
For the background and details of XML-RPC, please refer to the specification [1].
In this implementation, all parameters and return values are part of a <struct> and are all explicitly
named. For example, the “device.query” method returns the current time value as a structure member
named ‘currentTime’ rather than as a single value of type <dateTime.iso8601>.
1.3 Authentication
In order to manage the MCU, the controlling application must authenticate itself as a user with
administrator privileges. Accordingly, each message contains a user name and password.
1.4 Message Flow
An application can create and manage conferences by sending command messages to the MCU. For
each command sent, the MCU will respond with a message indicating success or failure. The response
message may also contain data requested.
Command messages are sent in XML format. For example, the following message will schedule a
conference to begin at 10:45 on 18 February 2005 and last for one hour:
POST /RPC2 HTTP/1.1
User-Agent: Frontier/5.1.2 (WinNT)
Host: 10.2.1.100
Content-Type: text/xml
Content-length: 713
<?xml version="1.0"?>
<methodCall>
<methodName>conference.create</methodName>
<params>
<param>
<value>
<struct>
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 3

Codian MCU 4200 Series Remote Management API
<member>
<name>authenticationUser</name>
<value>
<string>api_test</string>
</value>
</member>
<member>
<name>authenticationPassword</name>
<value>
<string>123456</string>
</value>
</member>
<member>
<name>conferenceName</name>
<value>
<string>Meeting 1</string>
</value>
</member>
<member>
<name>startTime</name>
<value>
<dateTime.iso8601>20050218T10:45:00</dateTime.iso8601>
</value>
</member>
<member>
<name>durationSeconds</name>
<value>
<int>3600</int>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodCall>
If the command was successful, the MCU will send a success response. For example, in response to a
successful conference.create message, the MCU will return:
HTTP/1.1 200 OK
Connection: close
Content-Type: text/xml
Content-Length: 240
<?xml version="1.0"?>
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>status</name>
<value>
<string>operation successful</string>
</value>
</member>
</struct>
</value>
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 4

Codian MCU 4200 Series Remote Management API
</param>
</params>
</methodResponse>
If the command fails, the MCU will send a fault response. For example, in response to a
“conference.create” message where the conference name is not unique, the MCU will return:
HTTP/1.1 200 OK
Connection: close
Content-Type: text/xml
Content-Length: 411
<?xml version="1.0"?>
<methodResponse>
<fault>
<value>
<struct>
<member>
<name>faultCode</name>
<value>
<int>2</int>
</value>
</member>
<member>
<name>faultString</name>
<value>
<string>duplicate conference name</string>
</value>
</member>
</struct>
</value>
</fault>
</methodResponse>
The complete list of command messages, their required and optional parameters, and the expected
responses are detailed in section 2. The possible fault codes are listed in section 5. Appendix B
contains examples of some messages and their corresponding responses.
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 5

Codian MCU 4200 Series Remote Management API
2Messages
Authentication
All messages must contain a user name and password as follows:
Parameter Type Comments
authenticationUser string Name of a user with sufficient privilege for the operation being
performed. The name is case sensitive.
authenticationPassword string The corresponding user’s password.
Participant identification parameters
The following parameters appear in the majority of messages, and are used to identify a specific
participant on which operations are to be performed.
Parameter Type Description
participantName string This is an “internal” name, and hence not necessarily related to any
name configured on an endpoint itself. Within the scope of a
particular conference or auto attendant, the combination of
“participantType”, “participantProtocol” and “participantName” is
always unique.
participantProtocol string
participantType string
Used in conjunction with “participantName” to uniquely identify a
participant within a connection. Typically these should be treated as
opaque values, but the current possibilities are:
for “participantProtocol”:
h323 – the H.323 protocol
vnc – a VNC connection (e.g. remote desktop)
for “participantType”:
ad_hoc – this participant called into the MCU
by_address – fully-specified participant
by_name – MCU-configured endpoint
API-created participants (i.e. those originated by
“conference.participant.add”) will be of type “by_address”.
conferenceName string Unique conference name – the conference name space is shared
between API-generated conferences and all other ad hoc and
scheduled MCU conferences.
autoAttendantUniqueId string If the participant in question is connected to an auto attendant rather
than a conference, this field contains a unique identifier for that auto
attendant.
When modifying or querying parameters for a specific endpoint, “participantName”, “participantProtocol”
and “participantType” parameters are supplied, along with either a “conferenceName” or an
“autoAttendantUniqueId”. However, as the API can only create H.323 participants of type “by_address”,
if the protocol and type fields are absent then they are assumed to be “h323” and “by_address”.
2.1 conference.create
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 6

Codian MCU 4200 Series Remote Management API
Parameter Type Comments
conferenceName string (<32 chars) Name of the conference to be created. The
conference creation will fail if the name is not
unique.
numericId (optional) string (<32 chars) Numeric identifier of the conference
conferenceId string (< 32 chars) Deprecated alternative for “numericId”
registerWithGatekeeper (optional) boolean Register the conference’s “numericId” with the
gatekeeper
startTime (optional) dateTime.iso8601 If you do not specify a time the conference will
start immediately
durationSeconds (optional) int The length of each repeating conference
instance, in seconds. If this parameter is absent,
or set to “0”, the conference is permanent.
endTime (optional) dateTime.iso8601 If you do not specify an end time then the
conference will be permanent (except if it is
explicitly deleted).
This parameter is deprecated and present for
backward compatibility reasons only.
Application code should use
“durationSeconds” in preference.
pin (optional) string (< 32 chars) If present, this is the string of numeric digits that
people need to enter to join the conference.
description(optional) string (< 32 chars)
multicastStreamingEnabled(optional) boolean
unicastStreamingEnabled(optional) boolean
h239Enabled(optional) boolean
maximumAudioPorts int
maximumVideoPorts int
reservedAudioPorts int
reservedVideoPorts int
These fields set the limit on number of audio
(audio only) and video (video + audio) ports for
the conference. The “reserved” values are for
port reservation mode, whereas the “maximum”
figures apply to non-reserved mode (and will be
absent if no limits have been configured).
repetition(optional) string one of:
none
daily
weekly
everyTwoWeeks
monthly
weekDay(optional) string Must be present if repetition is “monthly”; one of:
monday
tuesday
wednesday
thursday
friday
saturday
sunday
whichWeek(optional) string Must be present if repetition is “monthly”; one of:
first = first X of the month (where X is the day
specified by weekday)
second
third
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 7

Codian MCU 4200 Series Remote Management API
fourth
last = last X of the month
weekDays(optional) string Must be present if repetition is “weekly” or
“everyTwoWeeks”; a comma separated string of
weekdays from the following list:
monday
tuesday
wednesday
thursday
friday
saturday
sunday
eg. “monday,Wednesday,friday”
terminationType (optional) string one of:
noTermination
afterNRepeats
endOnGivenDate
terminationDate (optional) dateTime.iso8601 if terminationType is endOnGivenDate this is the
day the conference repetition will end on
numberOfRepeats (optional) int if terminationType is afterNRepeats this is the
number of repeats to end after
Conferences created through the management API will appear in the list of conferences accessible via
the Web interface, and vice versa.
2.2 conference.modify
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 8

Codian MCU 4200 Series Remote Management API
Parameter Type Comments
conferenceName string (< 32 chars) Name of the conference to modify
newConferenceName (optional) string (< 32 chars) If present, conference will be renamed to
specified value
oldConferenceName string (<32 chars)
conferenceName string (<32 chars)
Deprecated conference renaming scheme –
new code should use conferenceName and
newConferenceName as above.
numericId string (< 32 chars)
conferenceId (deprecated)
registerWithGatekeeper boolean
startTime dateTime.iso8601
durationSeconds int
endTime dateTime.iso8601
pin string
description string
multicastStreamingEnabled boolean
unicastStreamingEnabled boolean
h239Enabled boolean
reservedVideoPorts int
reservedAudioPorts int
maximumVideoPorts int
maximumAudioPorts int
repetition string
weekDay string
whichWeek string
weekDays string
terminationType string
terminationDate dateTime.iso8601
numberOfRepeats int
Optional fields as per “conference.create”
described above
Conferences created through the management API will appear in the list of conferences accessible via
the Web interface. The API can thus be used to modify conferences scheduled via the web interface,
and vice versa.
2.3 conference.destroy
Parameter Type Comments
conferenceName string Name of the conference to be destroyed.
A conference can be destroyed at any time; that is, before the conference has begun, during the
conference or after the conference has ended.
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 9

Codian MCU 4200 Series Remote Management API
2.4 conference.end
Parameter Type Comments
conferenceName string Name of the conference to be ended.
A conference will remain in the list of conferences even after the conference has ended until
conference.destroy is called.
The intent is that this message performs the same function as the “End conference” control on
the MCU web interface. However, it is not currently implemented in any shipping version of
Codian MCU 4200 series software.
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 10

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

Codian MCU 4200 Series Remote Management API
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.
If a “participantName” matches the name of an endpoint in the list of configured endpoints (via the Web
interface, Home > Endpoint list) the two are treated as unrelated. This is because web interface named,
configured, endpoints have the “participantType” value “by_name” whereas API participants are of type
“by_address”.
2.6 conference.participant.remove
Parameter Type Comments
conferenceName string
autoAttendantUniqueId string
participantName string
participantProtocol string
participantType string
Participant identification as described above.
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 12

Codian MCU 4200 Series Remote Management API
2.7 conference.participant.modify
Parameter Type Comments
conferenceName string
autoAttendantUniqueId string
participantName string
participantProtocol string
participantType string
Participant identification as described above.
address string
gatewayAddress string
deferConnection boolean
maxBitRateToMCU int
maxBitRateFromMCU int
These parameters override the configured values, but
have no effect on active participants.
displayNameOverrideStatus boolean
displayNameOverrideValue string
cpLayout string
layoutControlEnabled boolean
audioRxMuted boolean
audioRxGainMode string
audioRxGainMillidB int
videoRxMuted boolean
videoTxWidescreen boolean
videoTxMaxResolution string
videoRxMaxResolution string
All of these parameters are optional, and override /
change the values provided in the
“conference.participant.add” call. As well as changing
configured participant parameters, they also change
active participant state, and so may have real-time
effect.
important (optional) boolean Specifies whether this participant is important. This
setting only has an effect on active participants.
This method affects active conference participation as well as endpoint configuration. If the conference
has not yet started, this operation effectively just changes the configured parameters as passed in
“conference.participant.add”. If the conference has started and the participant is connected, this method
will change participants’ layouts and audio mute status in real-time.
2.8 participant.connect
Parameter Type Comments
conferenceName string
autoAttendantUniqueId string
participantName string
participantProtocol string
participantType string
Participant identification as described above.
Used primarily for API-generated participants added with “deferConnection” set to true; this command
causes the MCU to call out to such participants.
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 13

Codian MCU 4200 Series Remote Management API
2.9 participant.disconnect
Parameter Type Comments
conferenceName string
autoAttendantUniqueId string
participantName string
participantProtocol string
participantType string
Participant identification as described above.
This call causes the MCU to tear down its connection to the specified participant, if such a connection
exists. This is different from “participant.remove” above because in the case of configured participants it
does not remove the configuration (thus allowing later re-connection with “participant.connect”) and in
the case of ad hoc participants it does not remove the record of the previous connection.
2.10 device.query
There are no parameters passed with this method call. The method response returns the following:
Parameter Type Comments
currentTime dateTime.iso8601 The system’s current time.
restartTime dateTime.iso8601 The date and time at which the system was last restarted.
2.11 participant.enumerate
Parameter Type Comments
enumerateID(optional) string The value returned by the last enumeration call, if omitted a
new enumeration is started.
returns:
Response Type Comments
enumerateID(optional) string The value which should be used in the next call to get the
next set of data
and an array called “participants” of structs which contain
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 14

Codian MCU 4200 Series Remote Management API
Response Type Comments
participantName string
participantProtocol string
participantType string
conferenceName string
autoAttendantUniqueId string
Participant identification as described above.
address string
gatewayAddress string
The address used to connect to the remote endpoint in
question. Only returned when the address is known, or
if the participant is configured via the API (which
requires the address to be specified when added).
deferConnection boolean
displayName string The name used by the endpoint to identify itself. This
may be different to the participantName. Only available
after the participant has connected.
displayNameOverrideStatus boolean Indicates whether the displayName value is the result
of being overridden
maxBitRateToMCU int
maxBitRateFromMCU int As for “participant.add”; kbps values
videoRxMaxResolution string
videoTxMaxResolution string As for “participant.add”; “cif”, “4cif” or “max”
callState string The value will be one of:
- ‘dormant’
- ‘alerting’
- ‘connected’
- ‘disconnected’
connectTime dateTime.iso8601 Only returned once the participant is connected. This
value is always present if the call state is “connected”;
it may or may not be defined for participants in the
“disconnected” state, depending on whether they were
ever connected.
disconnectTime dateTime.iso8601 Only returned after the participant has disconnected
disconnectReason string Only returned after the participant has disconnected,
one of the disconnect reason values given in table 5.
connectPending boolean true if sending a “participant.connect” command for this
participant will cause either the initial connection to that
endpoint (in the event that it was configured with
“deferConnection” set) or a re-connection to that
endpoint (in the event that it has disconnected).
audioRxCodec string
audioRxLost int
audioRxReceived int
audioTxCodec string
audioTxReportedLost int
audioTxSent int
audioRxMuted boolean
audioRxGainMode string
audioRxGainMillidB int
videoRxCodec string
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 15

Codian MCU 4200 Series Remote Management API
videoRxLost int
videoRxReceived int
videoTxCodec string
videoTxReportedLost int
videoTxSent int
videoRxMuted boolean
videoTxWidescreen boolean
important boolean
activeSpeaker boolean true if this participant is currently the active speaker in
the conference
layoutControlEnabled boolean
cpLayout string The configured layout behavior for this participant - see
appendix A. This parameter will be present only for
participants configured via the API.
currentLayout int Actual layout in use for the video stream being sent by
the MCU to this participant. This parameter will not be
present if the participant is in an auto attendant rather
than a conference, nor if the MCU is not
currentlytransmitting video to the participant in
question.
callDirection string one of:
incoming
outgoing
Note: This participant information is returned for all participants added to the conference using the
conference.participant.add method, even after they have disconnected. However, this information is only
returned for other participants (i.e. those added via the Web interface or those who dialed into the
conference) whilst they are connected but not after they have disconnected.
2.12 conference.enumerate
Parameter Type Comments
enumerateID (optional) string The value returned by the last enumeration call, if omitted a
new enumeration is started.
returns:
Response Type Comments
enumerateID (optional) string The value which should be used in the next call to get the
next set of data
and an array called “conferences” of structs which contain:
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 16

Codian MCU 4200 Series Remote Management API
Response Type Comments
conferenceName string
conferenceType string one of:
scheduled
ad_hoc
conferenceActive boolean indicates whether conference is currently active
description string extra user-specified information about the conference
pin string the security PIN
numericId string
registerWithGatekeeper boolean
multicastStreamingEnabled boolean
unicastStreamingEnabled boolean
h239Enabled boolean
maximumAudioPorts int
maximumVideoPorts int
reservedAudioPorts int
reservedVideoPorts int
These fields set the limit on number of audio (audio
only) and video (video + audio) ports for the
conference. The “reserved” values are for port
reservation mode, whereas the “maximum” figures
apply to non-reserved mode (and will be absent if no
limits have been configured).
The following timing fields will be present for scheduled conferences only
startTime dateTime.iso8601 The time at which the conference started at or will start
at.
durationSeconds int How long each repeating instance of the conference
should last for – if absent, the conference is permanent.
repetition(optional) string one of:
none
daily
weekly
everyTwoWeeks
monthly
weekDay(optional) string Must be present if repetition is monthly.
One of:
monday
tuesday
wednesday
thursday
friday
saturday
Sunday
whichWeek (optional) string Must be present if repetition is monthly
one of:
first = first X of the month (where X is the day specified
by weekday)
second
third
fourth
last = last X of the month
weekDays (optional) string A comma separated string of weekdays from the
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 17

Codian MCU 4200 Series Remote Management API
following list:
monday
tuesday
wednesday
thursday
friday
saturday
sunday
eg. “monday,wednesday,friday” This field should be
provided when repetition is weekly or everyTwoWeeks
terminationType(optional) string one of:
noTermination
afterNRepeats
endOnGivenDate
terminationDate(optional) dateTime.iso8601 if terminationType is endOnGivenDay this is the day the
conference repetition will end on
The following timing values will be present for active conferences only
activeStartTime dateTime.iso8601
activeEndTime dateTime.iso8601
If the conference is currently active, these fields show
the time span of the current activation. If the conference
is permanent then “activeEndTime” will be absent.
2.13 autoAttendant.enumerate
Parameter Type Comments
enumerateID(optional) string The value returned by the last enumeration call, if omitted a
new enumeration is started.
returns:
Response Type Comments
enumerateID(optional) string The value which should be used in the next call to get the
next set of data
and an array called “autoAttendants” of structs which contain:
Response Type Comments
autoAttendantUniqueID string
startTime dateTime.iso8601 The time at which the auto attendant was created.
2.14 autoAttendant.destroy
Parameter Type Comments
autoAttendantUniqueID string Identifier for the auto attendant to be destroyed.
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 18

Codian MCU 4200 Series Remote Management API
2.15 participant.fecc
Parameter Type Comments
conferenceName string
autoAttendantUniqueId string
participantName string
participantProtocol string
participantType string
Participant identification as described above
direction string one of:
up
down
left
right
2.16 participant.message
Parameter Type Comments
conferenceName string
autoAttendantUniqueId string
participantName string
participantProtocol string
participantType string
Participant identification as described above
message string The string to send to the participant
2.17 participant.diagnostics
Parameter Type Comments
conferenceName string
autoAttendantUniqueId string
participantName string
participantProtocol string
participantType string
Participant identification as described above
The method response returns the following:
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 19

Codian MCU 4200 Series Remote Management API
Parameter Type Comments
videoTxFrameRate int
videoRxFrameRate int
videoRxFramesReceived int
videoTxChannelBitRate int
videoTxSelectedBitRate int
videoTxActualBitRate int
videoTxLimitReason string one of:
notLimited,
viewedSize,
quality,
aggregateBandwidth,
flowControl,
endpointLimitation,
videoRxChannelBitRate int
videoRxSelectedBitRate int
videoRxActualBitRate int
videoRxLimitReason string one of:
notLimited,
viewedSize,
quality,
aggregateBandwidth,
flowControl,
endpointLimitation,
videoTxWidth int
videoTxHeight int
videoTxInterlaced boolean
videoRxWidth int
videoRxHeight Int
videoRxInterlaced boolean
Copyright © Codian Ltd. 2004 - 2006 Codian Confidential Page 20