快速开始云端录制 | 声网文档中心

curl --location --request POST 'https://api.sd-rtn.com/v1/apps/<your_app_id>/cloud_recording/acquire' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: <http_basic_auth>' \
--data '{
  "cname": "show",
  "uid": "123",
  "clientRequest": {}
}'

你可以使用第三方在线工具快速得到 Authorization 值。将客户 ID 和客户密钥分别填入 Username 和 Password 框，得到形如 Authorization: Basic NDI1OTQ3N2I4MzYy...YwZjA= 的结果。将该结果替代上述代码中的 Authorization: <http_basic_auth> 即可。

响应

JSON

{
    "cname": "show",
    "uid": "123",
    "resourceId": "SGXETXXX"
}

你需要复制 resourceId 以备后用。

开始录制

请求

Bash

curl --location --request POST 'https://api.sd-rtn.com/v1/apps/<your_app_id>/cloud_recording/resourceid/<resourceId_returned>/mode/mix/start' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: <http_basic_auth>' \
--data '{
  "cname": "show",
  "uid": "123",
  "clientRequest": {
    "token": "<your_token>",
    "recordingConfig": {
      "channelType": 1
    },
    "storageConfig": {
      "vendor": 2,
      "region": 3,
      "bucket": "<your_storage_bucket_name>",
      "accessKey": "<your_storage_access_key>",
      "secretKey": "<your_storage_secret_key>",
      "fileNamePrefix": [
        "quickstart"
      ]
    }
  }
}'

"vendor": 2 代表使用阿里云，如果你使用其他云存储厂商，请参考下表赋值：

云存储厂商	Vendor ID
Amazon S3	1
阿里云	2
腾讯云	3
Microsoft Azure	5
谷歌云	6
华为云	7
百度智能云	8

响应

JSON

{
    "cname": "show",
    "uid": "123",
    "resourceId": "SGXETXXX",
    "sid": "04a85XXX"
}

你需要复制 sid 以备后用。

查看录制文件

参考第三方云存储官方文档操作，查看云存储中的文件。录制文件位于 quickstart 目录下。如下截图以阿里云为例：

在录制过程中，会有一个 .m3u8 和多个 .ts 文件。点击任意一个 .ts 文件即可播放。

如果还需要查看 .mp4 文件，你需要先结束录制，再查看云存储文件。结束录制可参照如下代码：

Bash

curl --location --request POST 'https://api.sd-rtn.com/v1/apps/<your_app_id>/cloud_recording/resourceid/<resourceId_returned>/sid/<sid_returned>/mode/mix/stop' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: <http_basic_auth>' \
--data '{
  "cname": "show",
  "uid": "123",
  "clientRequest": {}
}'

最终 quickstart 录制文件夹内包含如下：

Shell

.
├── <sid>_show.m3u8
├── <sid>_show_0.mp4
├── <sid>_show_20240507070329192.ts
├── <sid>_show_20240507070346226.ts
├── <sid>_show_20240507070402264.ts
├── <sid>_show_20240507070418236.ts
├── <sid>_show_20240507070434208.ts
├── <sid>_show_20240507070450246.ts
├── <sid>_show_20240507070506218.ts
├── <sid>_show_20240507070522256.ts
├── <sid>_show_20240507070538236.ts
├── <sid>_show_20240507070554266.ts
├── <sid>_show_20240507070610238.ts
├── <sid>_show_20240507070626210.ts
└── <sid>_show_20240507070642248.ts

有关录制文件的详细信息，请参考录制文件介绍。

进阶设置

本文提供的示例代码仅为快速上手时使用。在实际业务中，你需要根据实际业务场景修改请求参数。如下示例代码展示了录制直播频道中所有的音视频流，且输出的视频流需要转码的参数配置：

Bash

curl --location --request POST 'https://api.sd-rtn.com/v1/apps/<your_app_id>/cloud_recording/resourceid/<resourceId_returned>/mode/mix/start' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: <http_basic_auth>' \
--data '{
  "cname": "show",
  "uid": "123",
  "clientRequest": {
    "token": "<your_token>",
    "recordingConfig": {
      "channelType": 1,
      "streamTypes": 2,
      "audioProfile": 2,
      "maxIdleTime": 30,
      "transcodingConfig": {
        "width": 640,
        "height": 640,
        "fps": 15,
        "bitrate": 800,
        "mixedVideoLayout": 0,
        "backgroundColor": "#000000"
      },
      "subscribeVideoUids": [
        "#allstream#"
      ],
      "subscribeAudioUids": [
        "#allstream#"
      ]
    },
    "recordingFileConfig": {
      "avFileType": [
        "hls",
        "mp4"
      ]
    },
    "storageConfig": {
      "vendor": 2,
      "region": 3,
      "bucket": "<your_storage_bucket_name>",
      "accessKey": "<your_storage_access_key>",
      "secretKey": "<your_storage_secret_key>",
      "fileNamePrefix": [
        "quickstart"
      ]
    }
  }
}'

