7 conference.streaming.modify, 8 conference.paneplacement.query, 21 4.8 conference.paneplacement.query – TANDBERG 3.0 User Manual

Page 25

Advertising
background image

Copyright © TANDBERG 2008

Reference Guide Version 3.0 rev 3.0

21

height (optional)

Integer


This method will return a fault code of "no such conference" if there is no active conference with the given
name, regardless of the presence a configured but inactive conference of that name.

4.7 conference.streaming.modify

Modifies the current layout for streaming viewers for a conference.

Parameter

Type

Comments

conferenceName

String

Name of the conference whose layout is to be modified.

cpLayout (optional)

String

The current layout behavior for streaming viewers - see
Appendix A.

borderWidth (optional)

Integer

0 (no border), or 1, 2, or 3 for +1/+2/+3.

focusType (optional)

String

One of:

voiceActivated

,

h239

or

participant

.

focusParticipant
(optional)

Struct A

participant

identification structure (i.e. with

conferenceName, participantName, participantProtocol
and participantType members). Should only be present if
focusType is participant.

4.8 conference.paneplacement.query

Queries the current pane placement configuration.

Parameter

Type

Comments

conferenceName

String

The name of the conference to be queried.


This returns a struct containing the following response fields:

Response

Type

Comments

enabled

Boolean

true if pane placement is enabled and in use; false
otherwise.

panes (optional)

array of structs

This is only present if enabled above is true. The struct
definition is as below.


The panes array contains structures with the following format:

Field

Type

Comments

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 identified below.

index

Integer

The index of this pane.

participantType
(optional)

String

participantProtocol
(optional)

String

participantName
(optional)

String

Participant identification. Only present if this pane
contains a specific participant.

Advertising