RTCForge API Reference v1.1.1
    Preparing search index...

    Interface SimpleBandwidthEstimatorOptions

    Threshold and hysteresis options for the SimpleBandwidthEstimator.

    Streak options add hysteresis so that a single noisy sample does not flip the committed quality tier.

    interface SimpleBandwidthEstimatorOptions {
        bitrateMinKbps?: number;
        downgradeStreak?: number;
        packetLossHighThreshold?: number;
        packetLossMedThreshold?: number;
        rttHighThreshold?: number;
        rttMedThreshold?: number;
        upgradeStreak?: number;
    }
    Index

    Properties

    bitrateMinKbps? downgradeStreak? packetLossHighThreshold? packetLossMedThreshold? rttHighThreshold? rttMedThreshold? upgradeStreak?

    Properties

    bitrateMinKbps?: number

    Minimum bitrate in kbps below which quality drops to medium.

    500
    downgradeStreak?: number

    Consecutive samples pointing downward required before committing a lower tier.

    2
    packetLossHighThreshold?: number

    Packet-loss ratio (0-1) at or above which quality is forced to low.

    0.1
    packetLossMedThreshold?: number

    Packet-loss ratio (0-1) at or above which quality drops to medium.

    0.03
    rttHighThreshold?: number

    Round-trip time in milliseconds at or above which quality is forced to low.

    300
    rttMedThreshold?: number

    Round-trip time in milliseconds at or above which quality drops to medium.

    150
    upgradeStreak?: number

    Consecutive samples pointing upward required before committing a higher tier.

    3

    Settings

    Member Visibility

    On This Page

    Properties