TANDBERG 3.0 - Manual (Page 9)

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 5
2.4.2 Participant identification parameters
The following parameters appear in the majority of conference control messages, and identify a specific
participant on which operations are to be performed. The use of “MCU” below refers to any device which acts
as a videoconferencing server.
Parameter
Type Description
participantName String This is an “internal” name, and therefore is not necessarily
related to any name configured on an endpoint. Within the
scope of a particular conference or auto attendant, the
combination of “participantType”, “participantProtocol” and
“participantName” is always unique
participantProtocol String
participantType String Used in conjunction with “participantName” to uniquely
identify a participant within a connection. Typically, these
parameters should be treated as opaque values, but the current
possibilities are:
- for “participantProtocol”:
h323
– an endpoint using the H.323 protocol
vnc
– a VNC connection (e.g. remote desktop)
sip
– an endpoint using the SIP protocol.
- for “participantType”:
ad_hoc
– this participant called into the MCU or was
dialed out via the web interface and is not in the
MCU’s endpoint list
by_address
– fully-specified participant added through
the API
by_name
– MCU-configured endpoint irrespective of
whether the endpoint dialed in or the MCU dialed out
API-created participants in scheduled conferences (i.e. those
originated by “participant.add”) will be of type
by_address
(unless they're added explicitly as temporary
ad_hoc
participants.)
conferenceName String Unique conference name – the conference name space is shared
between API-generated conferences and all other ad hoc and
scheduled MCU conferences.
autoAttendantUniqueId String If the participant in question is connected to an auto attendant
rather than a conference, this field contains a unique identifier
for that auto attendant.
When modifying or querying parameters for a specific endpoint, participantName, participantProtocol
and participantType parameters are supplied, along with either a conferenceName or an
autoAttendantUniqueId. The only safe way to find these values is to use the fields returned from
participant.enumerate.
2.4.3 Enumerate functions
Due to the potential for a very large number of responses, all enumerate functions return an enumerateID
response. This contains a string value which should be passed to subsequent calls of the same enumerate
function in order to retrieve the remainder of the values.
The use of this parameter is as follows:
1. The client computer sends an enumerate call with any necessary parameters (e.g. operationScope)
and no enumerateID parameter.
2. The device returns with an array containing the requested data, and possibly a new enumerateID.