Cisco Cisco TelePresence MCU 4510 Developer's Guide

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

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.

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.

Note: If there is no operationScope parameter, the MCU will attempt to change both active and
configured states. This is deprecated behavior, and should not be relied upon.

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.

string

Unique identifier for the auto attendant.

string

The unique name of a participant.

string

, sip, or vnc.

string

One of: by_address or ad_hoc.

string

Either of the strings activeState or configuredState.

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.

string

Defines preference for motion vs. sharpness. One of
preferMotion

, preferSharpness, balanced, or

.

boolean

if the endpoint uses the

text to identify itself to other

participants.

Cisco TelePresence MCU API 2.10

Page 127 of 296

API commands

participant.modify