com.volcengine.model.live.v20230101.CreateLiveStreamRecordIndexFilesBody Maven / Gradle / Ivy
Show all versions of volc-sdk-java Show documentation
package com.volcengine.model.live.v20230101;
import com.alibaba.fastjson.JSON;
/**
* CreateLiveStreamRecordIndexFilesBody
*/
@lombok.Data
public final class CreateLiveStreamRecordIndexFilesBody {
/**
* 直播流使用的域名。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看直播流使用的域名。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Domain")
private String domain;
/**
* 应用名称，取值与直播流地址中 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（\_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "App")
private String app;
/**
* 流名称，取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（\_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Stream")
private String stream;
/**
* 录制索引文件的开始时间，RFC3339 格式的时间戳，精度为秒。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "StartTime")
private String startTime;
/**
* 录制索引文件的结束时间，RFC3339 格式的时间戳，精度为秒。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "EndTime")
private String endTime;
/**
* 指定录制文件存储的 TOS Bucket。默认为空，表示与对应录制配置中的存储配置一致。
*
*
*
* :::tip
*
* - `OutputBucket` 参数用于覆盖录制配置中的 TOS 存储的 `Bucket` 参数，`OutputObject` 参数用于覆盖录制配置中 TOS 存储的 `ExactObject` 参数。
*
*
*
* - 当您的录制配置存储位置为 VOD ，且创建录制任务仍需存储至 VOD 时，请勿配置 `OutputBucket` 和 `OutputObject`。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "OutputBucket")
private String outputBucket;
/**
* 指定录制文件存储到 TOS 是的存储规则，默认为空，表示与对应录制配置中的存储规则配置一致。
*
* 支持以 `record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}` 样式设置存储规则，支持输入字母（A - Z、a - z）、数字（0 - 9）、短横线（-）、叹号（!）、下划线（\_）、句点（.）、星号（\*）及占位符，最大长度 200 个字符。
*
*
*
* 存储规则设置注意事项如下。
*
*
*
* - 目录层级至少包含2级及以上，如 `live/{App}/{Stream}`。
*
* - record 为自定义字段；
*
* - {PubDomain} 取值为当前配置的 `vhost` 值；
*
* - {App} 取值为当前配置的 `AppName` 值；
*
* - {Stream} 取值为当前配置的 `StreamName` 值；
*
* - {StartTime} 取值为录制的开始时间戳；
*
* - {EndTime} 取值为录制的结束时间戳。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "OutputObject")
private String outputObject;
/**
* 是否开启获取录制视频宽高数据的功能，开启后会获取视频宽和高信息，支持的取值及含义如下所示，默认不传时表示开启。
*
* - `true`：开启；
*
* - `false`：禁用。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "NeedFFProbe")
private Boolean needFFProbe;
/**
* 将录制文件存储到点播时，是否开启索引文件与 TS 文件分离，默认禁用。
*
*
*
* - `true`：启用，删除索引文件时不会删除关联的 TS 文件；
*
* - `false`：禁用，删除索引文件时会删除关联的 TS 文件。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "SeparatedTS")
private Boolean separatedTS;
/**
* 将录制文件存储到点播时，如需进行视频处理，可选择已定义的视频处理工作流模板，获取方法请参见[工作流模板](https://www.volcengine.com/docs/4/65675)，默认为空。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "WorkflowID")
private String workflowID;
/**
* 指定访问录制文件的地址中的网络协议，取值及含义如下所示。
*
* - `http`：超文本传输协议（默认值）；
*
* - `https`：安全的超文本传输协议。
*
*
*/
@com.alibaba.fastjson.annotation.JSONField(name = "TSScheme")
private String tSScheme;
@Override
public String toString() {
return JSON.toJSONString(this);
}
}