Class RemoteParticipant

RemoteParticipant manages a WebRTC peer-to-peer connection and data channel with a single remote player.

Handles offer/answer exchange and ICE candidate negotiation.
Manages the RTCDataChannel for sending and receiving game data.
Notifies the observer of incoming messages.
Integrates with a signaling implementation for connection setup.

Index

Constructors

Properties

Methods

addICECandidate answer call handleAnswer onMessage send

Constructors

constructor

new RemoteParticipant(
    id: string,
    signaling: RTCSignaling,
    observer: RemoteParticipantObserver,
): RemoteParticipant
Constructs a new RemoteParticipant.
Parameters
- id: string
  The remote participant's ID.
- signaling: RTCSignaling
  The signaling interface for WebRTC setup.
- observer: RemoteParticipantObserver
  The observer to notify of incoming messages.
Returns RemoteParticipant
- Defined in network/RemoteParticipant.ts:43

Properties

id

id: string

The unique ID of the remote participant.

Methods

addICECandidate

addICECandidate(candidate: RTCIceCandidateInit): Promise<void>
Adds an ICE candidate to the peer connection.
Parameters
- candidate: RTCIceCandidateInit
  The ICE candidate to add.
Returns Promise<void>
- Defined in network/RemoteParticipant.ts:145

answer

answer(offer: RTCSessionDescriptionInit): Promise<void>
Handles an incoming offer and responds with an answer (callee).
Parameters
- offer: RTCSessionDescriptionInit
  The received RTC session description offer.
Returns Promise<void>
- Defined in network/RemoteParticipant.ts:98

call

call(): Promise<void>
Initiates a WebRTC connection as the caller (creates offer and data channel).

Returns Promise<void>
- Defined in network/RemoteParticipant.ts:69

handleAnswer

handleAnswer(answer: RTCSessionDescriptionInit): Promise<void>
Handles an incoming answer to a previously sent offer.
Parameters
- answer: RTCSessionDescriptionInit
  The received RTC session description answer.
Returns Promise<void>
- Defined in network/RemoteParticipant.ts:130

onMessage

onMessage(event: MessageEvent): void
Handles an incoming message from the data channel and notifies the observer.
Parameters
- event: MessageEvent
  The message event.
Returns void
- Defined in network/RemoteParticipant.ts:160

send

send(id: string, action: string, data: any): void
Sends a message to the remote participant via the data channel.
Parameters
- id: string
  The sender's ID.
- action: string
  The action type.
- data: any
  The data payload.
Returns void
- Defined in network/RemoteParticipant.ts:172