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

    Interface CascadePipeInterface

    Adapter the CascadeBridge calls to create and tear down inter-node media pipes on a concrete media plane.

    Implement this to realize the parent-to-child links of a cascade fan-out CascadeTree as real media forwarding between SFU nodes.

    interface CascadePipeInterface {
        pipeLink(
            roomId: string,
            fromNodeId: string,
            toNodeId: string,
        ): void | Promise<void>;
        unpipeLink(
            roomId: string,
            fromNodeId: string,
            toNodeId: string,
        ): void | Promise<void>;
    }

    Implemented by

    Index

    Methods

    pipeLink unpipeLink

    Methods

    • Establish a media pipe carrying roomId from fromNodeId to toNodeId. May be async so the pipe setup can be awaited and surface failures.

      Parameters

      • roomId: string
      • fromNodeId: string
      • toNodeId: string

      Returns void | Promise<void>

    • Tear down the media pipe carrying roomId from fromNodeId to toNodeId.

      Parameters

      • roomId: string
      • fromNodeId: string
      • toNodeId: string

      Returns void | Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods