# 快速开始云端录制 (/zh-CN/realtime-media/cloud-recording/get-started/quick-start/java)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
选择你要使用的接口或 SDK,完成云端录制的环境准备、参数配置、示例运行和核心流程验证。
本文向新手介绍如何使用声网 Java SDK 开始第一次云端录制。
Java SDK 旨在帮助开发者更轻松集成声网 RESTful API。该 SDK 具有如下特性:
- 简化通信流程:通过封装 RESTful API 的请求和响应处理,让你与 RESTful API 的通信更简单。
- 保障可用性:遇到 DNS 解析失败、网络错误、请求超时等网络问题时,会自动切换到最佳域名,确保 REST 服务的可用性。
- API 易用性:提供简洁易懂的 API,让你能轻松实现开启云端录制、停止云端录制等常用功能。
- 其他优势:基于 Java 语言编写,具有高效性、并发性、可扩展性。
## 前提条件 [#前提条件]
开始前请确保你的本地开发环境满足如下条件:
- [Java 1.8](https://www.oracle.com/cn/java/technologies/downloads/) 或以上版本。
- 参考[开通云端录制服务](/zh-CN/realtime-media/cloud-recording/build/setup-and-access/enable-service)在声网控制台开通云端录制,并复制保存 App ID、临时 Token、客户 ID 和客户密钥。
:::warning[注意]
临时 Token 的有效期是 24 小时。Token 过期会导致加入频道失败。
:::
- 云端录制文件需要上传到第三方云存储。开始录制前,请开通第三方云存储服务,并获取 Bucket、Access Key、Secret Key 以备用。
开通方式请参考云存储官网文档,本文后续步骤以阿里云为例:
- [Amazon S3](https://aws.amazon.com/cn/s3/?c=s&sec=srv)
- [阿里云](https://www.aliyun.com/product/oss)
- [腾讯云](https://cloud.tencent.com/product/cos)
- [Microsoft Azure](https://azure.microsoft.com/zh-cn/services/storage/blobs/)
- [谷歌云](https://cloud.google.com/storage)
- [华为云](https://www.huaweicloud.com/product/obs.html)
- [百度智能云](https://cloud.baidu.com/product/bos.html)
- 在项目中实现了基础的音视频互动场景。你也可以参考[文档](/zh-CN/realtime-media/cloud-recording/get-started/quick-start/restful-api#模拟音视频互动场景)使用声网实时互动 [Web Demo](https://webdemo.agora.io/index.html) 在浏览器中模拟一个音视频互动场景。
## 创建项目并安装 SDK [#创建项目并安装-sdk]
1. 在你的 IDE 中创建一个 Java 项目。以 IntelliJ IDEA 为例,设置你的项目名称、保存路径,并将 **Build system** 设为 **Maven**。完成创建后,点击 **Create**。
2. 在项目的 `pom.xml` 文件中的 `` 区域添加如下行,将 REST Client 的依赖添加到项目中:
```xml
io.agora
agora-rest-client-core
0.5.0
```
## 进行云端录制 [#进行云端录制]
本节介绍进行云端录制的极简流程。为方便说明,本节以录制之前模拟的音视频直播为例,并假设录制主播的音频和视频录制到 MP4 文件中。
### 定义变量 [#定义变量]
在 `Main.java` 文件中,添加如下代码,定义或配置关键参数,取值参考[前提条件](#前提条件)。
```java
public class Main {
// 定义关键参数
private static String appId = "";
private static String cname = "show";
// 录制服务加入频道的用户 ID
private static String uid = "123";
// 客户 ID
private static String username = "";
// 客户密钥
private static String password = "";
private static String token = "";
// 配置云存储
private static String accessKey = "";
private static String secretKey = "";
private static Integer region = 1;
private static String bucket = "";
private static Integer vendor = 2;
}
```
其中,
- `cname` 值设为 `show`,表示加入录制实时音视频互动所在的频道。
- `vendor` 值设为 `2` 代表使用阿里云;`region` 值设为 `1` 表示 `CN_Shanghai`。如果你使用其他云存储厂商,参考[第三方云存储地区说明](/zh-CN/realtime-media/cloud-recording/reference/api-reference#第三方云存储地区说明)赋值。
### 创建并初始化 Client [#创建并初始化-client]
在 `main` 方法中,添加如下代码,创建并初始化 Client。
```java
Credential credential = new BasicAuthCredential(username, password);
// Initialize CloudRecordingConfig
CloudRecordingConfig config = CloudRecordingConfig.builder()
.appId(appId)
.credential(credential)
// Specify the region where the server is located.
// Optional values are CN, US, EU, AP, and the client will automatically
// switch to use the best domain name according to the configured region
.domainArea(DomainArea.CN)
.build();
// Initialize CloudRecordingClient
CloudRecordingClient cloudRecordingClient = CloudRecordingClient.create(config);
```
### 申请录制服务器资源 [#申请录制服务器资源]
调用 `acquire` 申请录制服务器资源。
```java
AcquireResourceRes acquireResourceRes;
// Acquire resource
try {
acquireResourceRes = cloudRecordingClient
.mixScenario()
.acquire(cname, uid, AcquireMixRecordingResourceClientReq.builder().build())
.block();
} catch (AgoraException e) {
System.out.printf("agora error:%s", e.getMessage());
return;
} catch (Exception e) {
System.out.printf("unknown error:%s", e.getMessage());
return;
}
// Check if the response is null
if (acquireResourceRes == null || acquireResourceRes.getResourceId() == null) {
System.out.println("failed to get resource");
return;
}
System.out.printf("resourceId:%s", acquireResourceRes.getResourceId());
System.out.println("acquire resource success");
```
### 开始录制 [#开始录制]
获取资源后,调用 `start` 开始录制。
```java
// Define storage config
StartResourceReq.StorageConfig storageConfig = StartResourceReq.StorageConfig.builder()
.accessKey(accessKey)
.secretKey(secretKey)
.bucket(bucket)
.vendor(vendor)
.region(region)
.build();
// Define start resource request
StartMixRecordingResourceClientReq startResourceReq = StartMixRecordingResourceClientReq.builder()
.token(token)
.recordingConfig(StartResourceReq.RecordingConfig.builder()
.channelType(1)
.build())
.recordingFileConfig(StartResourceReq.RecordingFileConfig.builder()
.avFileType(Arrays.asList("hls", "mp4"))
.build())
.storageConfig(storageConfig)
.build();
StartResourceRes startResourceRes;
// Start resource
try {
startResourceRes = cloudRecordingClient
.mixScenario()
.start(cname, uid, acquireResourceRes.getResourceId(), startResourceReq)
.block();
} catch (AgoraException e) {
System.out.printf("agora error:%s", e.getMessage());
return;
} catch (Exception e) {
System.out.printf("unknown error:%s", e.getMessage());
return;
}
// Check if the response is null
if (startResourceRes == null || startResourceRes.getSid() == null) {
System.out.println("failed to start resource");
return;
}
System.out.printf("sid:%s", startResourceRes.getSid());
System.out.println("start resource success");
Thread.sleep(3000);
```
### 停止录制 [#停止录制]
完成录制后,调用 `stop` 结束录制。
```java
StopResourceRes stopResourceRes;
// Stop resource
try {
stopResourceRes = cloudRecordingClient
.mixScenario()
.stop(cname, uid, startResourceRes.getResourceId(), startResourceRes.getSid(), true)
.block();
} catch (AgoraException e) {
System.out.printf("agora error:%s", e.getMessage());
return;
} catch (Exception e) {
System.out.printf("unknown error:%s", e.getMessage());
return;
}
// Check if the response is null
if (stopResourceRes == null || stopResourceRes.getSid() == null) {
System.out.println("failed to stop resource");
} else {
System.out.println("stop resource success");
}
```
### 完整示例代码 [#完整示例代码]
`Main.java` 文件中完整代码如下,你可自行比对:
```java
public class Main {
private static String appId = "";
private static String cname = "";
// 录制服务加入频道的用户 ID
private static String uid = "";
// 客户 ID
private static String username = "";
// 客户密钥
private static String password = "";
private static String token = "";
private static String accessKey = "";
private static String secretKey = "";
private static Integer region = 1; //
private static String bucket = "";
private static Integer vendor = 2; //
public static void main(String[] args) throws Exception {
Credential credential = new BasicAuthCredential(username, password);
// Initialize CloudRecordingConfig
CloudRecordingConfig config = CloudRecordingConfig.builder()
.appId(appId)
.credential(credential)
// Specify the region where the server is located.
// Optional values are CN, US, EU, AP, and the client will automatically
// switch to use the best domain name according to the configured region
.domainArea(DomainArea.CN)
.build();
// Initialize CloudRecordingClient
CloudRecordingClient cloudRecordingClient = CloudRecordingClient.create(config);
AcquireResourceRes acquireResourceRes;
// Acquire resource
try {
acquireResourceRes = cloudRecordingClient
.mixScenario()
.acquire(cname, uid, AcquireMixRecordingResourceClientReq.builder().build())
.block();
} catch (AgoraException e) {
System.out.printf("agora error:%s", e.getMessage());
return;
} catch (Exception e) {
System.out.printf("unknown error:%s", e.getMessage());
return;
}
// Check if the response is null
if (acquireResourceRes == null || acquireResourceRes.getResourceId() == null) {
System.out.println("failed to get resource");
return;
}
System.out.printf("resourceId:%s", acquireResourceRes.getResourceId());
System.out.println("acquire resource success");
// Define storage config
StartResourceReq.StorageConfig storageConfig = StartResourceReq.StorageConfig.builder()
.accessKey(accessKey)
.secretKey(secretKey)
.bucket(bucket)
.vendor(vendor)
.region(region)
.build();
// Define start resource request
StartMixRecordingResourceClientReq startResourceReq = StartMixRecordingResourceClientReq.builder()
.token(token)
.recordingConfig(StartResourceReq.RecordingConfig.builder()
.channelType(1)
.build())
.recordingFileConfig(StartResourceReq.RecordingFileConfig.builder()
.avFileType(Arrays.asList("hls", "mp4"))
.build())
.storageConfig(storageConfig)
.build();
StartResourceRes startResourceRes;
// Start resource
try {
startResourceRes = cloudRecordingClient
.mixScenario()
.start(cname, uid, acquireResourceRes.getResourceId(), startResourceReq)
.block();
} catch (AgoraException e) {
System.out.printf("agora error:%s", e.getMessage());
return;
} catch (Exception e) {
System.out.printf("unknown error:%s", e.getMessage());
return;
}
// Check if the response is null
if (startResourceRes == null || startResourceRes.getSid() == null) {
System.out.println("failed to start resource");
return;
}
System.out.printf("sid:%s", startResourceRes.getSid());
System.out.println("start resource success");
Thread.sleep(3000);
QueryMixHLSAndMP4RecordingResourceRes queryResourceRes;
// Query resource
try {
queryResourceRes = cloudRecordingClient
.mixScenario()
.queryHLSAndMP4(startResourceRes.getResourceId(), startResourceRes.getSid())
.block();
} catch (AgoraException e) {
System.out.printf("agora error:%s", e.getMessage());
return;
} catch (Exception e) {
System.out.printf("unknown error:%s", e.getMessage());
return;
}
if (queryResourceRes == null || queryResourceRes.getServerResponse() == null) {
System.out.println("failed to query resource");
return;
}
System.out.println("query resource success");
Thread.sleep(3000);
StopResourceRes stopResourceRes;
// Stop resource
try {
stopResourceRes = cloudRecordingClient
.mixScenario()
.stop(cname, uid, startResourceRes.getResourceId(), startResourceRes.getSid(), true)
.block();
} catch (AgoraException e) {
System.out.printf("agora error:%s", e.getMessage());
return;
} catch (Exception e) {
System.out.printf("unknown error:%s", e.getMessage());
return;
}
// Check if the response is null
if (stopResourceRes == null || stopResourceRes.getSid() == null) {
System.out.println("failed to stop resource");
} else {
System.out.println("stop resource success");
}
}
}
```
## 查看录制文件 [#查看录制文件]
参考第三方云存储官方文档操作,查看云存储中的文件。根据 `start` 方法中 `storageconfig.fileNamePrefix` 参数的设置,录制生成文件位于 `quickstart` 目录下。如下截图以阿里云为例:

录制过程中生成了 `.m3u8`、`.ts` 和 `mp4` 文件。最终 `quickstart` 文件夹内包含如下:
```shell
.
├── _testchannel.m3u8
├── _testchannel_0.mp4
└── _testchannel_20241119070642248.ts
```
根据你在 `start` 方法中设置的录制时间,云存储中可能会有多个 .ts 文件。录制文件介绍请参考[录制文件命名和切片规则](/zh-CN/realtime-media/cloud-recording/build/manage-recorded-files/introduce-recorded-files#合流和页面录制模式)。
## 进阶设置 [#进阶设置]
本文提供的示例代码仅为快速上手时使用。在实际业务中,你需要根据实际业务场景修改请求参数。如下示例代码展示了录制直播频道中所有的音视频流,且输出的视频流需要转码的参数配置:
```java
// 配置录制选项
StartMixRecordingResourceClientReq startResourceReq = StartMixRecordingResourceClientReq.builder()
.token(token)
.recordingConfig(StartResourceReq.RecordingConfig.builder()
.channelType(1)
.streamTypes(2)
.maxIdleTime(30)
.audioProfile(2)
.transcodingConfig(StartResourceReq.TranscodingConfig.builder()
.width(640)
.height(480)
.fps(15)
.bitrate(800)
.mixedVideoLayout(0)
.backgroundColor("#000000")
.build())
.subscribeAudioUIDs(Collections.singletonList("#allstream#"))
.subscribeVideoUIDs(Collections.singletonList("#allstream#"))
.build())
.recordingFileConfig(StartResourceReq.RecordingFileConfig.builder()
.avFileType(Arrays.asList("hls", "mp4"))
.build())
.storageConfig(storageConfig)
.build();
```
云端录制支持设置的所有参数请参考 [API 文档](/zh-CN/api-reference/api-ref/cloud-recording/start)。
## 参考信息 [#参考信息]
### 示例项目 [#示例项目]
完成快速开始后,你可以体验更多云端录制示例:
### 排查错误 [#排查错误]
- [响应状态码和错误码](/zh-CN/realtime-media/cloud-recording/reference/response-code)
- [为什么成功开启云端录制后调用 query 方法返回 404?](/zh-CN/reference/faq/integration/return_404)
- [如何选择云存储 bucket 区域及处理跨区上传问题?](/zh-CN/reference/faq/integration/bucket_region)
- [为什么第三方云存储中没有录制文件?](/zh-CN/reference/faq/integration/fail_to_upload)