Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 223
API reference
Cisco TelePresence MCU API 2.9
Page 38 of 223
floorStatus
string
One of
inactive or assign. If you set floorStatus to
assign you must provide a floorParticipant struct.
Optional or conditional inputs
Parameter name
Type
Short description
floorParticipant
struct
A structure that identifies which participant has the floor.
participantName
string
The unique name of a participant.
participantProtocol
string
h323sip, or vnc.
participantType
string
One of: by_address or ad_hoc.
Returned data
No data. Success or fault message only.
conference.floor.query
This call queries the status of the conference floor control.
Input parameters
Required inputs
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
Returned data
Always returned
Parameter name
Type
Short description
enabled
boolean
true if this feature or item is enabled.
floorStatus
string
One of
inactiveactive, or assigned. If it is active or
assigned, a floorParticipant struct will be included in
the response.
Conditionally returned
If
floorStatus is not inactive, then the response includes a struct to identify which participant 'has the
floor'.
Parameter name
Type
Short description
floorParticipant
struct
A structure that identifies which participant has the floor.
participantName
string
The unique name of a participant.