# 实现音视频互动 (/zh-CN/realtime-media/rtc/get-started/quick-start/react-native)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
本文介绍如何集成声网实时互动 SDK,通过少量代码从 0 开始实现一个简单的实时互动 App,适用于互动直播和视频通话场景。
首先,你需要了解以下有关音视频实时互动的基础概念:
- 声网实时互动 SDK:由声网开发的、帮助开发者在 App 中实现实时音视频互动的 SDK。
- 频道:用于传输数据的通道,在同一个频道内的用户可以进行实时互动。
- 主播:可以在频道内**发布**音视频,同时也可以**订阅**其他主播发布的音视频。
- 观众:可以在频道内**订阅**音视频,不具备**发布**音视频权限。
更多概念详见[关键概念](/zh-CN/realtime-media/rtc/reference/key-concept)。
下图展示在 App 中实现音视频互动的基本工作流程:
1. 所有用户调用 `joinChannel` 方法加入频道,并根据需要设置用户角色:
- 互动直播:如果用户需要在频道中发流,则设为主播;如果用户只需要收流,则设为观众。
- 视频通话:将所有用户的角色都设为主播。
2. 加入频道后,不同角色的用户具备不同的行为:
- 所有用户默认都可以接收频道中的音视频流。
- 主播可以在频道内发布音视频流。
- 观众如果需要发流,可在频道内调用 `setClientRole` 方法修改用户角色,使其具备发流权限。
## 前提条件 [#前提条件-10]
目标平台为 Android
目标平台为 iOS
- 已参考 [React Native 官方文档](https://reactnative.dev/docs/environment-setup)搭建好开发环境。
- macOS、Windows 或 Linux 操作系统
- Android 5.0 或以上设备
- 可以访问互联网的计算机。如果你的网络环境部署了防火墙,参考[应对防火墙限制](/zh-CN/realtime-media/rtc/build/setup-and-access/firewall)以正常使用声网服务。
- 有效的声网账户和声网项目。请参考[开通 RTC 服务](/zh-CN/realtime-media/rtc/build/setup-and-access/enable-service),从声网控制台获取以下信息:
- App ID:声网随机生成的字符串,用于识别你的 App。
- 临时 Token:你的 App 客户端加入频道时会使用 Token 对用户进行鉴权。临时 Token 的有效期为 24 小时。
- 已参考 [React Native 官方文档](https://reactnative.dev/docs/environment-setup)搭建好开发环境。
- macOS 操作系统
- iOS 9.0 或以上设备。如果你使用 React Native 0.63 或以上版本,请确保 iOS 的版本高于 10.0。
- 已安装 CocoaPods,否则请参考 [Getting Started with CocoaPods](https://guides.cocoapods.org/using/getting-started.html#getting-started) 进行安装。
- 可以访问互联网的计算机。如果你的网络环境部署了防火墙,参考[应对防火墙限制](/zh-CN/realtime-media/rtc/build/setup-and-access/firewall)以正常使用声网服务。
- 有效的声网账户和声网项目。请参考[开通 RTC 服务](/zh-CN/realtime-media/rtc/build/setup-and-access/enable-service),从声网控制台获取以下信息:
- App ID:声网随机生成的字符串,用于识别你的 App。
- 临时 Token:你的 App 客户端加入频道时会使用 Token 对用户进行鉴权。临时 Token 的有效期为 24 小时。
## 创建项目 [#创建项目-9]
参考以下步骤,创建一个 React Native 项目。
1. 运行以下命令,在 `ProjectName` 处填入你的项目名称,创建并初始化一个新项目。
```shell
# 初始化 package.json 文件
npm init
# 安装 React Native
npm install react-native
# 创建 React Native 项目
npx react-native init ProjectName
```
运行完成后,会在执行该命令的路径下自动生成一个简单的示例项目。
2. 执行 `npx react-native run-android` 运行 Android 应用或执行 `npx react-native run-ios` 运行 iOS 应用。
如果配置没有问题,你可以看到模拟器被打开,App 自动安装到模拟器上并开始运行。你也可以在 Android 或 iOS 真机上运行应用,详见[在设备上运行](https://reactnative.dev/docs/running-on-device)。
现在你已经成功运行了项目,可以开始尝试集成声网 SDK 并修改项目。
## 集成 SDK [#集成-sdk-9]
本节介绍如何在 React Native 0.60 或以上版本集成声网 React Native SDK。
根据你的目标开发平台,执行以下步骤:
目标平台为 Android
目标平台为 iOS
在项目根目录下,使用以下任意一种方法下载最新版的声网 React Native SDK:
- **方法一**:使用 npm 下载
```shell
npm i --save react-native-agora
```
- **方法二**:使用 yarn 下载
```shell
# 安装 yarn
npm install -g yarn
# 使用 yarn 下载声网 React Native SDK
yarn add react-native-agora
```
:::info[信息]
React Native 0.60.0 或以上版本支持自动链接原生模块,请勿手动链接。详见 [Autolinking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md)。
:::
1. 在项目根目录下,使用以下任意一种方法下载最新版的声网 React Native SDK:
- **方法一**:使用 npm 下载
```shell
npm i --save react-native-agora
```
- **方法二**:使用 yarn 下载
```shell
# 安装 yarn
npm install -g yarn
# 使用 yarn 下载声网 React Native SDK
yarn add react-native-agora
```
:::info[信息]
React Native 0.60.0 或以上版本支持自动链接原生模块,请勿手动链接。详见 [Autolinking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md)。
:::
2. 进入 React Native 项目自动创建的 `ios` 文件夹,运行以下命令安装 SDK:
```shell
cd ios
npx pod-install
```
## 创建用户界面 [#创建用户界面-8]
根据实时音视频互动的场景需要,为你的项目创建两个视图框,并使用 [`RtcSurfaceView`](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_rtcsurfaceview) 组件展示本地视频和远端视频,并配置加入频道和离开频道按钮。复制以下代码即可快速创建场景所需的用户界面。
```typescript
// 导入 React Hooks
import React, {useRef, useState, useEffect} from 'react';
// 导入用户界面元素
import {
SafeAreaView,
ScrollView,
StyleSheet,
Text,
View,
Switch,
} from 'react-native';
const App = () => {
const agoraEngineRef = useRef(); // IRtcEngine 实例
const [isJoined, setIsJoined] = useState(false); // 本地用户是否已加入频道
const [isHost, setIsHost] = useState(true); // 用户角色
const [remoteUid, setRemoteUid] = useState(0); // 远端用户的 Uid
const [message, setMessage] = useState(''); // 用户提示信息
// 渲染用户界面
return (
声网实时音视频互动快速开始
加入频道
离开频道
Audience
{
setIsHost(switchValue);
if (isJoined) {
leave();
}
}}
value={isHost}
/>
Host
{isJoined && isHost ? (
// 使用 RtcSurfaceView 创建本地视图
本地用户 uid: {uid}
) : (
加入一个频道
)}
{isJoined && remoteUid !== 0 ? (
// 使用 RtcSurfaceView 创建远端视图
远端用户 uid: {remoteUid}
) : (
{isJoined && !isHost ? '等待远端用户加入' : ''}
)}
{message}
);
// 展示信息
function showMessage(msg: string) {
setMessage(msg);
}
};
// 定义用户界面样式
const styles = StyleSheet.create({
button: {
paddingHorizontal: 25,
paddingVertical: 4,
fontWeight: 'bold',
color: '#ffffff',
backgroundColor: '#0055cc',
margin: 5,
},
main: { flex: 1, alignItems: 'center' },
scroll: { flex: 1, backgroundColor: '#ddeeff', width: '100%' },
scrollContainer: { alignItems: 'center' },
videoView: { width: '90%', height: 200 },
btnContainer: { flexDirection: 'row', justifyContent: 'center' },
head: { fontSize: 20 },
info: { backgroundColor: '#ffffe0', paddingHorizontal: 8, color: '#0000ff' }
});
```
## 实现步骤 [#实现步骤-10]
本节介绍如何实现一个实时音视频互动 App。
下图展示了使用声网 RTC SDK 实现音视频互动的基本流程。
下面列出了一段实现实时音视频互动基本流程的完整代码以供参考,你可以先复制完整的示例代码到你的项目中,参考[测试项目](#调试项目)中的步骤快速体验实时音视频互动的基础功能,再按照实现流程了解其中的核心 API 调用。
复制以下代码替换 `App.tsx` 文件的全部内容,即可快速体验实时音视频互动基础功能。
```typescript
// 导入 React Hooks
import React, { useRef, useState, useEffect } from 'react';
// 导入用户界面元素
import {
SafeAreaView,
ScrollView,
StyleSheet,
Text,
View,
Switch,
} from 'react-native';
// 导入获取 Android 设备权限相关组件
import { PermissionsAndroid, Platform } from 'react-native';
// 导入声网 SDK
import {
createAgoraRtcEngine,
ChannelProfileType,
ClientRoleType,
IRtcEngine,
RtcSurfaceView,
RtcConnection,
IRtcEngineEventHandler
} from 'react-native-agora';
// 定义基本信息
const appId = '<-- Insert App ID -->';
const token = '<-- Insert Token -->';
const channelName = '<-- Insert Channel Name -->';
const uid = 0; // 本地用户 Uid,无需修改
const App = () => {
const agoraEngineRef = useRef(); // IRtcEngine 实例
const [isJoined, setIsJoined] = useState(false); // 本地用户是否已加入频道
const [isHost, setIsHost] = useState(true); // 用户角色
const [remoteUid, setRemoteUid] = useState(0); // 远端用户的 Uid
const [message, setMessage] = useState(''); // 用户提示信息
const eventHandles = useRef(); // 实现回调函数
useEffect(() => {
// 启动 App 时初始化引擎
setupVideoSDKEngine();
// 关闭 App 时释放内存
return () => {
agoraEngineRef.current?.unregisterEventHandler(eventHandles.current!);
agoraEngineRef.current?.release();
};
}, []);
// 定义启动 App 时调用的 setupVideoSDKEngine 方法
const setupVideoSDKEngine = async () => {
try {
// 获取设备权限后创建 RtcEngine
if (Platform.OS === 'android') {
await getPermission()
};
agoraEngineRef.current = createAgoraRtcEngine();
const agoraEngine = agoraEngineRef.current;
eventHandles.current = {
onJoinChannelSuccess: () => {
showMessage('成功加入频道:' + channelName);
setIsJoined(true);
},
onUserJoined: (_connection: RtcConnection, uid: number) => {
showMessage('远端用户 ' + uid + ' 已加入');
setRemoteUid(uid);
},
onUserOffline: (_connection: RtcConnection, uid: number) => {
showMessage('远端用户 ' + uid + '已离开频道');
setRemoteUid(0);
},
}
// 注册回调事件
agoraEngine.registerEventHandler(eventHandles.current);
// 初始化引擎
agoraEngine.initialize({
appId: appId,
});
// 开启本地视频
agoraEngine.enableVideo();
} catch (e) {
console.log(e);
}
};
// 定义点击加入频道按钮后调用的 join 方法
const join = async () => {
if (isJoined) {
return;
}
try {
if (isHost) {
// 开启预览
agoraEngineRef.current?.startPreview();
// 以主播角色加入频道
agoraEngineRef.current?.joinChannel(token, channelName, uid, {
// 设置频道场景为直播场景
channelProfile: ChannelProfileType.ChannelProfileLiveBroadcasting,
// 设置用户角色为主播
clientRoleType: ClientRoleType.ClientRoleBroadcaster,
// 发布麦克风采集的音频
publishMicrophoneTrack: true,
// 发布摄像头采集的视频
publishCameraTrack: true,
// 自动订阅所有音频流
autoSubscribeAudio: true,
// 自动订阅所有视频流
autoSubscribeVideo: true,
});
} else {
// 以观众角色加入频道
agoraEngineRef.current?.joinChannel(token, channelName, uid, {
// 设置频道场景为直播场景
channelProfile: ChannelProfileType.ChannelProfileLiveBroadcasting,
// 设置用户角色为观众
clientRoleType: ClientRoleType.ClientRoleAudience,
// 不发布麦克风采集的音频
publishMicrophoneTrack: false,
// 不发布摄像头采集的视频
publishCameraTrack: false,
// 自动订阅所有音频流
autoSubscribeAudio: true,
// 自动订阅所有视频流
autoSubscribeVideo: true,
});
}
} catch (e) {
console.log(e);
}
};
// 定义点击离开频道按钮后调用的 leave 方法
const leave = () => {
try {
// 调用 leaveChannel 方法离开频道
agoraEngineRef.current?.leaveChannel();
setRemoteUid(0);
setIsJoined(false);
showMessage('已离开频道');
} catch (e) {
console.log(e);
}
};
// 渲染用户界面
return (
声网实时音视频互动快速开始
加入频道
离开频道
Audience
{
setIsHost(switchValue);
if (isJoined) {
leave();
}
}}
value={isHost}
/>
Host
{isJoined && isHost ? (
// 使用 RtcSurfaceView 创建本地视图
本地用户 uid: {uid}
) : (
加入一个频道
)}
{isJoined && remoteUid !== 0 ? (
// 使用 RtcSurfaceView 创建远端视图
远端用户 uid: {remoteUid}
) : (
{isJoined && !isHost ? '等待远端用户加入' : ''}
)}
{message}
);
// 展示信息
function showMessage(msg: string) {
setMessage(msg);
}
};
// 定义用户界面样式
const styles = StyleSheet.create({
button: {
paddingHorizontal: 25,
paddingVertical: 4,
fontWeight: 'bold',
color: '#ffffff',
backgroundColor: '#0055cc',
margin: 5,
},
main: { flex: 1, alignItems: 'center' },
scroll: { flex: 1, backgroundColor: '#ddeeff', width: '100%' },
scrollContainer: { alignItems: 'center' },
videoView: { width: '90%', height: 200 },
btnContainer: { flexDirection: 'row', justifyContent: 'center' },
head: { fontSize: 20 },
info: { backgroundColor: '#ffffe0', paddingHorizontal: 8, color: '#0000ff' }
});
const getPermission = async () => {
if (Platform.OS === 'android') {
await PermissionsAndroid.requestMultiple([
PermissionsAndroid.PERMISSIONS.RECORD_AUDIO,
PermissionsAndroid.PERMISSIONS.CAMERA,
]);
}
};
export default App;
```
:::info[信息]
将 `<-- Insert App Id -->`、`<-- Insert Token -->` 和 `<-- Insert Channel Name -->` 分别替换为你在控制台获取到的 App ID、临时 Token,以及生成临时 Token 时填入的频道名。
:::
### 导入声网组件 [#导入声网组件-3]
导入构建 App 所需的声网组件。
```typescript
import {
createAgoraRtcEngine,
ChannelProfileType,
ClientRoleType,
IRtcEngine,
RtcSurfaceView,
} from 'react-native-agora';
```
### 定义基本信息 [#定义基本信息-1]
传入从声网控制台获取的 App ID、临时 Token,以及生成临时 Token 时填入的频道名,用于后续初始化引擎和加入频道。
```typescript
const appId = '<-- Insert App ID -->';
const token = '<-- Insert Token -->';
const channelName = '<-- Insert Channel Name -->';
const uid = 0; // 本地用户 Uid,无需修改
```
### 获取设备权限 [#获取设备权限]
根据你的目标平台选择获得麦克风和摄像头的使用权限的方式:
Android
iOS
在 Android 设备上,要获得麦克风和摄像头的使用权限,需要弹出提示框供用户选择。
```typescript
// 导入获取 Android 设备权限相关组件
import {PermissionsAndroid, Platform} from 'react-native';
const getPermission = async () => {
if (Platform.OS === 'android') {
await PermissionsAndroid.requestMultiple([
PermissionsAndroid.PERMISSIONS.RECORD_AUDIO,
PermissionsAndroid.PERMISSIONS.CAMERA,
]);
}
};
```
在 Xcode 中,打开 `info.plist` 文件。在右侧列表中添加如下内容,获取相应的设备权限:
| Key | Type | Value |
| :------------------------------------- | :----- | :----------------------------------------------------------- |
| Privacy - Microphone Usage Description | String | 使用麦克风的目的,例如:for a call or live interactive streaming。 |
| Privacy - Camera Usage Description | String | 使用摄像头的目的,例如:for a call or live interactive streaming。 |
### 初始化引擎 [#初始化引擎-9]
调用 `createAgoraRtcEngine` 方法创建一个 `RtcEngine` 实例,然后调用 `initialize` 初始化引擎。
:::warning[注意]
在初始化 SDK 前,需确保终端用户已经充分了解并同意相关的隐私政策。
:::
```typescript
agoraEngineRef.current = createAgoraRtcEngine();
const agoraEngine = agoraEngineRef.current;
agoraEngine.initialize({
appId: appId,
});
```
### 启用视频模块 [#启用视频模块-9]
按照以下步骤启用视频模块。
1. 调用 `enableVideo` 方法,启用视频模块。
2. 调用 `startPreview` 方法,开启本地视频预览。
``` typescript
agoraEngine.enableVideo();
agoraEngineRef.current?.startPreview();
```
### 加入频道并发布音视频流 [#加入频道并发布音视频流-9]
调用 `joinChannel` 方法,填入你在控制台获取的临时 Token,以及获取 Token 时填入的频道名加入频道,并在 `options` 参数中设置频道场景、用户角色等信息。
```typescript
if (isHost) {
// 以主播角色加入频道
agoraEngineRef.current?.joinChannel(token, channelName, uid, {
// 设置频道场景为直播场景
channelProfile: ChannelProfileType.ChannelProfileLiveBroadcasting,
// 设置用户角色为主播
clientRoleType: ClientRoleType.ClientRoleBroadcaster
// 发布麦克风采集的音频
publishMicrophoneTrack: true,
// 发布摄像头采集的视频
publishCameraTrack: true,
// 自动订阅所有音频流
autoSubscribeAudio: true,
// 自动订阅所有视频流
autoSubscribeVideo: true,
});
} else {
// 以观众角色加入频道
agoraEngineRef.current?.joinChannel(token, channelName, uid, {
// 设置频道场景为直播场景
channelProfile: ChannelProfileType.ChannelProfileLiveBroadcasting,
// 设置用户角色为观众
clientRoleType: ClientRoleType.ClientRoleAudience,
// 不发布麦克风采集的音频
publishMicrophoneTrack: false,
// 不发布摄像头采集的视频
publishCameraTrack: false,
// 自动订阅所有音频流
autoSubscribeAudio: true,
// 自动订阅所有视频流
autoSubscribeVideo: true,
});
}
```
### 实现常用回调 [#实现常用回调-9]
注册以下必要的回调事件可以在触发相应的事件时调用 `showMessage` 方法提示操作结果,并更新组件状态。
- `onJoinChannelSuccess`:成功加入频道回调。
- `onUserJoined`:远端用户加入当前频道回调。
- `onUserOffline`:远端用户离开当前频道回调。
```typescript
const eventHandles = useRef();
eventHandles.current = {
onJoinChannelSuccess: () => {
showMessage('成功加入频道:' + channelName);
setIsJoined(true);
},
onUserJoined: (_connection: RtcConnection, uid: number) => {
showMessage('远端用户 ' + uid + ' 已加入');
setRemoteUid(uid);
},
onUserOffline: (_connection: RtcConnection, uid: number) => {
showMessage('远端用户 ' + uid + '已离开频道');
setRemoteUid(0);
},
}
// 注册回调事件
agoraEngine.registerEventHandler(eventHandles.current);
```
### 离开频道 [#离开频道-2]
调用 `leaveChannel` 方法离开频道、释放资源并显示文字提示。
```typescript
// 调用 leaveChannel 方法离开频道
agoraEngineRef.current?.leaveChannel();
setRemoteUid(0);
setIsJoined(false);
showMessage('已离开频道');
```
如果你不再需要互动,调用 `release` 方法释放引擎资源。
```typescript
// 取消注册回调事件
agoraEngineRef.current?.unregisterEventHandler(eventHandles);
// 销毁引擎
agoraEngineRef.current?.release();
```
:::error[警告]
- 调用 `release` 后,你将无法再使用 SDK 的所有方法和回调。如需再次使用实时音视频互动功能,你必须重新创建一个新的引擎。详见[初始化引擎](#初始化引擎-9)。
- 该方法为同步调用。需要等待引擎资源释放后才能执行其他操作,因此建议在子线程中调用该方法,避免主线程阻塞。
:::
## 调试项目 [#调试项目]
1. 确保已经在代码中传入了有效的 `appId`,`channelName` 和 `token`。
2. 运行 App。部分模拟机可能无法支持本项目的全部功能,建议你在真机中运行该项目。
- 在 Android 设备上运行:
a. 开启 Android 设备的开发者选项,通过 USB 连接线将 Android 设备接入电脑。
b. 在项目根目录下执行 `npx react-native run-android`。
- 在 iOS 设备上运行:
a. 使用 Xcode 打开 `ProjectName/ios/ProjectName.xcworkspace` 文件夹。
b. 通过 USB 线将 iOS 设备接入你的电脑。
c. 在 Xcode 中,点击 **Build and run** 按钮。
:::info[信息]
- 在 Android 或 iOS 真机上运行 App 的详细步骤,请参考 [Running On Device](https://reactnative.dev/docs/running-on-device)。
- 由于声网引擎是一个本地进程,使用 Metro 打包器重新载入 App 时可能会丢失对引擎的引用,导致无法加入频道。此时可以重新启动 App 解决问题。
:::
3. 启动 App,点击按钮加入频道。
4. 邀请一位朋友使用第二台设备,重复以上步骤,在该设备上安装 App,并打开 App 加入频道。你的朋友加入频道后,你们可以看到彼此,并听到彼此的声音。
## 后续步骤 [#后续步骤-8]
- 本文的示例使用了临时 Token 加入频道。在测试或生产环境中,为确保通信安全,声网推荐使用 Token 服务器来生成 Token,详见[使用 Token 鉴权](/zh-CN/realtime-media/rtc/build/setup-and-access/token-authentication)。
- 如果你想要实现极速直播场景,可以在实时音视频互动的基础上,通过修改观众端的延时级别为低延时 (`AudienceLatencyLevelLowLatency`)实现。详见[实现极速直播](/zh-CN/realtime-media/rtc/build/advanced-channel/ls-quick-start)。
## 参考信息 [#参考信息-10]
### 示例项目 [#示例项目-10]
声网提供了开源的实时音视频互动示例项目供你参考,你可以前往下载或查看其中的源代码。
JoinChannelVideo} href="https://gitee.com/agoraio-community/react-native-agora/blob/3.x/example/src/examples/basic/JoinChannelVideo/JoinChannelVideo.tsx" />
JoinChannelVideo} href="https://github.com/AgoraIO-Extensions/react-native-agora/blob/main/examples/legacy/src/examples/basic/JoinChannelVideo/JoinChannelVideo.tsx" />
### 常见问题 [#常见问题-9]
- [直播场景下,如何监听远端观众角色用户加入/离开频道的事件?](/zh-CN/reference/faq/integration/audience_event)
- [如何处理视频黑屏问题?](/zh-CN/reference/faq/quality/video_blank)
- [为什么我无法打开摄像头?](/zh-CN/reference/faq/quality/video_camera)
- [如何处理频道相关常见问题?](/zh-CN/reference/faq/integration/channel)
- [如何设置日志文件?](/zh-CN/reference/faq/integration/set_log_file)
- [为什么部分 Android 版本应用锁屏或切后台后采集音视频无效?](/zh-CN/reference/faq/quality/android_background)
- [为什么 SDK 中使用的是动态库而不是静态库?](/zh-CN/reference/faq/integration/dynamic_or_static_library)
### 相关文档 [#相关文档-9]
- [SDK 错误码](/zh-CN/realtime-media/rtc/reference/error-code)
- [频道连接状态管理](/zh-CN/realtime-media/rtc/build/initialize-and-channel/channel-connection)