9 conference.paneplacement.modify, 10 participant.add, 22 4.10 participant.add – TANDBERG 3.0 User Manual

Page 26

Advertising
background image

Copyright © TANDBERG 2008

Reference Guide Version 3.0 rev 3.0

22

4.9 conference.paneplacement.modify

Modifies the pane placement configuration of a particular conference.

Parameter

Type

Comments

conferenceName

String

Name of the conference to be queried.

enabled (optional) Boolean

true to enable pane placement, false to disable.

panes (optional)

array of structs

See below for format of the structures.

The panes array contains structures which define a specific pane and its contents. If a pane index is not present
in the array, then that pane will remain unchanged. Participant identification is as returned in
participant.enumerate.

Field

Type

Comments

index

Integer

The index of the pane to be changed.

type

String

Any one of:

default

- the default behaviour

blank

- a blank window

loudest

- the current loudest speaker

rolling – shows a sequence of conference participants,
changing according to the configured rolling interval

h239

- the h239 content channel

participant

- a participant as described in the three

optional fields.

participantType
(optional)

String

participantProtocol
(optional)

String

participantName
(optional)

String

Participant identification. Only required if type is

participant, these identify a specific participant.


Because not all panes are guaranteed to be changed, this call returns the following structure:

Response

Type

Comments

panesModified

Integer

The number of panes successfully modified. This will be
the number of elements in the panes array on complete

success, and zero if there is no panes array.

4.10 participant.add

Adds a participant to a conference.

Parameter

Type

Comments

conferenceName

String

The name of the conference to which to add the
participant.

participantName

String

The name of the participant to be added. This must
be a unique value, i.e. not the same as any existing
participant. Note that for

ad_hoc

participants, this

is optional, but must be present otherwise.

participantProtocol

String

If present, must be

h323, sip or vnc

– these are

Advertising