开始录制音视频

本文介绍如何使用声网服务端 SDK 在实时音视频频道中实现录制功能。

前提条件

开始前请确保你的本地开发环境满足以下条件：

• 参考开通服务在控制台创建一个声网项目，并获取项目的 。
• 在项目中实现了基础的音视频互动场景。
• 服务器硬件条件：
  • CPU：8 核，1.8 GHz 主频
  • 内存：推荐 4 GB 或更高
• 服务器软件环境：
  • 操作系统：Ubuntu（18.04 版本及以上）或 CentOS（7.0 版本及以上）
  • CPU 架构：arm64 或 x86-64
  • glibc 2.18 或更高版本
  • gcc 4.8 或更高版本
• 网络要求：
  • 服务器接入公网，有公网 IP
  • 服务器允许访问 .agora.io 以及 .agoralab.co

集成 SDK

1. 前往下载获取最新的声网本地服务端录制 SDK 软件包。解压后的 SDK 包目录结构如下：

   Shell

   .
   ├── agora_sdk
   │   ├── include
   │   ├── libagora-fdkaac.so
   │   ├── libagora_rtc_sdk.so
   │   └── libaosl.so
   └── example
       ├── CMakeLists.txt
       ├── build.sh
       ├── out
       ├── recorder
       ├── recorder.json
       ├── singleVideo.json
       ├── scripts
       └── third-party

2. 将下载下来的 SDK 文件集成到你的项目中：

   • 将 agora_sdk/include 目录中的头文件导入到你的开发工程中
   • 将 agora_sdk/ 目录下的如下动态库文件链接到你的工程：
     • libagora-fdkaac.so
     • libagora_rtc_sdk.so
     • libaosl.so

信息

SDK 包中的 example 路径下是完整的本地录制示例项目。你可以参考编译示例项目并运行跑通并体验。

调用 API 实现录制

实现录制的 API 时序如下图所示：

初始化服务资源

首先，你需要调用 createAgoraService 创建服务实例，并使用 initialize 方法进行初始化，设置 App ID 和音视频相关的配置。

C++

// 初始化 Service 资源，设置 log
auto service = createAgoraService();
agora::base::AgoraServiceConfiguration service_config;
service_config.enableAudioDevice = false;
service_config.enableAudioProcessor = true;
service_config.enableVideo = true;
service_config.appId = config.appId.c_str();
service_config.useStringUid = config.UseStringUid;
service->initialize(service_config);
service->setLogFile("./io.agora.rtc_sdk/agorasdk.log", 1024*1024*5);

创建 Recorder

调用 createAgoraMediaComponentFactory 和 createMediaRtcRecorder 创建录制实例，然后使用 IAgoraMediaRtcRecorder::initialize 方法初始化录制实例。

C++

// 创建 recorder
agora::rtc::IMediaComponentFactory* factory = createAgoraMediaComponentFactory();
agora::agora_refptr<agora::rtc::IAgoraMediaRtcRecorder> recorder = factory->createMediaRtcRecorder();
// 初始化 recorder
// isMix 设置录制模式
// - false 表示分开录制每个用户的音视频流，即单流录制
// - true 表示将所有用户的音视频混合录制，即合流录制
bool isMix = false;
// service 为上一步初始化的 AgoraService 对象
recorder->initialize(service, isMix);

注册事件处理器

使用 registerRecorderEventHandler 注册录制事件的回调处理器，以便接收和处理录制过程中的事件通知。

C++

// 注册回调
std::unique_ptr<RecorderEventHandler> eventHandler{new RecorderEventHandler(recorder, config)};
recorder->registerRecorderEventHandle(eventHandler.get());

订阅音视频流

调用 subscribeAllAudio 和 subscribeAllVideo 方法来订阅频道内的所有音频和视频流。

C++

// 订阅流
recorder->subscribeAllAudio();
recorder->subscribeAllVideo(options);

配置录制参数

使用 setRecorderConfig 方法设置录制的相关配置，包括视频分辨率、帧率、存储路径等。

注意

请确保你设置的录制文件存储路径 storagePath 存在。如果指定的目录不存在，会导致录制失败。

C++

// 设置录制相关配置
agora::media::MediaRecorderConfiguration recorder_config;
recorder_config.width = config.video.width;
recorder_config.height = config.video.height;
recorder_config.fps = config.video.fps;
recorder_config.storagePath = config.recorderPath.c_str();
recorder_config.sample_rate = config.audio.sampleRate;
recorder_config.channel_num = config.audio.numOfChannels;
// 设置录制音频流、视频流、音视频流
recorder_config.streamType = static_cast<agora::media::MediaRecorderStreamType>(config.recorderStreamType);
// 设置最大录制时长
recorder_config.maxDurationMs = config.maxDuration * 1000;
recorder->setRecorderConfig(recorder_config);

加入频道并开始录制

调用 joinChannel 加入指定的频道，然后使用 startRecording 开始录制。

C++

// 加入频道并开始录制
recorder->joinChannel(config.token.c_str(), config.ChannelName.c_str(), config.UserId.c_str());
recorder->startRecording();

结束录制和释放资源

录制完成后，需要调用相应的方法来取消订阅流、停止录制、退出频道并释放资源。你会在配置录制参数时指定的存储路径下找到 MP4 格式的录制文件。

C++

// 结束录制 清理资源 退出频道
recorder->unsubscribeAllAudio();
recorder->unsubscribeAllVideo();
recorder->stopRecording();
recorder->unregisterRecorderEventHandle(eventHandler.get());
eventHandler = nullptr;
recorder->leavelChannel();
recorder = nullptr;
service->release();

完整示例代码

以下是使用声网服务端 SDK 进行视频录制的完整示例代码：

C++

// 初始化 Service 资源，设置 log
auto service = createAgoraService();
agora::base::AgoraServiceConfiguration service_config;
service_config.enableAudioDevice = false;
service_config.enableAudioProcessor = true;
service_config.enableVideo = true;
service_config.appId = config.appId.c_str();
service_config.useStringUid = config.UseStringUid;
service->initialize(service_config);
service->setLogFile("./io.agora.rtc_sdk/agorasdk.log", 1024*1024*5);
 
 
// 创建 recorder
agora::rtc::IMediaComponentFactory* factory = createAgoraMediaComponentFactory();
agora::agora_refptr<agora::rtc::IAgoraMediaRtcRecorder> recorder = factory->createMediaRtcRecorder();
// 初始化 recorder
bool isMix = false;
recorder->initialize(service, isMix);
// 注册回调
std::unique_ptr<RecorderEventHandler> eventHandler{new RecorderEventHandler(recorder, config)};
recorder->registerRecorderEventHandle(eventHandler.get());
// 订阅流
recorder->subscribeAllAudio();
recorder->subscribeAllVideo(options);
 
// 设置录制相关配置
agora::media::MediaRecorderConfiguration recorder_config;
recorder_config.width = config.video.width;
recorder_config.height = config.video.height;
recorder_config.fps = config.video.fps;
recorder_config.storagePath = config.recorderPath.c_str();
recorder_config.sample_rate = config.audio.sampleRate;
recorder_config.channel_num = config.audio.numOfChannels;
recorder_config.streamType = static_cast<agora::media::MediaRecorderStreamType>(config.recorderStreamType);
recorder_config.maxDurationMs = config.maxDuration * 1000;
recorder->setRecorderConfig(recorder_config);
// 加入频道并开始录制
recorder->joinChannel(config.token.c_str(), config.ChannelName.c_str(), config.UserId.c_str());
recorder->startRecording();
 
// 结束录制 清理资源 退出频道
recorder->unsubscribeAllAudio();
recorder->unsubscribeAllVideo();
recorder->stopRecording();
recorder->unregisterRecorderEventHandle(eventHandler.get());
eventHandler = nullptr;
recorder->leavelChannel();
recorder = nullptr;
service->release();

后续步骤

完成基本录制功能后，你可以进一步探索以下功能：

• 单流录制和合流录制
• 自定义合流录制视频布局
• 配置水印
• 录制崩溃后修复录制文件

参考信息

编译示例项目并运行

声网在 SDK 下载包中提供了完整的录制示例项目。获取并解压下载包后，你可以参考如下步骤编译并运行项目：

1. 运行如下命令行，前往示例项目所在路径：

   Shell

   cd agora_rtc_sdk/example

2. 运行命令行，构建示例项目：

   Shell

   ./build.sh

3. 将 SDK 包中的库文件添加到 LD_LIBRARY_PATH：

   Shell

   export LD_LIBRARY_PATH=../../agora_sdk:$LD_LIBRARY_PATH

4. 按照场景需要填写 recorder.json（合流录制的配件文件）或 singleVideo.json（单流录制的配置文件）。单流和合流的场景区别可以参考单流录制和合流录制。

5. 运行如下命令行，示例程序会根据你在指定 json 文件中的配置进行录制：

   Shell

   # 假定进行单流录制
   ./out/sample_recorder  singleVideo.json

API 参考

本文介绍实现一个极简的录制任务需要调用的核心 API。你可以参考录制 API 了解完整的功能列表和对应的 API。