setReceiverConstraints Parameter

patrick.buechi · June 16, 2022, 1:50pm

In the Jitsi Meet handbook, the section on lib-jitsi-meet API, for setReceiverConstraints it shows the object that is expected. However if you follow the link where it says “More information about … can be found here”, that object also has the additional field:
“colibriClass”: “ReceiverVideoConstraints”

Is that colibriClass property needed?

For reference, the 2 docs are:
lib-jitsi-meet API (low level) | Jitsi Meet (see 35. setReceiverConstraints)

github.com

jitsi/jitsi-videobridge/blob/master/doc/allocation.md#new-message-format

# Bandwidth Allocation Algorithm

Bandwidth allocation is the process of selecting the set of layers to forward to a specific endpoint (the "receiver"),
or "allocating" the available bandwidth among the available layers. When conditions change, the algorithm is re-run,
and the set of forwarded layers is updated according to the new result.

The overall goal is to provide the most relevant and suitable set of streams to the receiver, given a limited bandwidth.

## Input
### Available bandwidth
The available bandwidth (or the Bandwidth Estimation, BWE) is the estimated bandwidth between the bridge and the
receiver. It is calculated elsewhere, and is only used as input for bandwidth allocation.

### Available sources
This is the list of streams being sent from the other endpoints in the conference. Streams have multiple layers, and
the algorithm selects one layer (or no layers) for each source.

For example, a simulcast sender can encode its video in 3 different encodings, with 3 different frame rates each. This
gives the allocator 9 layers to choose from.

This file has been truncated. show original

We’re having issues with screen share quality & I’m trying to rule out any potential mistakes so I thought I’d ask about this

saghul · June 16, 2022, 2:17pm

Ping @jallamsetty

jallamsetty · June 16, 2022, 3:02pm

Yes, the colibriClass property is needed for all bridge messages. The doc describes the payload object that needs to be sent for a given colibriClass message.