# 结构体 (/zh-CN/api-reference/cloud-recording/java-api/struct.java)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## CloudRecordingConfig [#cloudrecordingconfig]
```java
public class CloudRecordingConfig {
private final String appId;
private final Credential credential;
private final DomainArea domainArea;
private final HttpProperty httpProperty;
}
```
用于配置云端录制客户端的参数信息。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `appId` | `String` | 声网 App ID。 |
| `credential` | `Credential` | 用于访问声网服务的认证信息。支持的认证类型包括:[`BasicAuthCredential`](/zh-CN/api-reference/cloud-recording/java-api/basicauthcredential.java)。 |
| `domainArea` | `DomainArea` | REST Client的区域信息,详见 [`DomainArea`](/zh-CN/api-reference/cloud-recording/java-api/enum.java#domainarea)。 |
| `httpProperty` | `HttpProperty` | REST Client的 HTTP 属性,详见 [`HttpProperty`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#httpproperty)。 |
## AcquireIndividualResourceClientReq [#acquireindividualresourceclientreq]
```java
public class AcquireIndividualResourceClientReq {
private Integer resourceExpiredHour;
private List excludeResourceIds;
private Integer regionAffinity;
private StartIndividualRecordingClientReq startParameter;
}
```
用于获取单流录制资源的客户端请求。
:::info[信息]
自 v0.4.0 版本新增。
:::
用于申请云端录制所需的资源。
#### 成员参数 [#成员参数-1]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `resourceExpiredHour` | `Integer` | 调用云端录制 RESTful API 的有效期(单位为小时)。将在成功启动云端录制服务并获得记录 ID(`sid`)后开始计算。取值范围为 [1, 720],默认值为 72。 |
| `excludeResourceIds` | `List` | 其他一个或多个录制任务的 `resourceId`。 |
| `regionAffinity` | `Integer` | [struct-java-html-1-3-2 details](#table-slot-struct-java-html-1-3-2) |
| `startParameter` | `StartIndividualRecordingClientReq` | 启动参数,用于提升可用性与优化负载均衡。详见 [`StartIndividualRecordingClientReq`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#startindividualrecordingclientreq)。 |
**struct-java-html-1-3-2 details**
指定云端录制服务可访问的区域。
- 0:距离请求源最近(默认)。
- 1:中国。
- 2:东南亚。
- 3:欧洲。
- 4:北美。
## StartIndividualRecordingClientReq [#startindividualrecordingclientreq]
```java
public class StartIndividualRecordingClientReq {
private String token;
private StartResourceReq.AppsCollection appsCollection;
private StartResourceReq.RecordingConfig recordingConfig;
private StartResourceReq.TranscodeOptions transcodeOptions;
private StartResourceReq.RecordingFileConfig recordingFileConfig;
private StartResourceReq.SnapshotConfig snapshotConfig;
private StartResourceReq.StorageConfig storageConfig;
}
```
用于发起单人录制的客户端请求。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-2]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `token` | `String` | (可选)声网 App Token。 |
| `appsCollection` | `StartResourceReq.AppsCollection` | (可选)应用配置信息。详见 [`AppsCollection`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#startresourcereq.appscollection)。 |
| `recordingConfig` | `StartResourceReq.RecordingConfig` | (可选)录制的音视频流配置。详见 [`RecordingConfig`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#startresourcereq.recordingconfig)。 |
| `transcodeOptions` | `StartResourceReq.TranscodeOptions` | (可选)延后转码或音频合成生成的录制文件配置。详见 [`TranscodeOptions`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#startresourcereq.transcodeoptions)。 |
| `recordingFileConfig` | `StartResourceReq.RecordingFileConfig` | (可选)录制文件配置。详见 [`RecordingFileConfig`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#startresourcereq.recordingfileconfig)。 |
| `snapshotConfig` | `StartResourceReq.SnapshotConfig` | (可选)截图采集配置。详见 [`SnapshotConfig`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#startresourcereq.snapshotconfig)。 |
| `storageConfig` | `StartResourceReq.StorageConfig` | (必填)第三方云存储配置。详见 [`StorageConfig`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#startresourcereq.storageconfig)。 |
## UpdateIndividualRecordingResourceClientReq [#updateindividualrecordingresourceclientreq]
```java
public class UpdateIndividualRecordingResourceClientReq {
private UpdateResourceReq.StreamSubscribe streamSubscribe;
}
```
用于更新单流录制资源的客户端请求。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-3]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `streamSubscribe` | `UpdateResourceReq.StreamSubscribe` | (可选)更新订阅列表,详见 [`StreamSubscribe`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#updateresourcereq.streamsubscribe)。 |
## AcquireWebRecordingResourceClientReq [#acquirewebrecordingresourceclientreq]
```java
public class AcquireWebRecordingResourceClientReq {
private Integer resourceExpiredHour;
private List excludeResourceIds;
private Integer regionAffinity;
private StartWebRecordingResourceClientReq startParameter;
}
```
用于获取页面录制资源的客户端请求类。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-4]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `resourceExpiredHour` | `Integer` | 调用云端录制 RESTful API 的有效期(单位为小时)。该值从成功启动页面录制服务并获取 `sid`(录制 ID)后开始计算。取值范围为 [1, 720],默认值为 72。 |
| `excludeResourceIds` | `List` | 其他一个或多个页面录制任务的 `resourceId`。 |
| `regionAffinity` | `Integer` | [struct-java-html-4-3-2 details](#table-slot-struct-java-html-4-3-2) |
| `startParameter` | `StartWebRecordingResourceClientReq` | 启动参数,用于提升可用性并优化负载均衡。详见 [`StartWebRecordingResourceClientReq`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#startwebrecordingresourceclientreq)。 |
**struct-java-html-4-3-2 details**
指定页面录制服务可访问的区域。
- 0:(默认)离发起请求最近的区域。
- 1:中国大陆。
- 2:东南亚。
- 3:欧洲。
- 4:北美。
## StartWebRecordingResourceClientReq [#startwebrecordingresourceclientreq]
```java
public class StartWebRecordingResourceClientReq {
private StartResourceReq.StorageConfig storageConfig;
private StartResourceReq.RecordingFileConfig recordingFileConfig;
private StartResourceReq.ExtensionServiceConfig extensionServiceConfig;
}
```
用于发起启动页面录制的客户端请求。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-5]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `storageConfig` | `StartResourceReq.StorageConfig` | (必填)第三方云端 Storage 配置,详见 [`StorageConfig`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#startresourcereq.storageconfig)。 |
| `recordingFileConfig` | `StartResourceReq.RecordingFileConfig` | (可选)录制文件配置,详见 [`RecordingFileConfig`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#startresourcereq.recordingfileconfig)。 |
| `extensionServiceConfig` | `StartResourceReq.ExtensionServiceConfig` | (可选)扩展服务配置,详见 [`ExtensionServiceConfig`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#startresourcereq.extensionserviceconfig)。 |
## UpdateWebRecordingResourceClientReq [#updatewebrecordingresourceclientreq]
```java
public class UpdateWebRecordingResourceClientReq {
private UpdateResourceReq.WebRecordingConfig webRecordingConfig;
private UpdateResourceReq.RtmpPublishConfig rtmpPublishConfig;
}
```
用于更新页面录制资源的客户端请求。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-6]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `webRecordingConfig` | `UpdateResourceReq.WebRecordingConfig` | 页面录制配置,详见 [`WebRecordingConfig`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#updateresourcereq.webrecordingconfig)。 |
| `rtmpPublishConfig` | `UpdateResourceReq.RtmpPublishConfig` | CDN 推流配置,详见 [`RtmpPublishConfig`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#updateresourcereq.rtmppublishconfig)。 |
## AcquireMixRecordingResourceClientReq [#acquiremixrecordingresourceclientreq]
```java
public class AcquireMixRecordingResourceClientReq {
private Integer resourceExpiredHour;
private List excludeResourceIds;
private Integer regionAffinity;
private StartMixRecordingResourceClientReq startParameter;
}
```
用于客户端获取合流录制资源的请求。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-7]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `resourceExpiredHour` | `Integer` | 调用云端录制 RESTful API 的有效期。该值从成功启动云端录制服务并获取 `sid`(录制 ID)后开始计算,单位为小时。取值范围为 [1, 720],默认值为 72。 |
| `excludeResourceIds` | `List` | 其他一个或多个录制任务的 `resourceId`。 |
| `regionAffinity` | `Integer` | [struct-java-html-7-3-2 details](#table-slot-struct-java-html-7-3-2) |
| `startParameter` | `StartMixRecordingResourceClientReq` | 启动参数,用于提升可用性和优化负载均衡。详见 [`StartMixRecordingResourceClientReq`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#startmixrecordingresourceclientreq)。 |
**struct-java-html-7-3-2 details**
指定云端录制服务可访问的区域。
- 0:(默认)最靠近请求源。
- 1:中国大陆。
- 2:东南亚。
- 3:欧洲。
- 4:北美。
## StartMixRecordingResourceClientReq [#startmixrecordingresourceclientreq]
```java
public class StartMixRecordingResourceClientReq {
private String token;
private StartResourceReq.StorageConfig storageConfig;
private StartResourceReq.RecordingConfig recordingConfig;
private StartResourceReq.RecordingFileConfig recordingFileConfig;
}
```
用于启动合流录制的客户端请求。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-8]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `token` | `String` | (可选)用于身份验证的 Token。 |
| `storageConfig` | `StartResourceReq.StorageConfig` | (必填)第三方云存储的配置。详见 [`StorageConfig`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#startresourcereq.storageconfig)。 |
| `recordingConfig` | `StartResourceReq.RecordingConfig` | (可选)录制的音视频流配置。详见 [`RecordingConfig`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#startresourcereq.recordingconfig)。 |
| `recordingFileConfig` | `StartResourceReq.RecordingFileConfig` | (可选)录制文件的配置。详见 [`RecordingFileConfig`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#startresourcereq.recordingfileconfig)。 |
## UpdateMixRecordingResourceClientReq [#updatemixrecordingresourceclientreq]
```java
public class UpdateMixRecordingResourceClientReq {
private UpdateResourceReq.StreamSubscribe streamSubscribe;
}
```
用于更新合流录制设置的客户端请求。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-9]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `streamSubscribe` | `UpdateResourceReq.StreamSubscribe` | (可选)更新订阅流的列表。详见 [`StreamSubscribe`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#updateresourcereq.streamsubscribe)。 |
## UpdateLayoutMixRecordingResourceClientReq [#updatelayoutmixrecordingresourceclientreq]
```java
public class UpdateLayoutMixRecordingResourceClientReq {
private String maxResolutionUID;
private int mixedVideoLayout;
private String backgroundColor;
private String backgroundImage;
private String defaultUserBackgroundImage;
private List layoutConfig;
private List backgroundConfig;
}
```
用于客户端更新合流录制布局的请求。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-10]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `maxResolutionUID` | `String` | (可选)仅在竖屏布局下需设置。指定大画面视频窗口的用户 ID。 |
| `mixedVideoLayout` | `int` | [struct-java-html-10-2-2 details](#table-slot-struct-java-html-10-2-2) |
| `backgroundColor` | `String` | (可选)视频画布的背景颜色。支持 RGB 颜色,格式为 “#” 加 6 位十六进制字符。默认值为 “#000000”,表示黑色。 |
| `backgroundImage` | `String` | (可选)视频画布的背景图像。背景图显示模式为裁剪模式:优先填满画布,图像等比例缩放直至填满整个画布,若图像宽高比与画布不同,则边缘将被裁剪以适配。 |
| `defaultUserBackgroundImage` | `String` | (可选)默认的用户视频画面背景图 URL。当用户停止发送视频流超过 3.5 秒时,画面将切换为该背景图。若为某个 `UID` 单独设置了背景图,该设置将被覆盖。 |
| `layoutConfig` | `List` | (可选)用户的视频混图布局配置。每个用户的屏幕布局设置数组,最多支持 17 个用户。详见 [`LayoutConfig`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#updatelayoutresourcereq.layoutconfig)。 |
| `backgroundConfig` | `List` | (可选)背景配置。通过该字段设置视频窗口的背景。详见 [`BackgroundConfig`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#updatelayoutresourcereq.backgroundconfig)。 |
**struct-java-html-10-2-2 details**
(可选)合流视频布局类型。支持以下取值:
- 0:(默认)浮动布局。最先加入频道的用户显示为大窗口,填满画布,其他用户的视频以小窗口形式从下往上横向排列,最多支持 4 行,每行 4 个窗口,最多支持 17 个用户的视频窗口。
- 1:自适应布局。根据用户数量自动调整每个用户的视频窗口尺寸,所有用户窗口大小一致,最多支持 17 个窗口。
- 2:竖屏布局。通过设置 `maxResolutionUID` 显示左侧的大窗口,其他用户的视频窗口在右侧垂直排列,最多 2 列,每列最多 8 个窗口,总共最多 17 个窗口。
- 3:自定义布局。通过设置 `layoutConfig` 字段实现自定义合流布局。
#### QueryIndividualRecordingResourceRes [#queryindividualrecordingresourceres]
```java
public class QueryIndividualRecordingResourceRes {
private String cname;
private String uid;
private String resourceId;
private String sid;
private QueryResourceRes.QueryIndividualRecordingServerResponse serverResponse;
}
```
返回单流录制查询 API 的响应信息。
:::info[信息]
自 v0.4.0 版本新增。
:::
##### 成员参数 [#成员参数-11]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `cname` | `String` | 待录制的频道名。 |
| `uid` | `String` | 云端录制服务在 RTC 频道中用于标识录制服务的用户 ID。 |
| `resourceId` | `String` | 资源的唯一标识符。 |
| `sid` | `String` | 录制任务的唯一标识符。 |
| `serverResponse` | `QueryResourceRes.QueryIndividualRecordingServerResponse` | 服务器响应,详见 [`QueryIndividualRecordingServerResponse`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#queryresourceres.queryindividualrecordingserverresponse)。 |
## QueryIndividualRecordingVideoScreenshotResourceRes [#queryindividualrecordingvideoscreenshotresourceres]
```java
public class QueryIndividualRecordingVideoScreenshotResourceRes {
private String cname;
private String uid;
private String resourceId;
private String sid;
private QueryResourceRes.QueryIndividualVideoScreenshotServerResponse serverResponse;
}
```
用于返回单流录制 [`queryVideoScreenshot`](/zh-CN/api-reference/cloud-recording/java-api/individualscenario.java#queryresourceresqueryvideoscreenshot) API 响应的类。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-12]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `cname` | `String` | 频道名。 |
| `uid` | `String` | 云端录制服务在 RTC 频道中使用的用户 ID,用于标识频道中的录制服务。 |
| `resourceId` | `String` | 资源的唯一标识符。 |
| `sid` | `String` | 录制会话的唯一标识符。 |
| `serverResponse` | `QueryResourceRes.QueryIndividualVideoScreenshotServerResponse` | 服务器返回的信息,详见 [`QueryIndividualVideoScreenshotServerResponse`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#queryresourceres.queryindividualvideoscreenshotserverresponse)。 |
## QueryWebRecordingResourceRes [#querywebrecordingresourceres]
```java
public class QueryWebRecordingResourceRes {
private String cname;
private String uid;
private String resourceId;
private String sid;
private QueryResourceRes.WebRecordingServerResponse serverResponse;
}
```
页面录制资源查询 API 返回的响应。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-13]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `cname` | `String` | 频道名。 |
| `uid` | `String` | 云端录制服务在 RTC 频道中用于标识录制服务的用户 ID。 |
| `resourceId` | `String` | 资源的唯一标识符。 |
| `sid` | `String` | 录制会话的唯一标识符。 |
| `serverResponse` | `QueryResourceRes.WebRecordingServerResponse` | 服务器响应,详见 [`WebRecordingServerResponse`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#queryresourceres.webrecordingserverresponse)。 |
## QueryWebRecordingRtmpPublishResourceRes [#querywebrecordingrtmppublishresourceres]
```java
public class QueryWebRecordingRtmpPublishResourceRes {
private String cname;
private String uid;
private String resourceId;
private String sid;
private QueryResourceRes.WebRecordingRtmpPublishServerResponse serverResponse;
}
```
[`queryRtmpPublish`](/zh-CN/api-reference/cloud-recording/java-api/webscenario.java#queryrtmppublish) API 返回的页面录制 RTMP 推流资源响应信息。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-14]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `cname` | `String` | 待录制的频道名。 |
| `uid` | `String` | 云端录制服务在 RTC 频道中使用的用户 ID,用于标识录制服务。 |
| `resourceId` | `String` | 资源的唯一标识符。 |
| `sid` | `String` | 录制会话的唯一标识符。 |
| `serverResponse` | `QueryResourceRes.WebRecordingRtmpPublishServerResponse` | 服务端响应。详见 [`WebRecordingRtmpPublishServerResponse`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#queryresourceres.webrecordingrtmppublishserverresponse)。 |
## QueryMixHLSRecordingResourceRes [#querymixhlsrecordingresourceres]
```java
public class QueryMixHLSRecordingResourceRes {
private String cname;
private String uid;
private String resourceId;
private String sid;
private QueryResourceRes.MixRecordingHLSServerResponse serverResponse;
}
```
查询合流录制 HLS 的接口返回的响应信息。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-15]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `cname` | `String` | 频道名。 |
| `uid` | `String` | 云端录制服务在 RTC 频道中用于标识录制服务的用户 ID。 |
| `resourceId` | `String` | 资源的唯一标识符。 |
| `sid` | `String` | 录制会话的唯一标识符。 |
| `serverResponse` | `QueryResourceRes.MixRecordingHLSServerResponse` | 服务器的响应信息,详见 [`MixRecordingHLSServerResponse`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#queryresourceres.mixrecordinghlsserverresponse)。 |
## QueryMixHLSAndMP4RecordingResourceRes [#querymixhlsandmp4recordingresourceres]
```java
public class QueryMixHLSAndMP4RecordingResourceRes {
private String cname;
private String uid;
private String resourceId;
private String sid;
private QueryResourceRes.MixRecordingHLSAndMP4ServerResponse serverResponse;
}
```
返回合流录制 [`queryHLSAndMP4`](/zh-CN/api-reference/cloud-recording/java-api/mixscenario.java#queryhlsandmp4) API 的响应。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-16]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `cname` | `String` | 频道名。 |
| `uid` | `String` | 云端录制服务在 RTC 频道中用于标识录制服务的用户 ID。 |
| `resourceId` | `String` | 资源的唯一标识符。 |
| `sid` | `String` | 录制会话的唯一标识符。 |
| `serverResponse` | `QueryResourceRes.MixRecordingHLSAndMP4ServerResponse` | 服务器响应,详见 [`MixRecordingHLSAndMP4ServerResponse`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#queryresourceres.mixrecordinghlsandmp4serverresponse)。 |
## AcquireResourceRes [#acquireresourceres]
```java
public class AcquireResourceRes {
@JsonProperty("cname")
private String cname;
@JsonProperty("uid")
private String uid;
@JsonProperty("resourceId")
private String resourceId;
}
```
获取云端录制资源接口的返回结果。
:::info[信息]
自 v0.4.0 版本新增。
:::
表示获取云端录制资源接口的返回结果对象。
#### 成员参数 [#成员参数-17]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `cname` | `String` | 要录制的频道名称。 |
| `uid` | `String` | 用于在 RTC 频道中标识云端录制服务的用户 ID。 |
| `resourceId` | `String` | 资源的唯一标识符。 |
## StartResourceRes [#startresourceres]
```java
public class StartResourceRes {
@JsonProperty("cname")
private String cname;
@JsonProperty("uid")
private String uid;
@JsonProperty("resourceId")
private String resourceId;
@JsonProperty("sid")
private String sid;
}
```
启动各类云端录制场景的 API 返回的响应数据。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-18]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `cname` | `String` | 待录制的频道名称。 |
| `uid` | `String` | 云端录制服务在 RTC 频道中使用的用户 ID,用于标识频道中的录制服务。 |
| `resourceId` | `String` | 资源的唯一标识符。 |
| `sid` | `String` | 录制会话的唯一标识符。 |
## StopResourceRes [#stopresourceres]
```java
public class StopResourceRes {
@JsonProperty("cname")
private String cname;
@JsonProperty("uid")
private String uid;
@JsonProperty("resourceId")
private String resourceId;
@JsonProperty("sid")
private String sid;
}
```
云端录制多种场景停止后返回的结果。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-19]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `cname` | `String` | 待录制的频道名称。 |
| `uid` | `String` | 云端录制服务在 RTC 频道中用于标识录制服务的用户 ID。 |
| `resourceId` | `String` | 资源的唯一标识符。 |
| `sid` | `String` | 录制会话的唯一标识符。 |
## UpdateResourceRes [#updateresourceres]
```java
public class UpdateResourceRes {
@JsonProperty("cname")
private String cname;
@JsonProperty("uid")
private String uid;
@JsonProperty("resourceId")
private String resourceId;
@JsonProperty("sid")
private String sid;
}
```
表示云端录制场景中 `update` API 的返回结果。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-20]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `cname` | `String` | 要录制的频道名称。 |
| `uid` | `String` | 云端录制服务在 RTC 频道中用于标识录制服务的用户 ID。 |
| `resourceId` | `String` | 资源的唯一标识符。 |
| `sid` | `String` | 录制会话的唯一标识符。 |
## UpdateLayoutResourceRes [#updatelayoutresourceres]
```java
public class UpdateLayoutResourceRes {
@JsonProperty("cname")
private String cname;
@JsonProperty("uid")
private String uid;
@JsonProperty("resourceId")
private String resourceId;
@JsonProperty("sid")
private String sid;
}
```
合流录制 [`updateLayout`](/zh-CN/api-reference/cloud-recording/java-api/mixscenario.java#updatelayout) API 的返回结果。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-21]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `cname` | `String` | 要录制的频道名称。 |
| `uid` | `String` | 云端录制服务在 RTC 频道中用于标识录制服务的用户 ID。 |
| `resourceId` | `String` | 资源的唯一标识符。 |
| `sid` | `String` | 录制会话的唯一标识符。 |
## QueryResourceRes [#queryresourceres]
```java
public class QueryResourceRes {
@JsonProperty("cname")
private String cname;
@JsonProperty("uid")
private String uid;
@JsonProperty("resourceId")
private String resourceId;
private String sid;
}
```
用于各类云端录制场景中查询 API 返回的响应类。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-22]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `cname` | `String` | 待录制的频道名称。 |
| `uid` | `String` | 云端录制服务在 RTC 频道中使用的用户 ID,用于标识该频道中的录制服务。 |
| `resourceId` | `String` | 资源的唯一标识符。 |
| `sid` | `String` | 录制会话的唯一标识符。 |
#### QueryIndividualRecordingServerResponse [#queryindividualrecordingserverresponse]
```java
public static class QueryIndividualRecordingServerResponse {
@JsonProperty("status")
private Integer status;
@JsonProperty("fileListMode")
private String fileListMode;
@JsonProperty("fileList")
private List fileList;
@JsonProperty("sliceStartTime")
private Long sliceStartTime;
}
```
单流录制查询接口的服务端响应。
:::info[信息]
自 v0.4.0 版本新增。
:::
用于描述服务端在调用单流录制查询接口时返回的内容,包括云服务状态、文件列表格式和录制开始时间等信息。
##### 成员参数 [#成员参数-23]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `status` | `Integer` | [struct-java-html-23-1-2 details](#table-slot-struct-java-html-23-1-2) |
| `fileListMode` | `String` | [struct-java-html-23-2-2 details](#table-slot-struct-java-html-23-2-2) |
| `fileList` | `List` | 文件列表。详见 [`FileDetail`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#queryindividualrecordingserverresponse.filedetail)。 |
| `sliceStartTime` | `Long` | 文件的录制开始时间,Unix 时间戳,单位为秒。 |
**struct-java-html-23-1-2 details**
云服务的当前状态:
- 0:云服务尚未启动。
- 1:云服务初始化完成。
- 2:云服务组件正在启动。
- 3:部分云服务组件准备就绪。
- 4:全部云服务组件准备就绪。
- 5:云服务运行中。
- 6:云服务接收到停止请求。
- 7:云服务的所有组件停止运行。
- 8:云服务退出。
- 20:云服务异常退出。
**struct-java-html-23-2-2 details**
fileList 字段的数据格式:
- "string":fileList 为字符串类型。在合流录制模式下,若 avFileType 设置为 `["hls"]`,则 fileListMode 为 "string"。
- "json":fileList 为 JSON 数组。当 avFileType 设置为 `["hls", "mp4"]`,在单流录制或合流录制模式下,fileListMode 设置为 "json"。
#### FileDetail [#filedetail]
```java
public static class FileDetail {
@JsonProperty("fileName")
private String fileName;
@JsonProperty("trackType")
private String trackType;
@JsonProperty("uid")
private String uid;
@JsonProperty("mixedAllUser")
private Boolean mixedAllUser;
@JsonProperty("isPlayable")
private Boolean isPlayable;
@JsonProperty("sliceStartTime")
private Long sliceStartTime;
}
```
描述录制过程中生成的 M3U8 和 MP4 文件的详细信息。
:::info[信息]
自 v0.4.0 版本新增。
:::
##### 成员参数 [#成员参数-24]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `fileName` | `String` | 录制过程中生成的 M3U8 或 MP4 文件的文件名。 |
| `trackType` | `String` | [struct-java-html-24-2-2 details](#table-slot-struct-java-html-24-2-2) |
| `uid` | `String` | 用户的 UID,表示录制的是哪个用户的音频或视频流。在合流录制模式下,该值为 "0"。 |
| `mixedAllUser` | `Boolean` | [struct-java-html-24-4-2 details](#table-slot-struct-java-html-24-4-2) |
| `isPlayable` | `Boolean` | [struct-java-html-24-5-2 details](#table-slot-struct-java-html-24-5-2) |
| `sliceStartTime` | `Long` | 文件的录制开始时间,单位为秒的 Unix 时间戳。 |
**struct-java-html-24-2-2 details**
录制的文件类型:
- "audio":仅音频文件。
- "video":仅视频文件。
- "audio_and_video":音视频文件。
**struct-java-html-24-4-2 details**
是否为合流录制:
- true:所有用户的音视频录制在一个文件中。
- false:分别录制每个用户的音视频。
**struct-java-html-24-5-2 details**
文件是否支持在线播放:
- true:支持在线播放。
- false:不支持在线播放。
#### QueryIndividualVideoScreenshotServerResponse [#queryindividualvideoscreenshotserverresponse]
```java
public static class QueryIndividualVideoScreenshotServerResponse {
@JsonProperty("status")
private Integer status;
@JsonProperty("sliceStartTime")
private Long sliceStartTime;
}
```
用于接收单流录制 [`queryVideoScreenshot`](/zh-CN/api-reference/cloud-recording/java-api/individualscenario.java#queryvideoscreenshot) API 的服务器响应。
:::info[信息]
自 v0.4.0 版本新增。
:::
表示调用 [`queryVideoScreenshot`](/zh-CN/api-reference/cloud-recording/java-api/individualscenario.java#queryvideoscreenshot) 后云端返回的响应结果。
##### 成员参数 [#成员参数-25]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `status` | `Integer` | [struct-java-html-25-1-2 details](#table-slot-struct-java-html-25-1-2) |
| `sliceStartTime` | `Long` | 文件的录制起始时间,单位为 Unix 时间戳(秒)。 |
**struct-java-html-25-1-2 details**
云服务的当前状态:
- 0:云服务未启动。
- 1:云服务初始化完成。
- 2:云服务组件启动中。
- 3:部分云服务组件已就绪。
- 4:所有云服务组件已就绪。
- 5:云服务运行中。
- 6:云服务接收到停止请求。
- 7:所有云服务组件已停止。
- 8:云服务已退出。
- 20:云服务异常退出。
#### MixRecordingHLSServerResponse [#mixrecordinghlsserverresponse]
```java
public static class MixRecordingHLSServerResponse {
@JsonProperty("status")
private Integer status;
@JsonProperty("fileListMode")
private String fileListMode;
@JsonProperty("fileList")
private String fileList;
@JsonProperty("sliceStartTime")
private Long sliceStartTime;
}
```
用于合流录制查询 HLS API 的服务端响应。
:::info[信息]
自 v0.4.0 版本新增。
:::
#### 成员参数 [#成员参数-26]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `status` | `Integer` | [struct-java-html-26-1-2 details](#table-slot-struct-java-html-26-1-2) |
| `fileListMode` | `String` | [struct-java-html-26-2-2 details](#table-slot-struct-java-html-26-2-2) |
| `fileList` | `String` | 文件列表。 |
| `sliceStartTime` | `Long` | 文件的录制开始时间,Unix 时间戳,单位为秒。 |
**struct-java-html-26-1-2 details**
云服务当前状态:
- 0:云服务未启动。
- 1:云服务初始化完成。
- 2:云服务组件启动中。
- 3:部分云服务组件就绪。
- 4:全部云服务组件就绪。
- 5:云服务进行中。
- 6:云服务收到停止请求。
- 7:全部云服务组件停止。
- 8:云服务已退出。
- 20:云服务异常退出。
**struct-java-html-26-2-2 details**
字段 `fileList` 的数据格式:
- "string":`fileList` 为字符串类型。在合流录制模式下,如果 `avFileType` 设置为 `["hls"]`,则 `fileListMode` 为 "string"。
- "json":`fileList` 为 JSON 数组。当 `avFileType` 设置为 `["hls", "mp4"]` 时,无论是单流录制还是合流录制模式,`fileListMode` 为 "json"。
#### MixRecordingHLSAndMP4ServerResponse [#mixrecordinghlsandmp4serverresponse]
```java
public static class MixRecordingHLSAndMP4ServerResponse {
@JsonProperty("status")
private Integer status;
@JsonProperty("fileListMode")
private String fileListMode;
@JsonProperty("fileList")
private List fileList;
@JsonProperty("sliceStartTime")
private Long sliceStartTime;
}
```
合流录制 [`queryHLSAndMP4`](/zh-CN/api-reference/cloud-recording/java-api/mixscenario.java#queryhlsandmp4) API 返回的服务响应。
:::info[信息]
自 v0.4.0 版本新增。
:::
##### 成员参数 [#成员参数-27]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `status` | `Integer` | [struct-java-html-27-1-2 details](#table-slot-struct-java-html-27-1-2) |
| `fileListMode` | `String` | [struct-java-html-27-2-2 details](#table-slot-struct-java-html-27-2-2) |
| `fileList` | `List` | 文件列表。详见 [`FileDetail`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#queryresourceres.mixrecordinghlsandmp4serverresponse.filedetail)。 |
| `sliceStartTime` | `Long` | 文件的录制开始时间,Unix 时间戳,单位为秒。 |
**struct-java-html-27-1-2 details**
云服务当前的状态:
- 0:云服务尚未启动。
- 1:云服务初始化完成。
- 2:云服务组件启动中。
- 3:部分云服务组件准备就绪。
- 4:所有云服务组件准备就绪。
- 5:云服务进行中。
- 6:收到停止云服务请求。
- 7:所有云服务组件已停止。
- 8:云服务已退出。
- 20:云服务异常退出。
**struct-java-html-27-2-2 details**
字段 `fileList` 的数据格式:
- "string":`fileList` 为字符串类型。在合流录制模式下,如果 `avFileType` 设置为 `["hls"]`,则 `fileListMode` 为 "string"。
- "json":`fileList` 为 JSON 数组。当 `avFileType` 设置为 `["hls", "mp4"]` 时,在单流录制或合流录制模式下,`fileListMode` 为 "json"。
#### FileDetail [#filedetail-1]
```java
public static class FileDetail {
@JsonProperty("fileName")
private String fileName;
@JsonProperty("trackType")
private String trackType;
@JsonProperty("uid")
private String uid;
@JsonProperty("mixedAllUser")
private Boolean mixedAllUser;
@JsonProperty("isPlayable")
private Boolean isPlayable;
@JsonProperty("sliceStartTime")
private Long sliceStartTime;
}
```
当 `avFileType` 设置为 `["hls", "mp4"]` 时的文件详细信息。
:::info[信息]
自 v0.4.0 版本新增。
:::
##### 成员参数 [#成员参数-28]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `fileName` | `String` | (可选)录制过程中生成的 M3U8 或 MP4 文件名称。 |
| `trackType` | `String` | [struct-java-html-28-2-2 details](#table-slot-struct-java-html-28-2-2) |
| `uid` | `String` | (可选)用户 UID,表示被录制的音频或视频流所属的用户。在合流录制模式下,该值为 "0"。 |
| `mixedAllUser` | `Boolean` | [struct-java-html-28-4-2 details](#table-slot-struct-java-html-28-4-2) |
| `isPlayable` | `Boolean` | [struct-java-html-28-5-2 details](#table-slot-struct-java-html-28-5-2) |
| `sliceStartTime` | `Long` | (可选)文件的录制开始时间,Unix 时间戳,单位为秒。 |
**struct-java-html-28-2-2 details**
(可选)录制的文件类型。
- "audio":仅音频文件。
- "video":仅视频文件。
- "audio_and_video":音视频文件。
**struct-java-html-28-4-2 details**
(可选)是否将所有用户的音视频流合并录制。
- true:所有用户被录制到一个文件中。
- false:每个用户分别录制到独立文件中。
**struct-java-html-28-5-2 details**
(可选)该文件是否支持在线播放。
- true:支持在线播放。
- false:不支持在线播放。
#### WebRecordingServerResponse [#webrecordingserverresponse]
```java
public static class WebRecordingServerResponse {
@JsonProperty("status")
private Integer status;
@JsonProperty("extensionServiceState")
private List extensionServiceState;
}
```
表示页面录制查询 API 返回的服务器响应。
:::info[信息]
自 v0.4.0 版本新增。
:::
##### 成员参数 [#成员参数-29]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `status` | `Integer` | [struct-java-html-29-1-2 details](#table-slot-struct-java-html-29-1-2) |
| `extensionServiceState` | `List` | 扩展服务的状态。详见 [`ExtensionServiceState`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#queryresourceres.webrecordingserverresponse.extensionservicestate)。 |
**struct-java-html-29-1-2 details**
云服务的当前状态:
- 0:云服务尚未启动。
- 1:云服务初始化完成。
- 2:云服务组件启动中。
- 3:部分云服务组件已就绪。
- 4:全部云服务组件已就绪。
- 5:云服务运行中。
- 6:云服务已收到停止请求。
- 7:全部云服务组件已停止。
- 8:云服务已退出。
- 20:云服务异常退出。
#### ExtensionServiceState [#extensionservicestate]
```java
public static class ExtensionServiceState {
@JsonProperty("payload")
private Payload payload;
@JsonProperty("serviceName")
private String serviceName;
}
```
扩展服务状态信息。
:::info[信息]
自 v0.4.0 版本新增。
:::
##### 成员参数 [#成员参数-30]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `payload` | `Payload` | 扩展服务的载荷。详见 [`Payload`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#queryresourceres.webrecordingserverresponse.extensionservicestate.payload)。 |
| `serviceName` | `String` | [struct-java-html-30-2-2 details](#table-slot-struct-java-html-30-2-2) |
**struct-java-html-30-2-2 details**
扩展服务的名称。
- "web_recorder_service":表示扩展服务为页面录制。
- "rtmp_publish_service":表示扩展服务为将页面录制推送至 CDN。
#### Payload [#payload]
```java
public static class Payload {
@JsonProperty("fileList")
private List fileList;
@JsonProperty("onhold")
private Boolean onhold;
@JsonProperty("state")
private String state;
}
```
扩展服务的载荷。
:::info[信息]
自 v0.4.0 版本新增。
:::
##### 成员参数 [#成员参数-31]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `fileList` | `List` | 文件列表。详见 [`FileDetail`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#queryresourceres.webrecordingserverresponse.extensionservicestate.payload.filedetail)。 |
| `onhold` | `Boolean` | [struct-java-html-31-2-2 details](#table-slot-struct-java-html-31-2-2) |
| `state` | `String` | [struct-java-html-31-3-2 details](#table-slot-struct-java-html-31-3-2) |
**struct-java-html-31-2-2 details**
页面录制是否处于暂停状态:
- true:已暂停。
- false:正在进行中。
**struct-java-html-31-3-2 details**
上传订阅内容到扩展服务的状态:
- "init":服务初始化中。
- "inProgress":服务已启动且正在运行。
- "exit":服务退出。
#### FileDetail [#filedetail-2]
```java
public static class FileDetail {
@JsonProperty("filename")
private String filename;
@JsonProperty("sliceStartTime")
private Long sliceStartTime;
}
```
表示文件的详细信息。
:::info[信息]
自 v0.4.0 版本新增。
:::
##### 成员参数 [#成员参数-32]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `filename` | `String` | 文件名称。 |
| `sliceStartTime` | `Long` | 文件的录制起始时间,Unix 时间戳,单位为秒。 |
#### WebRecordingRtmpPublishServerResponse [#webrecordingrtmppublishserverresponse]
```java
public static class WebRecordingRtmpPublishServerResponse {
@JsonProperty("status")
private Integer status;
@JsonProperty("extensionServiceState")
private List extensionServiceState;
}
```
页面录制中 [`queryRtmpPublish`](/zh-CN/api-reference/cloud-recording/java-api/webscenario.java#queryrtmppublish) 接口返回的服务端响应。
:::info[信息]
自 v0.4.0 版本新增。
:::
##### 成员参数 [#成员参数-33]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `status` | `Integer` | [struct-java-html-33-1-2 details](#table-slot-struct-java-html-33-1-2) |
| `extensionServiceState` | `List` | 扩展服务的状态。详见 [`ExtensionServiceState`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#queryresourceres.webrecordingrtmppublishserverresponse.extensionservicestate)。 |
**struct-java-html-33-1-2 details**
云服务的当前状态:
- 0:云服务未启动。
- 1:云服务初始化完成。
- 2:云服务组件正在启动。
- 3:部分云服务组件就绪。
- 4:全部云服务组件就绪。
- 5:云服务运行中。
- 6:云服务接收到停止请求。
- 7:全部云服务组件停止。
- 8:云服务退出。
- 20:云服务异常退出。
#### ExtensionServiceState [#extensionservicestate-1]
```java
public static class ExtensionServiceState {
@JsonProperty("payload")
private Payload payload;
@JsonProperty("serviceName")
private String serviceName;
}
```
表示扩展服务的状态信息。
:::info[信息]
自 v0.4.0 版本新增。
:::
##### 成员参数 [#成员参数-34]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `payload` | `Payload` | 扩展服务的载荷。详见 [`Payload`](/zh-CN/api-reference/cloud-recording/java-api/struct.java#queryresourceres.webrecordingrtmppublishserverresponse.extensionservicestate.payload)。 |
| `serviceName` | `String` | [struct-java-html-34-2-2 details](#table-slot-struct-java-html-34-2-2) |
**struct-java-html-34-2-2 details**
扩展服务的名称:
- "web_recorder_service":表示扩展服务为页面录制。
- "rtmp_publish_service":表示扩展服务为将页面录制推流至 CDN。
#### Payload [#payload-1]
```java
public static class Payload {
@JsonProperty("state")
private String state;
@JsonProperty("outputs")
private List