Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 223
API reference
Cisco TelePresence MCU API 2.9
Page 44 of 223
layoutControlEnabled
boolean
Deprecated by layoutControlEx. Defines whether the
endpoint's participant will have control over the layout if
layoutControlDefault is false.
conference.paneplacement.modify
Modifies the pane placement for a particular conference.
The panes array contains structures which define the specific panes and their contents. If you do not supply
a particular pane index in the array, then that pane remains unchanged in the layout.
Input parameters
Required inputs
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
Optional or conditional inputs
Parameter name
Type
Short description
enabled
boolean
true if this feature or item is enabled.
Set
true to enable pane placement.
panes
array
An array of structs, each of which defines a particular
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.
type (pane)
string
Defines how the MCU fills the pane. One of default,
blankloudestrollingh239, or participant.
Conditionally required
The following parameters are required to identify the participant if you set
type to participant.
Parameter name
Type
Short description
participantType
string
One of: by_address or ad_hoc.
participantProtocol
string
h323sip, or vnc.
participantName
string
The unique name of a participant.
Returned data
Always returned
Because not all panes are guaranteed to be changed, this call returns the following structure: