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

    Client-side view of a single signaling room and the peers within it.

    A Room tracks the current peer set, their roles, and metadata, and emits events as peers join, leave, change role, or send signals/broadcasts. It also relays application-level messaging (sendSignal, broadcast) and can host a media call bound via bindCall, re-emitting remote tracks as RoomMediaEvent events. Construct via Room.create, which also returns a RoomControl for the owner to drive lifecycle and feed server messages; the Room itself is a read-and-subscribe surface.

    Hierarchy (View Summary)

    Index

    Properties

    id: string
    localPeerId: string

    Accessors

    Methods

    • Parameters

      • channel: string
      • Optionaldata: unknown

      Returns void

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

      Type Parameters

      • K extends keyof RoomEvents

      Parameters

      • event: K

        The event name to emit.

      • ...args: RoomEvents[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).

    • Parameters

      • peerId: string

      Returns Record<string, string> | undefined

    • Returns the number of listeners currently registered for event.

      Type Parameters

      • K extends keyof RoomEvents

      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 RoomEvents

      Parameters

      • event: K

        The event name the listener was registered for.

      • listener: (...args: RoomEvents[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 RoomEvents

      Parameters

      • event: K

        The event name to listen for.

      • listener: (...args: RoomEvents[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 RoomEvents

      Parameters

      • event: K

        The event name to listen for.

      • listener: (...args: RoomEvents[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 RoomEvents

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

      Returns this

      This emitter, for chaining.