Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 223
API reference
Cisco TelePresence MCU API 2.9
Page 71 of 223
Input parameters
Optional or conditional inputs
Parameter name
Type
Short description
enumerateID
string
The device returns this index if the requested data is too
large for one response. Pass this parameter in a repeat of
the call to return the next batch of data.
Returned data
If there are entries to return, the method returns them in an array. If there are more entries than can be
returned in one response, you'll get the next enumerateID up from the one you provided.
Parameter name
Type
Short description
enumerateID
string
The device returns this index if the requested data is too
large for one response. Pass this parameter in a repeat of
the call to return the next batch of data.
gateways
array
A collection of structures, each of which describes a
gateway.
name (gateway)
string
The name of the gateway.
address (gateway)
string (63) The address of the gateway.
conferencingParameters
struct
A structure containing the conferencing parameters of
the enumerated item, e.g. gateway or endpoint.
useDefaultMotionSharpness
boolean
true means this endpoint will use box-wide default
motion sharpness settings.
minFrameRateMotionSharpness
integer
Specifies the minimum frame rate for this endpoint.
This parameter is only present if
useDefaultMotionSharpness is false.
maxMediaTxBitRate
integer
The maximum media transmission speed from this
device, in kbps. means the device uses the default.
maxMediaRxBitRate
integer
The maximum media reception speed of this device,
in kbps. means the device uses the default.
participant.add
Adds a participant to a conference. All participants in a conference must have a
participantName that is
unique to the conference but it need not be unique across all conferences. Add the participant as type
by_
address unless you are adding the participant to an ad hoc conference.
Send the
addResponse parameter if you want the call to return the details of the added participant (in a
participant struct.)