@ceeblue/webrtc-client
    Preparing search index...

    Type Alias ABRParams

    ABRParams is the structure used to initialize an ABRAbstract instance.

    type ABRParams = {
        appreciationDuration?: number;
        maximum?: number;
        minimum?: number;
        recoverySteps?: number;
        startup?: number;
    }

    Implemented by

    Index

    Properties

    appreciationDuration?: number

    The appreciationDuration parameter defines the duration (in milliseconds) for recognizing a stable network condition. By default it is set to 4 seconds, which is longer than the typical GOP unit, usually set to 2 seconds.

    Only used by ABRLinear.

    4000
    
    maximum?: number

    Maximum bitrate in bps

    3000000
    
    minimum?: number

    Minimum bitrate in bps

    200000
    
    recoverySteps?: number

    The recoverySteps parameter defines the step size used to gradually restore the bitrate towards the ideal bandwidth, aiming to approach the ABRParams.maximum limit.

    Initially set to the configured value (default: 2), this factor determines the number of steps taken to adapt the bitrate based on network conditions :

    • If network congestion is detected, the step count increases to avoid overshooting.
    • Once the network stabilizes, the step count decreases, returning gradually to its initial value.

    In essence, recoverySteps controls the initial speed at which the system recovers a high transfer rate.

    Only used by ABRLinear

    2
    
    startup?: number

    Startup bitrate in bps

    2000000