Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 120
API reference 
Cisco TelePresence MCU API 2.8 
Page 38 of 120
 
Parameter 
Type 
Comments 
conferenceName 
String 
Name of the conference to be ended. 
conference.enumerate 
Returns some or all conferences scheduled, running or completed on the MCU. 
This call returns an error if both maximumVideoPorts and maximumAudioPorts are set to 0 or if 
the total number of ports exceeds the maximum conference size (currently 80). The maximum 
conference size check is also performed for reserved ports. 
 
Parameter 
Type 
Comments 
enumerateID (optional)  String 
The value returned by the last enumeration call. If it 
is omitted, a new enumeration is started. 
enumerateFilter 
String 
A filter expression. 
moreThanFour 
(optional) 
Boolean 
Enables the call to return more than four 
conferences (up to 24). 
 
Valid expressions within the enumerate filter are as follows: 
Expression 
Type 
Comments 
active 
Boolean 
True if the conference is active. 
completed 
Boolean 
True if the conference has finished. 
scheduled 
Boolean 
True if the conference is a scheduled conference 
(regardless of if it has been completed or not). 
 
This call returns: 
Response 
Type 
Comments 
enumerateID 
(optional) 
String 
The value which should be used in the next call to get 
the next set of data. If this is omitted, no further data is 
available from the MCU. 
conferences 
Array 
See below for details. 
joinAudioMuted 
Boolean 
Audio mute on join. 
joinVideoMuted 
Boolean 
Video mute on join. 
layoutControlEnabled  Boolean 
Layout control via FECC/DTMF.