Copyright © TANDBERG 2008
Reference Guide Version 3.0 rev 3.0
29
Field
Type
Comments
address String
gatewayAddress String
The address used to connect to the remote
endpoint in question. Only returned when
the address is known (i.e. the participant was
or is to be called out by the MCU, or the
participant is an ad_hoc participant calling in
which provided an address).
ipAddress
String
The IP address to which the MCU is
connected for this endpoint - this will usually
be the endpoint itself, but may be a
gatekeeper or gateway. Only present for
active participants.
displayName
string
The name used by the endpoint to identify
itself. This may be different to the
participantName. Only available after the
participant has connected.
displayNameOverrideStatus
Boolean
Indicates whether the displayName value is
the result of being overridden.
maxBitRateToMCU Integer
maxBitRateFromMCU Integer
As for “participant.add”; in kbps.
motionSharpnessTradeoff String
One
of
default
(if set to the global default
setting),
preferMotion
,
preferSharpness
and
balanced
.
callState String
One
of:
dormant
,
alerting
,
connected
or
disconnected
. When dormant, the
callDirection field is not returned.
connectTime dateTime.iso8601 Only returned after the participant is
connected. This value is always present if the
call state is
connected
. It may or may not be
defined for participants in the
disconnected
state, depending on whether they were ever
connected
disconnectTime dateTime.iso8601 Only returned after the participant has
disconnected
disconnectReason
String
Only returned after the participant has
disconnected; this contains one of the
disconnect reason strings given in section 8
connectPending
Boolean
true if sending a “participant.connect”
command for this participant will cause either
the initial connection to that endpoint (in the
event that it was configured with
“deferConnection” set) or a re-connection to
that endpoint (in the event that it has
disconnected)
audioRxCodec String
audioRxLost Integer
audioRxReceived Integer
audioTxCodec String
audioTxReportedLost Integer
audioTxSent Integer
audioRxMuted Boolean
audioRxGainMode String One
of
fixed
,
none
or
automatic
.