云端录制支持设置的所有参数请参考 API 文档。

排查错误

本文向新手介绍如何使用声网 Go SDK 开始第一次云端录制。

Go SDK 旨在帮助开发者更轻松集成声网 RESTful API。该 SDK 具有如下特性：

简化通信流程：通过封装 RESTful API 的请求和响应处理，让你与 RESTful API 的通信更简单。
保障可用性：遇到 DNS 解析失败、网络错误、请求超时等网络问题时，会自动切换到最佳域名，确保 REST 服务的可用性。
API 易用性：提供简洁易懂的 API，让你能轻松实现开启云端录制、停止云端录制等常用功能。
其他优势：基于 Go 语言编写，具有高效性、并发性、可扩展性。

前提条件

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

Go 1.18 或以上版本。
参考开通云端录制服务在声网控制台开通云端录制，并复制保存 App ID、临时 Token、客户 ID 和客户密钥。

注意
临时 Token 的有效期是 24 小时。Token 过期会导致加入频道失败。
云端录制文件需要上传到第三方云存储。开始录制前，请开通第三方云存储服务，并获取 Bucket、Access Key、Secret Key 以备用。

在项目中实现了基础的音视频互动场景。你也可以参考文档使用声网实时互动 Web Demo 在浏览器中模拟一个音视频互动场景。

创建项目并安装 SDK

创建项目

参考如下步骤创建并配置新项目。

创建一个名为 test-recording 的空项目文件夹。
进入 test-recording 路径，执行如下命令初始化 Go 模块。
Shell
```
go mod init test-recording
```
在项目路径下，新建一个空的 main.go 文件，我们会在这个文件中实现一个极简的云端录制任务。

安装并引入 SDK

按照如下命令行安装需要的依赖库，并将 SDK 引入项目中。

在项目路径下，执行如下命令，安装 Go SDK。

Shell

# 安装 Go SDK
go get -u github.com/AgoraIO-Community/agora-rest-client-go
# 更新依赖
go mod tidy

安装完成后，在你的 main.go 文件中添加如下代码，以引入 Go SDK。

import (
  "context"
  "log"
  "time"

  "github.com/AgoraIO-Community/agora-rest-client-go/agora/auth"
  "github.com/AgoraIO-Community/agora-rest-client-go/agora/domain"
  agoraLogger "github.com/AgoraIO-Community/agora-rest-client-go/agora/log"
  "github.com/AgoraIO-Community/agora-rest-client-go/services/cloudrecording"
  cloudRecordingAPI "github.com/AgoraIO-Community/agora-rest-client-go/services/cloudrecording/api"
  "github.com/AgoraIO-Community/agora-rest-client-go/services/cloudrecording/req"
)

开始云端录制

本节介绍进行云端录制的极简流程。为方便说明，本节以录制之前模拟的音视频直播为例，并假设录制主播的音频和视频录制到 MP4 文件中。

定义变量

在 main.go 文件中，添加如下代码，定义或配置关键参数，取值参考前提条件。

// 定义关键参数
const (
  appId    = "<your_app_id>"
  cname    = "show"
  // 录制服务加入频道的用户 ID
  uid      = "123"
  // 客户 ID
  username = "<your_key>"
  // 客户密钥
  password = "<your_secret>"
  token    = "<your_token>"
)

// 配置云存储
var storageConfig = &cloudRecordingAPI.StorageConfig{
  Vendor:         2,
  Region:         1,
  Bucket:         "<your_storage_bucket_name>",
  AccessKey:      "<your_storage_access_key>",
  SecretKey:      "<your_storage_secret_key>",
  FileNamePrefix: []string{
    "quickstart",
  },
}

其中，

cname 值设为 show，表示加入录制实时音视频互动所在的频道。
Vendor 值设为 2 代表使用阿里云；Region 值设为 1 表示 CN_Shanghai。如果你使用其他云存储厂商，参考第三方云存储地区说明赋值。

创建并初始化 Client

在 main.go 文件中，添加如下代码，创建并初始化 Client。

