use-rtc-peer-connection

useRTCPeerConnection Hook

This React hook simplifies the creation and management of RTCPeerConnection for WebRTC communication within your React applications.

Demo

Insert gif or link to demo

• https://youtu.be/t2-O1tfnkHU
• https://webrtc-channel-chat.vercel.app

Example code is given below

Installation

Assuming you have npm or yarn installed, run the following command in your terminal:

Installation

NPM

 npm install use-rtc-peer-connection

YARN

 yarn add use-rtc-peer-connection

Usage

Import the hook:

import { useRTCPeerConnection } from 'use-rtc-peer-connection';

Call the hook:

const { peerConnection, createOffer, setRemote, dataChannel, isOpen, data, iceCandidate } = useRTCPeerConnection({
  offer: /* remote peer offer (optional) */,
  configuration: /* RTCConfiguration options (optional) */
});

Hook Options

• offer: (optional) The SDP offer received from the remote peer, if applicable.
• configuration: (optional) An RTCConfiguration object to customize the peer connection configuration.

Hook State and Functions

• peerConnection: The RTCPeerConnection object, or null if not yet initialized.
• createOffer: A function to create an offer description.
• setRemote: A function to set the remote description.
• dataChannel: The RTCDataChannel object for data transfer, or null if not yet established.
• isOpen: A boolean indicating whether the data channel is open.
• data: The data received through the data channel, or null if no data has been received.
• iceCandidate: The latest generated ICE candidate, or null if none available.

Example

• example.tsx

Contributing

Contributions are welcome! Please refer to the contribution guidelines: https://github.com/basil-github/react-use-rtc-peer-connection.git for more information.

Authors

• @beacel