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

    Wraps a mediasoup Router, owning the producers, consumers, and transports for one room.

    A MediaRouter is the SFU's per-room media hub: it creates send/recv WebRTC transports, tracks the Producers publishing into the room and the Consumers subscribing to them, and supports piping producers between routers for cross-worker/cross-node cascading. It emits MediaRouterEvents as producers and consumers come and go, and closes them all on close. Created and managed by MediaService.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    id: string

    Accessors

    Methods

    • Parameters

      • peerId: string
      • transportId: string
      • dtlsParameters: DtlsParameters

      Returns Promise<void>

    • Parameters

      • peerId: string
      • transportId: string
      • producerId: string
      • rtpCapabilities: RtpCapabilities

      Returns Promise<Consumer>

    • Synchronously invokes every listener registered for event, in registration order.

      Type Parameters

      • K extends keyof MediaRouterEvents

      Parameters

      • event: K

        The event name to emit.

      • ...args: MediaRouterEvents[K]

        The argument tuple to pass to each listener, matching Events[event].

      Returns boolean

      true if at least one listener was invoked, false if there were none.

      The listener list is snapshotted before dispatch, so mutations made by handlers take effect only on subsequent emissions. Listeners are isolated: if one throws, the remaining listeners still run and the error is surfaced via console.error rather than swallowed silently (consistent with LocalMessageBus).

    • Returns the number of listeners currently registered for event.

      Type Parameters

      • K extends keyof MediaRouterEvents

      Parameters

      • event: K

        The event name to count listeners for.

      Returns number

      The count of registered listeners (0 if none).

    • Removes a previously registered listener for event.

      Type Parameters

      • K extends keyof MediaRouterEvents

      Parameters

      • event: K

        The event name the listener was registered for.

      • listener: (...args: MediaRouterEvents[K]) => void

        The exact function reference passed to on or once.

      Returns this

      This emitter, for chaining.

      If the listener is not currently registered, this is a no-op. Only the first matching registration is removed.

    • Registers a listener that is invoked every time event is emitted.

      Type Parameters

      • K extends keyof MediaRouterEvents

      Parameters

      • event: K

        The event name to listen for.

      • listener: (...args: MediaRouterEvents[K]) => void

        Callback invoked with the event's argument tuple.

      Returns this

      This emitter, for chaining.

    • Registers a listener that is invoked at most once: it is removed automatically before being called the first time event is emitted.

      Type Parameters

      • K extends keyof MediaRouterEvents

      Parameters

      • event: K

        The event name to listen for.

      • listener: (...args: MediaRouterEvents[K]) => void

        Callback invoked with the event's argument tuple on the next emission.

      Returns this

      This emitter, for chaining.

      Remove a pending one-time listener by passing the same function reference to off.

    • Removes listeners for a single event, or for all events.

      Parameters

      • Optionalevent: keyof MediaRouterEvents

        The event name to clear; if omitted, listeners for every event are removed.

      Returns this

      This emitter, for chaining.

    • Parameters

      • peerId: string
      • consumerId: string

      Returns Promise<void>