Cisco Cisco TelePresence MCU 4510 Developer's Guide
conference.paneplacement.query
Queries the current pane placement configuration. Returns whether pane placement is enabled and, if so, an
array of panes detailing the current pane placement.
array of panes detailing the current pane placement.
Input parameters
Required inputs
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
Returned data
The response contains the enabled parameter and the panes array. If enabled is true, the panes array
contains a struct for each placed pane. The array is returned empty if pane placement is disabled.
contains a struct for each placed pane. The array is returned empty if pane placement is disabled.
Always returned
Parameter name
Type
Short description
enabled
boolean
true
if this feature or item is enabled.
panes
array
An array of structs, each of which defines a particular
pane within the layout.
pane within the layout.
Conditionally returned
The panes array contains data if pane placement is enabled. The number of panes in the array corresponds
with the number of panes in the current conference custom layout:
with the number of panes in the current conference custom layout:
Parameter name
Type
Short description
panes
array
An array of structs, each of which defines a particular
pane within the layout.
pane within the layout.
index (pane)
integer
A number that identifies the pane with respect to other
panes. A value between 0 and 19, where lower numbers
are generally more prominent in the layout.
panes. A value between 0 and 19, where lower numbers
are generally more prominent in the layout.
type (pane)
string
Defines how the MCU fills the pane. One of default,
blank
blank
, loudest, rolling, h239, or participant.
The following are also returned if the pane type is participant:
participantName
string
The unique name of a participant.
participantProtocol
string
h323
, sip, or vnc.
participantType
string
One of: by_address, by_name, or ad_hoc.
Cisco TelePresence MCU API 2.10
Page 63 of 296
API commands
conference.paneplacement.query