Class WebrtcController<MessageData>

constructor

• new WebrtcController<MessageData extends JsonCompatibleValue>(
      clientId: `${string}-${string}-${string}-${string}-${string}`,
  ): WebrtcController<MessageData>

  Type Parameters

  • MessageData extends JsonCompatibleValue

  Parameters

  • clientId: `${string}-${string}-${string}-${string}-${string}`

  Returns WebrtcController<MessageData>

ReadonlyclientId

ReadonlyisConnected

acceptAnswer

• acceptAnswer(
      rawAnswer: string | Readonly<RTCSessionDescriptionInit>,
  ): Promise<void>

  Accepts a WebRTC answer. This is the third (and last) step in the WebRTC handshake process.

  Parameters

  • rawAnswer: string | Readonly<RTCSessionDescriptionInit>

  Returns Promise<void>

createAnswer

• createAnswer(
      rawOffer: string | Readonly<RTCSessionDescriptionInit>,
      stunServerUrls: readonly string[],
  ): Promise<{ sdp: string; type: Answer }>

  Accepts a WebRTC offer and creates a WebRTC answer. This is the second step in the WebRTC handshake process.

  Parameters

  • rawOffer: string | Readonly<RTCSessionDescriptionInit>
  • stunServerUrls: readonly string[]

  Returns Promise<{ sdp: string; type: Answer }>

createOffer

• createOffer(
      stunServerUrls: readonly string[],
  ): Promise<{ sdp: string; type: Offer }>

  Create a WebRTC offer. This is the first step in the WebRTC handshake process.

  Parameters

  • stunServerUrls: readonly string[]

  Returns Promise<{ sdp: string; type: Offer }>

destroy

• destroy(): void

  Remove all internal state to free up resources.

  Returns void

sendMessage

• sendMessage(data: Readonly<MessageData>): void

  Send a message to the other peer in the WebRTC connection. This will throw an error if the connection has not been established yet.

  Parameters

  • data: Readonly<MessageData>

  Returns void