English | 简体中文
agora-rtc-react 可以让你在 React 应用中更便捷的使用 agora-rtc-sdk-ng。
npm i agora-rtc-reactHere is the first one to get you started:
import AgoraRTC from "agora-rtc-sdk-ng";
import { AgoraRTCProvider } from "agora-rtc-react";
const Client = ({ children }) => {
return (
<AgoraRTCProvider client={AgoraRTC.createClient({ mode: "rtc", codec: "vp8" })}>
{children}
</AgoraRTCProvider>
);
};
const root = createRoot(document.getElementById("container"));
root.render(<Client />);This example will render Agora Client into a container on the page.
- 添加
.env.local文件到每个 example 文件夹中, 并且填写 Agora 账号信息。你可以参考.env.example。 - 执行
pnpm start。
-
RemoteVideoTrack— 该组件用于播放远端用户的视频轨道，并且不支持指定播放设备。 -
RemoteUser— 该组件用于播放远端用户的视频和音频轨道，并且仅支持指定使用的音频设备、不支持指定使用的视频设备。 -
RemoteAudioTrack— 该组件用于播放远端用户的音频轨道，并且支持指定播放设备。 -
LocalVideoTrack— 该组件用于播放本地视频轨道，播放设备为用户在浏览器中选择的设备。 -
LocalUser— 该组件用于播放本地用户的摄像头视频轨道和麦克风音频轨道，播放设备为用户在浏览器中选择的设备。 -
LocalAudioTrack— 该组件用于播放本地音频轨道，播放设备为用户在浏览器中选择的设备。 -
AgoraRTCScreenShareProvider— 该组件向子组件提供 Context，让 children 内的各个组件都能读取你传入的用于屏幕共享的 client 属性。 -
AgoraRTCProvider— 该组件向子组件提供 Context，让 children 内的各个组件都能读取你传入的 client 属性。
-
useVolumeLevel— 用于自动获取音频轨道音量级别，自动获取的频率为每秒一次。 -
useTrackEvent— 用于监听本地轨道对象或远端轨道对象的特定事件。 -
useRemoteVideoTracks— 用于自动订阅和获取远端用户视频轨道。 -
useRemoteUsers— 用于获取远端用户列表。 -
useRemoteUserTrack— 用于获取远端用户音视频轨道。 -
useRemoteAudioTracks— 用于自动订阅和获取远端用户音频轨道。 -
useRTCClient— 用于获取 IAgoraRTCClient 对象。 -
usePublish— 用于发布本地轨道。当组件准备好时发布，当组件卸载时取消发布。 -
useNetworkQuality— 用于获取本地用户网络质量。 -
useLocalScreenTrack— 用于创建本地屏幕共享的视频轨道。 -
useLocalMicrophoneTrack— 用于创建本地麦克风音频轨道。你可以在不同组件中调用该方法以创建多个轨道。如果要在多个组件中访问同一个轨道，请确保在多个组件中都传入同一个轨道对象。 -
useLocalCameraTrack— 用于创建本地摄像头视频轨道。你可以在不同组件中调用该方法以创建多个轨道。如果要在多个组件中访问同一个轨道，请确保在多个组件中都传入同一个轨道对象。 -
useJoin— 用于加入频道。当组件准备好时加入频道，当组件卸载时自动离开频道。 -
useIsConnected— 用于获取 SDK 是否连接到服务器。 -
useCurrentUID— 用于获取当前用户 UID 。 -
useConnectionState— 用于获取详细的 SDK 连接状态。 -
useClientEvent— 用于监听 IAgoraRTCClient 对象的指定事件。 -
useAutoPlayVideoTrack— 用于自动播放本地或远端视频轨道。 -
useAutoPlayAudioTrack— 用于自动播放本地或远端音频轨道。
MIT © Agora.io