Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 120
API reference 
Cisco TelePresence MCU API 2.8 
Page 75 of 120
 
participants array members 
The members of the participants array contain the following structures: 
Field 
Type 
Comments 
participantName 
string  
Participant identification as described above. 
participantProtocol 
String 
participantType 
String 
conferenceName 
String 
autoAttendantUniqueId 
String 
connectionUniqueId 
Integer 
Corresponds to the uniqueId returned by a 
conference or autoattendant. 
Optional parameters 
currentState  
Array 
The current state of the participant as used 
by the MCU. Details of this struct are given 
below. This is only present if requested in 
the operationScope 
configuredState  
Array 
The stored configuration of the participant, if 
any. Details of this struct are given below. 
This is only present if requested in the 
operationScope 
If the endpoint is not configured, the configuredState structure is empty; otherwise the 
configuredState structure contains the following entries: 
Field 
Type 
Comments 
address 
String 
The address used to connect to the remote 
endpoint in question. Only returned when 
the address is known. 
gatewayAddress 
String 
useSipRegistrar 
Boolean 
Whether to use a registrar in making this a 
call. 
transportProtocol 
String 
One of: default, tcp, udp or tls. 
password 
String 
The password for vnc endpoints. 
deferConnection 
Boolean 
true if this participant's connection is being 
deferred. 
displayNameOverrideStatus 
Boolean 
Indicates whether the displayName value is 
the result of being overridden. 
maxBitRateToMCU 
Integer 
As for “participant.add”; in kbps.