// Initialize Cloud Recording Config
config := &cloudrecording.Config{
  AppID:      appId,
  Credential: auth.NewBasicAuthCredential(username, password),
  // Specify the region where the server is located. Options include CN, EU, AP, US.
  // The client will automatically switch to use the best domain based on the configured region.
  DomainArea: domain.CN,
  // Specify the log output level. Options include DebugLevel, InfoLevel, WarningLevel, ErrLevel.
  // To disable log output, set logger to DiscardLogger.
  Logger: agoraLogger.NewDefaultLogger(agoraLogger.DebugLevel),
}

// Initialize the cloud recording service client
cloudRecordingClient, err := cloudrecording.NewClient(config)
if err != nil {
  log.Fatal(err)
}

申请录制服务器资源

调用 acquire 申请录制服务器资源。你需要存储 resourceId 以备后用。

// Call the Acquire API of the cloud recording service client
acquireResp, err := cloudRecordingClient.MixRecording().
  Acquire(context.TODO(), cname, uid, &req.AcquireMixRecodingClientRequest{})
  // Handle non-business errors
if err != nil {
  log.Fatal(err)
}

// Handle business response
if acquireResp.IsSuccess() {
  log.Printf("acquire success:%+v\n", acquireResp)
} else {
  log.Fatalf("acquire failed:%+v\n", acquireResp)
}

开始录制

获取资源后，调用 start 开始录制。

// Call the Start API of the cloud recording service client
resourceId := acquireResp.SuccessRes.ResourceId
startResp, err := cloudRecordingClient.MixRecording().
  Start(context.TODO(), resourceId, cname, uid, &req.StartMixRecordingClientRequest{
    Token: token,
    RecordingConfig: &cloudRecordingAPI.RecordingConfig{
      ChannelType:  1,
    },
    RecordingFileConfig: &cloudRecordingAPI.RecordingFileConfig{
      AvFileType: []string{
        "hls",
        "mp4",
      },
    },
    StorageConfig: storageConfig,
  })

  // Handle non-business errors
if err != nil {
  log.Fatal(err)
}

// Handle business response
if startResp.IsSuccess() {
  log.Printf("start success:%+v\n", startResp)
} else {
  log.Fatalf("start failed:%+v\n", startResp)
}

sid := startResp.SuccessResponse.Sid

停止录制

完成录制后，调用 stop 结束录制。

// Call the Stop API of the cloud recording service client
stopResp, err := cloudRecordingClient.MixRecording().
  Stop(context.TODO(), resourceId, sid, cname, uid, true)
  // Handle non-business errors
if err != nil {
  log.Fatal(err)
}

// Handle business response
if stopResp.IsSuccess() {
  log.Printf("stop success:%+v\n", stopResp)
} else {
  log.Printf("stop failed:%+v\n", stopResp)
}

完整示例代码

main.go 文件中完整代码如下，你可自行比对：

查看录制文件

参考第三方云存储官方文档操作，查看云存储中的文件。根据 start 方法中 storageconfig.fileNamePrefix 参数的设置，录制生成文件位于 quickstart 目录下。如下截图以阿里云为例：

录制过程中生成了 .m3u8、.ts 和 mp4 文件。最终 quickstart 文件夹内包含如下：

Shell

.
├── <sid>_testchannel.m3u8
├── <sid>_testchannel_0.mp4
└── <sid>_testchannel_20241119070642248.ts

根据你在 start 方法中设置的录制时间，云存储中可能会有多个 .ts 文件。录制文件介绍请参考录制文件命名和切片规则。

进阶设置

startResp, err := cloudRecordingClient.MixRecording().
  Start(context.TODO(), resourceId, cname, uid, &mixrecording.StartMixRecordingClientRequest{
    Token: token,
    RecordingConfig: &cloudRecordingAPI.RecordingConfig{
      ChannelType:  1,
      StreamTypes:  2,
      MaxIdleTime:  30,
      AudioProfile: 2,
      TranscodingConfig: &cloudRecordingAPI.TranscodingConfig{
        Width:            640,
        Height:           640,
        FPS:              15,
        BitRate:          800,
        MixedVideoLayout: 0,
        BackgroundColor:  "#000000",
      },
      SubscribeAudioUIDs: []string{
        "#allstream#",
      },
      SubscribeVideoUIDs: []string{
        "#allstream#",
      },
    },
    RecordingFileConfig: &cloudRecordingAPI.RecordingFileConfig{
      AvFileType: []string{
        "hls",
        "mp4",
      },
    },
    StorageConfig: storageConfig,
  })

