Interface CascadePlan

The computed fan-out plan for distributing a room's media across a tree of SFU nodes.

interface CascadePlan {
    edges: string[];
    links: CascadeLink[];
    nodes: Map<string, CascadePlanNode>;
    origin: string;
    servedViewers: number;
    tiers: number;
    unmetViewers: number;
}

Properties

edges: string[]

Identifiers of leaf nodes that were assigned at least one viewer.

All parent-to-child forwarding links.

nodes: Map<string, CascadePlanNode>

All nodes in the tree, keyed by node id.

origin: string

Identifier of the origin (root) node.

servedViewers: number

Number of viewers the plan can seat.

tiers: number

Total number of tiers in the tree (origin tier included).

unmetViewers: number

Number of viewers that could not be seated due to insufficient capacity.