TANDBERG 3.0 User Manual

Page 22

Advertising
background image

Copyright © TANDBERG 2008

Reference Guide Version 3.0 rev 3.0

18

Valid expressions within the enumerate filter are as follows:

Expression

Type

Comments

active

Boolean

True if the conference is active.

completed

Boolean

True if the conference has finished.

scheduled

Boolean

True if the conference is a scheduled conference
(regardless of if it has been completed or not).


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 omitted, no further data
is available from the MCU.

conferences

array of structs

See below for details.


The array “conferences” contains structs with the following fields:

Field

Type

Comments

conferenceName String
conferenceType String One

of:

scheduled

or

ad_hoc

.

uniqueId Integer

An

id

unique

among all scheduled and ad hoc

conferences, each instantiation of a scheduled
conference will have the same uniqueId.

conferenceActive

Boolean

Indicates whether conference is currently
active.

description

String

Extra user-specified information about the
conference

pin

String

The security PIN.

guestPin

String

Security pin for a guest

numericId String

guestNumericId String
registerWithGatekeeper Boolean

registerWithSIPRegistrar Boolean

multicastStreamingEnabled Boolean

unicastStreamingEnabled Boolean

h239Enabled Boolean

h239Important Boolean

Whether

the H.239 channel is set to be

important.

locked Boolean

Whether

the

conference is locked or

unlocked.

maximumAudioPorts Integer
maximumVideoPorts Integer
reservedAudioPorts Integer
reservedVideoPorts Integer

These fields set the limit on the number of
audio (audio only) and video (video + audio)
ports for the conference. The “reserved”
values are for port reservation mode, whereas
the “maximum” figures apply to non-reserved
mode (and will be absent if no limits have
been configured).

customLayoutEnabled Boolean True

if

a custom layout has been enabled for

this conference.

customLayout (optional)

Integer

The index (from appendix A) of the custom
layout. This is only present if the custom

Advertising