云端录制支持设置的所有参数请参考 API 文档。

参考信息

示例项目

完成快速开始后，你可以体验更多云端录制示例：

Gitee 示例项目

GitHub 示例项目

排查错误

本文向新手介绍如何使用声网 Java SDK 开始第一次云端录制。

Java SDK 旨在帮助开发者更轻松集成声网 RESTful API。该 SDK 具有如下特性：

简化通信流程：通过封装 RESTful API 的请求和响应处理，让你与 RESTful API 的通信更简单。
保障可用性：遇到 DNS 解析失败、网络错误、请求超时等网络问题时，会自动切换到最佳域名，确保 REST 服务的可用性。
API 易用性：提供简洁易懂的 API，让你能轻松实现开启云端录制、停止云端录制等常用功能。
其他优势：基于 Java 语言编写，具有高效性、并发性、可扩展性。

前提条件

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

Java 1.8 或以上版本。
参考开通云端录制服务在声网控制台开通云端录制，并复制保存 App ID、临时 Token、客户 ID 和客户密钥。

注意
临时 Token 的有效期是 24 小时。Token 过期会导致加入频道失败。
云端录制文件需要上传到第三方云存储。开始录制前，请开通第三方云存储服务，并获取 Bucket、Access Key、Secret Key 以备用。

在项目中实现了基础的音视频互动场景。你也可以参考文档使用声网实时互动 Web Demo 在浏览器中模拟一个音视频互动场景。

创建项目并安装 SDK

在你的 IDE 中创建一个 Java 项目。以 IntelliJ IDEA 为例，设置你的项目名称、保存路径，并将 Build system 设为 Maven。完成创建后，点击 Create。

在项目的 pom.xml 文件中的 <dependencies> 区域添加如下行，将 REST Client 的依赖添加到项目中：

XML

<dependencies>
    <dependency>
        <groupId>io.agora</groupId>
        <artifactId>agora-rest-client-core</artifactId>
        <version>0.5.0</version>
    </dependency>
</dependencies>

进行云端录制

本节介绍进行云端录制的极简流程。为方便说明，本节以录制之前模拟的音视频直播为例，并假设录制主播的音频和视频录制到 MP4 文件中。

定义变量

在 Main.java 文件中，添加如下代码，定义或配置关键参数，取值参考前提条件。

Java

public class Main {
    // 定义关键参数
    private static String appId = "<your_app_id>";
    private static String cname = "show";
    // 录制服务加入频道的用户 ID
    private static String uid = "123";
    // 客户 ID
    private static String username = "<your_customer_id>";
    // 客户密钥
    private static String password = "<your_customer_secret>";
    private static String token = "<your_token>";

    // 配置云存储
    private static String accessKey = "<your_storage_access_key>";
    private static String secretKey = "<your_storage_secret_key>";
    private static Integer region = 1;
    private static String bucket = "<your_storage_bucket_name>";
    private static Integer vendor = 2;
}

其中，

cname 值设为 show，表示加入录制实时音视频互动所在的频道。
vendor 值设为 2 代表使用阿里云；region 值设为 1 表示 CN_Shanghai。如果你使用其他云存储厂商，参考第三方云存储地区说明赋值。

创建并初始化 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 文件中完整代码如下，你可自行比对：

查看录制文件

录制过程中生成了 .m3u8、.ts 和 mp4 文件。最终 quickstart 文件夹内包含如下：

Shell

.
├── <sid>_testchannel.m3u8
├── <sid>_testchannel_0.mp4
└── <sid>_testchannel_20241119070642248.ts

根据你在 start 方法中设置的录制时间，云存储中可能会有多个 .ts 文件。录制文件介绍请参考录制文件命名和切片规则。

进阶设置

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 文档。

参考信息

示例项目

完成快速开始后，你可以体验更多云端录制示例：

Gitee 示例项目

GitHub 示例项目

排查错误

本文向新手介绍如何使用声网 Node.js SDK 开始第一次云端录制。

Node.js SDK 旨在帮助开发者更轻松集成声网 RESTful API。该 SDK 具有如下特性：

简化通信流程：通过封装 RESTful API 的请求和响应处理，让你与 RESTful API 的通信更简单。
保障可用性：遇到 DNS 解析失败、网络错误、请求超时等网络问题时，会自动切换到最佳域名，确保 REST 服务的可用性。
API 易用性：提供简洁易懂的 API，让你能轻松实现开启云端录制、停止云端录制等常用功能。
其他优势：基于 Node.js 语言编写，具有高效性、并发性、可扩展性。

