Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 120
API reference 
Cisco TelePresence MCU API 2.8 
Page 52 of 120
 
Optional parameters 
participantType  
String 
Participant identification. Only required if type is 
participant, these identify a specific participant. 
participantProtocol  
String 
participantName  
String 
 
Because not all panes are guaranteed to be changed, this call returns the following structure: 
Response 
Type 
Comments 
panesModified 
Integer 
The number of panes successfully modified. This will 
be the number of elements in the panes array on 
complete success, and zero if there is no panes array. 
conference.paneplacement.query 
Queries the current pane placement configuration.  
Parameter 
Type 
Comments 
conferenceName 
String 
The name of the conference to be queried. 
This returns a struct containing the following response fields: 
Response 
Type 
Comments 
enabled 
Boolean 
true if pane placement is enabled and in use; false 
otherwise. 
Optional parameters
 
panes (optional) 
Array 
This is only present if enabled above is true. The 
struct definition is as below. 
The panes array contains structures with the following format: 
Field 
Type 
Comments 
type 
String 
Any one of:  
default - the default behaviour 
blank - a blank window 
loudest - the current loudest speaker 
rolling – shows a sequence of conference 
participants, changing according to the 
configured rolling interval 
h239 - the h239 content channel 
participant - a participant as identified below. 
index 
Integer 
The index of this pane.