4 conference related methods, 1 conference.create, Conference related methods – TANDBERG 3.0 User Manual

Page 18

Advertising
background image

Copyright © TANDBERG 2008

Reference Guide Version 3.0 rev 3.0

14

4 Conference related methods

Methods in this section are only implemented on products, such as the Codian MCU 4200 series, which act as
a video conferencing server. Throughout this section, the term MCU refers to any such device.

4.1 conference.create

Parameter

Type

Comments

conferenceName String

(<32

chars)

Name of the conference to be created.
The conference name must be unique.

numericId (optional)

String (<32
chars)

Numeric identifier of the conference.

conferenceId (deprecated)

String (< 32
chars)

Deprecated alternative for “numericId”.

registerWithGatekeeper (optional)

Boolean

Register the conference’s “numericId”
with the gatekeeper.

registerWithSIPRegistrar (optional)

Boolean

Register this conference with the SIP
registrar.

startTime (optional)

dateTime.iso8601 If you do not specify a time, the

conference starts immediately.

durationSeconds (optional)

Integer

The length of each repeating conference
instance, in seconds. If this parameter is
absent, or set to “0”, the conference is
permanent.

endTime (optional) (deprecated)

dateTime.iso8601 If you do not specify an end time, then

the conference will be permanent (until
it is explicitly deleted).

This parameter is deprecated and
present for backward
compatibility reasons only.
Application code should use
“durationSeconds” instead.

pin (optional)

String (< 32
chars)

If present, this is the string of numeric
digits that people need to enter to join
the conference.

description(optional)

String (< 32
chars)

multicastStreamingEnabled(optional) Boolean

unicastStreamingEnabled(optional) Boolean

h239Enabled(optional) Boolean

private

Boolean

Determines the visibility of this
conference. This parameter corresponds
to the “Visibility” setting on the web UI,
which can have the value

Public

or

Private

.

maximumAudioPorts (optional)

Integer

maximumVideoPorts (optional)

Integer

reservedAudioPorts (optional)

Integer

These fields set the limit on the number
of audio (audio only) and video (video +

audio) ports for the conference. The

Advertising