TANDBERG 3.0 - Manual (Page 31)

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 27
Parameter Type Comments
participantProtocol String
participantType String
newConferenceName
String The name of the conference to move the participant to.
This will only move an active participant. Even if this participant is preconfigured, the configuration is
unchanged.
A fault code of "no such participant" is returned if the participant is not moved or does not exist.
4.16 participant.enumerate
This method is used to return data about participants in conferences on the MCU. Several calls may be
required to receive data about all participants; see the notes on enumerateID below.
Parameter Type Comments
enumerateFilter
(optional) String An enumerate filter string.
enumerateID(optional) String The value returned by the last enumeration call. If
this parameter is omitted, a new enumeration is
started.
operationScope array of strings This should contain none, either or both of
currentState
or
configuredState
. If
currentState
is present, the active configuration of
each participant is returned by the MCU in the
currentState structure. If
configuredState
is
present, the stored configuration is returned in the
configuredState structure
Valid expressions within the enumerate filter are as follows:
Expression Type Comments
connected Boolean True if the participant is currently connected to a
conference.
disconnected Boolean True if the participant has been connected to a
conference, but is now disconnected.
Note that a participant that has not yet connected to a conference (e.g. they have deferred connection
specified) is neither connected nor disconnected.
This method returns:
Response Type Comments
enumerateID (optional) String The value which should be used in the next call to
get the next set of data. If this is not present, there
is no further data available from the MCU.
participants array of structs See below for contents.
and an array called “participants” of structs which contain:
Field Type Comments
participantName string
participantProtocol String
Participant identification as described above.