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

    Interface SfuMediaInterface

    Adapter the SfuBridge calls to apply routing decisions onto a concrete media plane.

    Implement this to connect the router's room-to-node assignments (and cascade fan-out routes) to your SFU's actual forwarding tables.

    interface SfuMediaInterface {
        addRoute(roomId: string, nodeId: string): void | Promise<void>;
        getRoutes(roomId: string): string[];
        removeCascadeRoute(roomId: string, nodeId: string): void | Promise<void>;
        removeRoute(roomId: string): void | Promise<void>;
    }

    Implemented by

    Index

    Methods

    addRoute getRoutes removeCascadeRoute removeRoute

    Methods

    • Add a forwarding route for roomId targeting the node nodeId. May be async so real pipe setup can be awaited and surface failures.

      Parameters

      • roomId: string
      • nodeId: string

      Returns void | Promise<void>

    • Return the node ids currently routed for roomId.

      Parameters

      • roomId: string

      Returns string[]

    • Remove only the cascade route from roomId to nodeId.

      Parameters

      • roomId: string
      • nodeId: string

      Returns void | Promise<void>

    • Remove all forwarding routes for roomId.

      Parameters

      • roomId: string

      Returns void | Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods