Skip to content
This repository has been archived by the owner on Dec 6, 2023. It is now read-only.

AgoraIO-Community/Agora-RTC-React

Repository files navigation

Agora RTC SDK React Wrapper (Archive)

Agora now offers an official React SDK!

The React SDK (2.x) repo is available here.
It's released as v2.x under the same npm package.

Links for 2.x


1.x (this repo)

A react (react.js) wrapper for Agora RTC NG SDK.

This wrapper supports React >= v16.8

Install

npm install agora-rtc-react

Usage

import React from "react";
import { AgoraVideoPlayer, createClient, createMicrophoneAndCameraTracks } from "agora-rtc-react";

const config = {mode: "rtc", codec: "vp8"}

const useClient = createClient(config);
const useMicrophoneAndCameraTracks = createMicrophoneAndCameraTracks();

const App = () => {
  const client = useClient();
  const { ready, tracks } = useMicrophoneAndCameraTracks();

  return (
    ready && <AgoraVideoPlayer videoTrack={tracks[1]} style={{height: '100%', width: '100%'}} />
  )
}

Example

A full videocall example using the wrapper can be found here.

Reference

You can view the methods in the wrapper here.