6 conference.streaming.query – TANDBERG 3.0 User Manual

Page 24

Reference Guide Version 3.0 rev 3.0

4.6 conference.streaming.query

This returns some details on the current state of streaming viewers for a conference.

Parameter

Type

Comments

conferenceName

String

Name of the conference from which streaming
information is required.

This will return a structure with the following fields:

Response

Type

Comments

unicastViewers Integer

The

number

of unicast streaming viewers.

multicastViewers Integer The

number of multicast streaming viewers.

audioStreams (optional)

Array

videoStreams (optional)

Array

An array of stream structs (defined below). These
are only present if there are any streams of either
type currently in use.

audioRTCPReceiverReports Integer

The number of RTCP receiver reports for the
audio streams seen by the MCU.

audioRTCPSenderReports Integer

The

number of RTCP sender reports for the

audio streams seen by the MCU.

audioRTCPOther Integer The

number

of other RTCP packets seen for the

audio streams.

audioRTCPPacketsSent Integer

The

number of RTCP packets send by the MCU.

videoRTCPReceiverReports Integer
videoRTCPSenderReports Integer
videoRTCPOther Integer

As for the audio equivalents.

videoRTCPPacketsSent Integer

The actual layout in use for the video stream
being sent by the MCU to streaming viewers. The
values for this are described in Appendix A.

currentLayout Integer

layoutSource String

One of

family

conferenceCustom

, or

participantCustom

, and describes the reason

for the current layout.
One of:

participant

voiceActivated

h239

focusType String

focusParticipant Struct A participant identification structure (i.e. with

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

borderWidth

Integer

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

The stream structures used in the audioStreams/videoStreams responses above have the following fields:

Field

Type

Comments

codec

String

The codec in use, or

other

for undefined codecs.

count

Integer

The number of users of this codec.

bitRate (optional)

Integer

The bit rate of this stream in bits/second. This is
only present for video streams with a defined
codec.

width (optional)

Integer

The maximum width and height of this stream.