Skip to main content
Version: v1.23.0

SimulcastConfiguration

Configuration for Simulcast. Simulcast is a feature which allows publishers to encode and send multiple different qualities of video. If no layers are specified then a default 3 layers will be sent.

The number of layers and what layers to send can be configured with the 'layers' property.

Properties

enabled

enabled: boolean

Whether to enable or disable Simulcast as a publisher

Default

false

layers?

optional layers: SimulcastLocalLayerConfiguration[]

The array of Simulcast Layers to be sent by the Publisher. At most 3 layers can be provided, and at minimum 1. Providing 0 layers, or an empty array will result in the default layers being used internally. For audio-only defer to the strategy methods.

See the SimulcastLocalLayerConfiguration object for information about layer restrictions as well as potential errors.