前提条件

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

Node.js 18 或以上版本。
参考开通云端录制服务在声网控制台开通云端录制，并复制保存 App ID、临时 Token、客户 ID 和客户密钥。

注意
临时 Token 的有效期是 24 小时。Token 过期会导致加入频道失败。
云端录制文件需要上传到第三方云存储。开始录制前，请开通第三方云存储服务，并获取 Bucket、Access Key、Secret Key 以备用。

在项目中实现了基础的音视频互动场景。你也可以参考文档使用声网实时互动 Web Demo 在浏览器中模拟一个音视频互动场景。

创建项目并安装 SDK

创建项目

参考如下步骤创建并配置新项目。

创建一个名为 test-recording 的空文件夹。
进入 test-recording 文件路径，运行如下命令初始化项目：
Shell
```
npm init -y
```
完成初始化后，项目路径下会自动创建一个 package.json 文件。
在 test-recording/ 路径下，创建一个 src/index.ts 文件，我们会在这个文件中实现一个极简的云端录制任务。

添加 TypeScript 依赖

由于使用 .ts 文件，我们需要在项目文件夹中添加对 TypeScript 的依赖。

运行如下命令行安装 TypeScript：
Shell
```
npm install typescript @types/node
```
完成安装后项目路径下会自动创建一个 package-lock.json 文件。

配置 TypeScript 的运行环境。

运行如下命令行创建 TypeScript 配置文件：

Shell

npx tsc --init

完成后项目路径下会自动创建一个 tsconfig.json 文件。将 tsconfig.json 中的代码替换为如下行：

JSON

{
  "compileOnSave": true,
  "compilerOptions": {
    "allowSyntheticDefaultImports": true,
    "experimentalDecorators": true,
    "module": "CommonJS",
    "moduleResolution": "node",
    "noImplicitAny": false,
    "noUnusedLocals": false,
    "noUnusedParameters": false,
    "removeComments": false,
    "resolveJsonModule": true,
    "skipLibCheck": true,
    "strictNullChecks": true,
    "target": "ES2015",
    "baseUrl": ".",
    "outDir": "dist",
    "rootDir": "./src",
    "sourceMap": true,
    "declaration": true
  },
  "include": ["./src"],
  "exclude": ["__tests__"]
}

运行如下命令行创建一个 TypeScript 建构文件：
Shell
```
touch tsconfig.build.json
```
将 tsconfig.build.json 中的代码替换为如下行：
JSON
```
{
  "extends": "./tsconfig",
  "compilerOptions": {
    "sourceMap": false
  }
}
```

在根目录的 package.json 文件的 scripts 区域，添加如下行：
JSON
```
"build": "tsc --project tsconfig.build.json &&node dist/index.js"
```

添加 REST Client 依赖库

运行如下命令行添加依赖：

Shell

npm install agora-rest-client

完成添加后，项目文件下会添加一个 node_modules 文件包。

开始云端录制

本节介绍进行云端录制的极简流程。为方便说明，本节以录制之前模拟的音视频直播为例，并假设将主播的音频和视频录制到 MP4 文件中。

引入依赖

在 src/index.ts 中添加如下行，引入 agora-rest-client 及相关代码模块：

TypeScript

import {
  DomainArea,
  BasicCredential,
  CloudRecordingClient,
  AcquireResourceRes,
  StartResourceRes,
  RecordingRequestChannelTypeEnum,
  QueryMixHLSAndMP4RecordingResourceRes,
  StopResourceRes,
} from "agora-rest-client";

定义变量

继续添加如下代码，定义和配置关键参数。取值参考前提条件。

TypeScript

// 定义关键参数
const appId = "<your_app_id>";
const cname = "show";
// 录制服务加入频道的用户 ID
const uid = "123";
// 客户 ID
const username = "<your_customer_id>";
// 客户密钥
const password = "<your_customer_secret>";
const token = "<your_token>";

// 配置云存储
const storageConfig = {
  vendor: parseInt("2", 10),
  region: parseInt("1", 10),
  bucket: "<your_storage_bucket_name>",
  accessKey: "<your_storage_access_key>",
  secretKey: "<your_storage_secret_key>",
  fileNamePrefix: ["quickstart"],
};

其中，

cname 值设为 show，表示加入录制实时音视频互动所在的频道。
vendor 值设为 2 代表使用阿里云；region 值设为 1 表示 CN_Shanghai。如果你使用其他云存储厂商，参考第三方云存储地区说明赋值。

