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

    Variable SfuNodeEventConst

    SfuNodeEvent: {
        BandwidthEstimate: "bandwidth-estimate";
        Drained: "drained";
        Draining: "draining";
        Failed: "failed";
        Load: "load";
        Overloaded: "overloaded";
        Recovered: "recovered";
    } = ...

    Lifecycle and telemetry events emitted by an SfuNode.

    Type Declaration

    • ReadonlyBandwidthEstimate: "bandwidth-estimate"

      Fired with a BandwidthQuality tier from the stats collector.

    • ReadonlyDrained: "drained"

      Fired when draining completes (all rooms gone or the drain timed out).

    • ReadonlyDraining: "draining"

      Fired when the node begins draining and stops accepting new rooms.

    • ReadonlyFailed: "failed"

      Fired when the node is marked failed (for example by a health check).

    • ReadonlyLoad: "load"

      Fired whenever a new load value is reported via reportLoad.

    • ReadonlyOverloaded: "overloaded"

      Fired when reported load first reaches or exceeds the node capacity.

    • ReadonlyRecovered: "recovered"

      Fired when a previously failed node is marked recovered.