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

    Interface CallInterface

    The full call abstraction combining track, mute, stats, data-channel, remote-stream, and lifecycle capabilities. Implemented by the media layer and consumed by the SDK through the narrower BoundCall view.

    interface CallInterface {
        addTrack(track: MediaStreamTrack, stream: MediaStream): void;
        close(): void;
        createDataChannel(
            peerId: string,
            label: string,
            opts?: RTCDataChannelInit,
        ): RTCDataChannel | undefined;
        getStats(peerId?: string): Promise<Map<string, RTCStatsReport>>;
        isAudioMuted(): boolean;
        isVideoMuted(): boolean;
        muteAudio(): void;
        muteVideo(): void;
        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;
        removeTrack(track: MediaStreamTrack): void;
        replaceTrack(
            oldTrack: MediaStreamTrack,
            newTrack: MediaStreamTrack,
        ): Promise<void>;
        start(): void;
        unmuteAudio(): void;
        unmuteVideo(): void;
    }

    Hierarchy (View Summary)

    Index

    Methods

    addTrack close createDataChannel getStats isAudioMuted isVideoMuted muteAudio muteVideo off on removeTrack replaceTrack start unmuteAudio unmuteVideo

    Methods

    • Creates a data channel on the connection to peerId.

      Parameters

      • peerId: string

        The remote peer to open the channel to.

      • label: string

        Channel label.

      • Optionalopts: RTCDataChannelInit

        Standard RTCDataChannelInit options.

      Returns RTCDataChannel | undefined

      The channel, or undefined if no connection to peerId exists.

    • Resolves with RTCStatsReports keyed by peer id.

      Parameters

      • OptionalpeerId: string

        Restrict the report to a single peer; omit for all peers.

      Returns Promise<Map<string, RTCStatsReport>>

    • 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