Interface SimulcastConfig

Simulcast configuration passed to WebRTCEndpoint.addTrack.

At the moment, simulcast track is initialized in three versions - low, medium and high. High resolution is the original track resolution, while medium and low resolutions are the original track resolution scaled down by 2 and 4 respectively.

interface SimulcastConfig {
    activeEncodings: TrackEncoding[];
    disabledEncodings: TrackEncoding[];
    enabled: boolean;
}

Properties

activeEncodings: TrackEncoding[]

List of initially active encodings.

Encoding that is not present in this list might still be enabled using WebRTCEndpoint.enableTrackEncoding.

disabledEncodings: TrackEncoding[]

List of disabled encodings.

Encoding that is present in this list was disabled using WebRTCEndpoint.disableTrackEncoding.

enabled: boolean

Whether to simulcast track or not.