Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 223
API reference
Cisco TelePresence MCU API 2.9
Page 75 of 223
Input parameters
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
autoAttendantUniqueID
string
Unique identifier for the auto attendant.
participantName
string
The unique name of a participant.
participantProtocol
string
h323sip, or vnc.
participantType
string
One of: by_addressby_name, or ad_hoc.
participant.diagnostics
Returns diagnostic information about a given participant.
Input parameters
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
autoAttendantUniqueID
string
Unique identifier for the auto attendant.
participantName
string
The unique name of a participant.
participantProtocol
string
h323sip, or vnc.
participantType
string
One of: by_addressby_name, or ad_hoc.
Returned data
Parameter name
Type
Short description
videoTxFrameRate
integer
Frame rate of the transmitted video (frames per second).
videoRxFrameRate
integer
The frame rate of the received video (frames per second).
videoRxFramesReceived
integer
The number of video frames received from this endpoint.
videoTxChannelBitRate
integer
The negotiated available bandwidth for the video stream
going to the endpoint.
videoTxSelectedBitRate
integer
The bit rate at which the MCU is attempting to send video to
this endpoint (bits per second). This value may be lower
than videoTxChannelBitRate which is an effective
maximum.
videoTxActualBitRate
integer
The most recently measured bit rate of the outgoing video
stream to this endpoint (bits per second).
videoTxBitRateLimitReason
string
Indicates why the bit rate of the transmitted video stream
was limited by the device. One of notLimited,
viewedSizequalityaggregateBandwidth,
flowControl , or endpointLimitation.