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

    Interface RemoteStreamSource

    Subscription surface for remote media streams arriving on a call.

    interface RemoteStreamSource {
        off(
            event: "remote-stream",
            handler: (peerId: string, stream: MediaStream) => void,
        ): void;
        off(
            event: "remote-stream-removed",
            handler: (peerId: string) => void,
        ): void;
        on(
            event: "remote-stream",
            handler: (peerId: string, stream: MediaStream) => void,
        ): void;
        on(event: "remote-stream-removed", handler: (peerId: string) => void): void;
    }

    Hierarchy (View Summary)

    Index

    Methods

    off on

    Methods

    • Unsubscribes a previously registered remote-stream handler.

      Parameters

      • event: "remote-stream"
      • handler: (peerId: string, stream: MediaStream) => void

      Returns void

    • Unsubscribes a previously registered remote-stream-removed handler.

      Parameters

      • event: "remote-stream-removed"
      • handler: (peerId: string) => void

      Returns void

    • Subscribes to a remote stream becoming available for a peer.

      Parameters

      • event: "remote-stream"
      • handler: (peerId: string, stream: MediaStream) => void

      Returns void

    • Subscribes to a peer's remote stream being removed.

      Parameters

      • event: "remote-stream-removed"
      • handler: (peerId: string) => void

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods