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

    Variable CascadeTreeEventConst

    CascadeTreeEvent: {
        CapacityShortfall: "capacityShortfall";
        LeafAssigned: "leafAssigned";
        LinkCreated: "linkCreated";
        LinkDropped: "linkDropped";
        OriginLost: "originLost";
        TreeBuilt: "treeBuilt";
        TreeDropped: "treeDropped";
    } = ...

    Structural events emitted by a CascadeTree as fan-out plans are built, diffed, and torn down.

    Type Declaration

    • ReadonlyCapacityShortfall: "capacityShortfall"

      Fired when the plan cannot seat all viewers, with the unmet viewer count.

    • ReadonlyLeafAssigned: "leafAssigned"

      Fired for each leaf node assigned viewer slots, with the slot count.

    • ReadonlyLinkCreated: "linkCreated"

      Fired for each parent-to-child link added relative to the previous plan.

    • ReadonlyLinkDropped: "linkDropped"

      Fired for each parent-to-child link removed relative to the previous plan.

    • ReadonlyOriginLost: "originLost"

      Fired when a room's origin node fails. The tree is torn down and cannot be rebuilt automatically — the origin ingests the source media, so recovery requires re-originating the room (host re-publish / failover) and calling CascadeTree.build with a new origin.

    • ReadonlyTreeBuilt: "treeBuilt"

      Fired with the full CascadePlan whenever a room's tree is (re)built.

    • ReadonlyTreeDropped: "treeDropped"

      Fired when a room's tree is fully torn down.