Class P2PConnection<T>

constructor

• new P2PConnection<T extends Record<string, unknown>>(
      contract: Contract,
  ): P2PConnection<T>

  Creates a live connection instance from one side of a previously exchanged contract.

  Type Parameters

  • T extends Record<string, unknown>

    The structured payload type sent through sendMessage() and received via the "message" event.

  Parameters

  • contract: Contract

    The contract copy for the local role.

  Returns P2PConnection<T>

  Throws

  Throws UNKNOWN_PEER_CONTRACT when the provided contract does not match a reserved pending or accepted offer.

remoteCameraVideoElement

remoteScreenVideoElement

StaticlocalCameraVideoElement

StaticlocalScreenVideoElement

addEventListener

• addEventListener<K extends keyof P2PConnectionEventMap<T>>(
      type: K,
      listener: P2PConnectionEventListenerFor<T, K> | null,
      options?: boolean | AddEventListenerOptions,
  ): void

  Registers an event listener.

  Type Parameters

  • K extends keyof P2PConnectionEventMap<T>

  Parameters

  • type: K

    The event type to listen for.

  • listener: P2PConnectionEventListenerFor<T, K> | null

    The listener to register.

  • Optionaloptions: boolean | AddEventListenerOptions

    Listener registration options.

  Returns void

closeConnection

• closeConnection(): void

  Closes the data channel and underlying peer connection.

  Returns void

ready

• ready(): Promise<void>

  Resolves once the underlying data channel is fully open.

  Returns Promise<void>

  Throws

  Throws CHANNEL_CLOSED, CHANNEL_ERROR, or CHANNEL_NOT_AVAILABLE if the connection fails before the channel opens.

removeEventListener

• removeEventListener<K extends keyof P2PConnectionEventMap<T>>(
      type: K,
      listener: P2PConnectionEventListenerFor<T, K> | null,
      options?: boolean | EventListenerOptions,
  ): void

  Removes an event listener.

  Type Parameters

  • K extends keyof P2PConnectionEventMap<T>

  Parameters

  • type: K

    The event type to stop listening for.

  • listener: P2PConnectionEventListenerFor<T, K> | null

    The listener to remove.

  • Optionaloptions: boolean | EventListenerOptions

    Listener removal options.

  Returns void

sendMessage

• sendMessage(message: T): void

  Sends an application payload over the open data channel.

  Parameters

  • message: T

    The structured payload to encode and transmit.

  Returns void

  Throws

  Throws CONNECTION_NOT_READY when the data channel has not reached the "open" state.

shareCamera

• shareCamera(): Promise<void>

  Starts sending the shared local camera track and populates the shared local preview element.

  Returns Promise<void>

shareMicrophone

• shareMicrophone(): Promise<void>

  Starts sending the shared local microphone track to the remote peer.

  The first call lazily creates and caches the shared user-media stream.

  Returns Promise<void>

shareScreen

• shareScreen(): Promise<void>

  Starts sending the shared local display stream and populates the shared local preview element.

  Returns Promise<void>

stopSharingCamera

• stopSharingCamera(): void

  Stops sending the local camera track, if one is currently attached.

  Returns void

stopSharingMicrophone

• stopSharingMicrophone(): void

  Stops sending the local microphone track, if one is currently attached.

  Returns void

stopSharingScreen

• stopSharingScreen(): void

  Stops sending the local display tracks, if any are currently attached.

  Returns void

StaticacceptOffer

• acceptOffer(
      offer: Offer,
      additionalIceServers?: RTCIceServer[],
  ): Promise<ContractCopies>

  Accepts a remote offer and returns the paired contract copies needed by the two peers to finalize the connection locally.

  Parameters

  • offer: Offer

    The remote offer to accept.

  • additionalIceServers: RTCIceServer[] = []

    Optional additional ICE servers appended after the built-in public STUN configuration.

  Returns Promise<ContractCopies>

  The contract copies for the offeror and offeree.

  Throws

  Throws MISSING_LOCAL_DESCRIPTION when the browser does not expose the generated answer description.

StaticmakeOffer

• makeOffer(additionalIceServers?: RTCIceServer[]): Promise<Offer>

  Creates a new offer and reserves the local offeror-side connection state until the returned offer is later consumed by the constructor.

  Parameters

  • additionalIceServers: RTCIceServer[] = []

    Optional additional ICE servers appended after the built-in public STUN configuration.

  Returns Promise<Offer>

  An offer that can be transported to the remote peer out-of-band.

  Throws

  Throws MISSING_LOCAL_DESCRIPTION when the browser does not expose the generated offer description.