Cisco Cisco TelePresence MCU 4510 Developer's Guide
API reference
Cisco TelePresence MCU API 2.9
Page 90 of 223
participant.modify
Depending on the
operationScope parameter, 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 the operation scope as follows:
n
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.
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.
n
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.
the participant is reconnected) they will have the newly configured state.
Note: If there is no
operationScope parameter, the MCU will attempt to change both active and configured
states. This is deprecated behaviour, and should not be relied upon.
Input parameters
Required inputs
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
If the participant is in a conference, the call requires the
conferenceName; if the participant is in an
autoattendant, the call requires the
autoAttendantUniqueId instead. The call does not require both
parameters.
autoAttendantUniqueID
string
Unique identifier for the auto attendant.
participantName
string
The unique name of a participant.
participantProtocol
string
h323, sip, or vnc.
participantType
string
One of: by_address or ad_hoc.
operationScope
string
Either of the strings activeState or configuredState.
Optional or conditional inputs (for either/both states)
You may provide the following parameters, irrespective of the
operationScope. The call will then attempt to
modify the participant's parameters in the state(s) you provide in
operationScope.
Parameter name
Type
Short description
motionSharpnessTradeoff
string
Defines preference for motion vs. sharpness. One of
preferMotion, preferSharpness, balanced, or
default.
preferMotion, preferSharpness, balanced, or
default.
displayNameOverrideStatus
boolean
true if the endpoint uses the
displayNameOverrideValue text to identify itself to other
participants.
displayNameOverrideValue text to identify itself to other
participants.