创建并初始化 Client

在 src/index.ts 中，添加如下代码，创建并初始化 Client。

TypeScript

const credential = new BasicCredential(username, password);

const cloudRecordingClient = new CloudRecordingClient({
  appId,
  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,
});

申请录制服务器资源

调用 acquire 申请录制服务器资源。

TypeScript

// Acquire resource
let acquireResourceRes: AcquireResourceRes;
try {
  acquireResourceRes = await cloudRecordingClient
    .mixScenario()
    .acquire(cname, uid, {
      resourceExpiredHour: 1,
    });
} catch (error) {
  console.error("Failed to acquire resource", error);
  return;
}

if (!acquireResourceRes.resourceId) {
  console.error("Resource ID is missing");
  return;
}

console.info(
  `acquire resource success,res:${JSON.stringify(acquireResourceRes)}`
);

开始录制

获取资源后，调用 start 开始录制：

TypeScript

// Start resource
let startResourceRes: StartResourceRes;
try {
  startResourceRes = await cloudRecordingClient
    .mixScenario()
    .start(cname, uid, acquireResourceRes.resourceId, {
      token,
      recordingConfig: {
        channelType: RecordingRequestChannelTypeEnum.Live,
      },
      recordingFileConfig: {
        avFileType: ["hls", "mp4"],
      },
      storageConfig,
    });
} catch (error) {
  console.error("Failed to start resource", error);
  return;
}

if (!startResourceRes.sid) {
  console.error("SID is missing");
  return;
}

console.info(
  `start resource success,res:${JSON.stringify(startResourceRes)}`
);

停止录制

完成录制后，调用 stop 结束录制。

TypeScript

// Stop resource
let stopResourceRes: StopResourceRes;
try {
  stopResourceRes = await cloudRecordingClient
    .mixScenario()
    .stop(
      cname,
      uid,
      acquireResourceRes.resourceId,
      startResourceRes.sid,
      true
    );
} catch (error) {
  console.error("Failed to stop resource", error);
  return;
}

console.info(`stop resource success,res:${JSON.stringify(stopResourceRes)}`);

完整示例代码

src/index.ts 文件中完整代码如下，你可以自行比对：

查看录制文件

参考第三方云存储官方文档操作，查看云存储中的文件。根据 storageConfig.fileNamePrefix 参数的设置，录制生成文件位于 quickstart 目录下。如下截图以阿里云为例：

录制过程中生成了 .m3u8、.ts 和 mp4 文件。最终 quickstart 文件夹内包含如下：

Shell

.
├── <sid>_testchannel.m3u8
├── <sid>_testchannel_0.mp4
└── <sid>_testchannel_20241119070642248.ts

根据你在 start 方法中设置的录制时间，云存储中可能会有多个 .ts 文件。录制文件介绍请参考录制文件命名和切片规则。

进阶设置

TypeScript

startResourceRes = await cloudRecordingClient
  .mixeScenario()
  .start(cname, uid, acquireResourceRes.resourceId, {
    token,
    recordingConfig: {
      channelType: RecordingRequestChannelTypeEnum.Live,
      streamTypes: 2,
      maxIdleTime: 30,
      audioProfile: 2,
      transcodingConfig: {
        width: 640,
        height: 480,
        fps: 15,
        bitrate: 800,
        mixedVideoLayout: 0,
        backgroundColor: "#000000",
      },
      subscribeAudioUids: ["#allstream#"],
      subscribeVideoUids: ["#allstream#"],
    },

    recordingFileConfig: {
      avFileType: ["hls", "mp4"],
    },
    storageConfig,
  });

前提条件Copy Anchor Link

开通服务并获取关键参数Copy Anchor Link

开通第三方云存储Copy Anchor Link

开通方式

模拟音视频互动场景Copy Anchor Link

进行云端录制Copy Anchor Link

申请录制服务器资源Copy Anchor Link

请求Copy Anchor Link

响应Copy Anchor Link

开始录制Copy Anchor Link

请求Copy Anchor Link

响应Copy Anchor Link

查看录制文件Copy Anchor Link

进阶设置Copy Anchor Link

排查错误Copy Anchor Link

咨询电话

咨询电话

前提条件

开通服务并获取关键参数

开通第三方云存储

模拟音视频互动场景

进行云端录制

申请录制服务器资源

请求

响应

开始录制

请求

响应

查看录制文件

进阶设置

排查错误