13 participant.connect, 14 participant.disconnect, 15 participant.move – TANDBERG 3.0 User Manual

Page 30: 26 4.14 participant.disconnect, 26 4.15 participant.move

Advertising
background image

Copyright © TANDBERG 2008

Reference Guide Version 3.0 rev 3.0

26

Parameter

Type

Comments

important (optional)

Boolean

This setting should not be present if
operationScope is "configuredState". Specifies
whether this participant is important.

audioTxMuted Boolean

This

setting should not be present if

operationScope is "configuredState".

borderWidth (optional)

Integer

0 (no border), or 1, 2, or 3 for +1/+2/+3.

focusType (optional)

String

One of:

voiceActivated

,

h239

or

participant

.

focusParticipant (optional)

Struct

A participant identification structure (i.e. with
conferenceName, participantName,
participantProtocol and participantType
members). Should only be present if focusType is
participant.


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.

4.13 participant.connect

This method is used primarily for API-configured participants with deferConnection set to true, but can also be
used to reconnect disconnected participants.

Parameter

Type

Comments

conferenceName String
autoAttendantUniqueId String
participantName String
participantProtocol String
participantType String

Participant identification as described above.

4.14 participant.disconnect

Parameter

Type

Comments

conferenceName String
autoAttendantUniqueId String
participantName String
participantProtocol String
participantType String

Participant identification as described above.


This call causes the MCU to tear down its connection to the specified participant, if such a connection exists.

This is different from “participant.remove” above because:

f in the case of configured participants, it does not remove the configuration (thus allowing later re-

connection with “participant.connect”)

f in the case of ad hoc participants, it does not remove the record of the previous connection

4.15 participant.move

This method is used to move a participant from one conference to another.

Parameter

Type

Comments

conferenceName String
autoAttendantUniqueId String
participantName String

Participant identification as described above.

Advertising