Copyright © TANDBERG 2008
Reference Guide Version 3.0 rev 3.0
25
4.12
participant.modify
Depending on the operationScope parameter below, this call modifies the configuration of a participant
(configuredState), or the active state of a participant in a conference (activeState).
For example, if the parameter layoutControlEnabled is included in a call to participant.modify, then the effect
of the call will depend on operation scope as follows:
•
If operationScope is
activeState
, the active participant’s ability to control their layout will
immediately change, but the configured value will remain unchanged, so that if they were to
reconnect later, the state of layoutControlEnabled would revert back to how it is in the configuration.
•
If operationScope is
configuredState,
the participant’s current ability to control their layout will be
unaffected, but their configuration will be changed so that in future occurrences of the conference (or
when the participant is reconnected) they will have the newly configured state.
Parameter
Type
Comments
conferenceName String
autoAttendantUniqueId String
participantName String
participantProtocol String
participantType String
Participant identification as described above.
operationScope String One
of
activeState
or
configuredState
. This
parameter specifies the scope of the changes to be
made, be they to the configured state of an
endpoint, or to the active state of a participant in a
conference.
address String
gatewayAddress String
useSipRegistrar Boolean
transportProtocol String
password String
deferConnection Boolean
autoConnect Boolean
linkType String
maxBitRateToMCU Integer
maxBitRateFromMCU Integer
All these parameters are optional. They should not
be present if operationScope is
activeState
.
These parameters override the configured values.
motionSharpnessTradeoff
(optional)
String One
of
default
(if set to the global default
setting),
preferMotion
,
preferSharpness
and
balanced
.
Optional, and valid for both
configuredState
and
activeState
scopes.
displayNameOverrideStatus Boolean
displayNameOverrideValue String
cpLayout String
layoutControlEnabled Boolean
audioRxMuted Boolean
audioRxGainMode String
audioRxGainMillidB Integer
videoRxMuted Boolean
videoTxWidescreen Boolean
autoDisconnect Boolean
suppressDtmf Boolean
All of these parameters are optional, and override
/ change the values provided in the
“participant.add” call. Depending on the value of
the operationScope parameter, these either, if
configuredState
, change the stored
configuration of a participant, or, if
activeState
,
change the active participant state, resulting in
real-time changes to that participant.
