com.volcengine.model.live.v20230101.CreateTranscodePresetBody Maven / Gradle / Ivy
Show all versions of volc-sdk-java Show documentation
package com.volcengine.model.live.v20230101;
import com.alibaba.fastjson.JSON;
/**
* CreateTranscodePresetBody
*/
@lombok.Data
public final class CreateTranscodePresetBody {
/**
* 音频编码格式，默认值为 `aac`，支持的取值及含义如下所示。
*
* - `aac`：使用 AAC 音频编码格式；
*
* - `opus`：使用 Opus 音频编码格式。
*
* - `copy`：不进行音频转码，所有音频编码参数不生效，音频编码参数包括音频码率（`AudioBitrate`）等。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Acodec")
private String acodec;
/**
* 应用名称，取值与直播流地址的 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "App")
private String app;
/**
* 视频分辨率自适应模式开关，默认值为 `0`。支持的取值及含义如下。
*
* - `0`：关闭视频分辨率自适应；
*
* - `1`：开启视频分辨率自适应。
*
* :::tip
*
* - 关闭视频分辨率自适应模式（`As` 取值为 `0`）时，转码配置的视频分辨率取视频宽度（`Width`）和视频高度（`Height`）的值对转码视频进行拉伸；
*
* - 开启视频分辨率自适应模式（`As` 取值为 `1`）时，转码配置的视频分辨率按照短边长度（`ShortSide`）、长边长度（`LongSide`）、视频宽度（`Width`）、视频高度（`Height`）的优先级取值，另一边等比缩放。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "As")
private String as;
/**
* 音频码率，单位为 kbps，默认值为 `128`，取值范围为 [0,1000]；取值为 `0` 时，表示与源流的音频码率相同。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "AudioBitrate")
private Integer audioBitrate;
/**
* 是否开启转码视频分辨率不超过源流分辨率，默认值为 `1` 表示开启。开启后，当源流分辨率低于转码配置分辨率时（即源流宽低于转码配置宽且源流高低于转码配置高时），将按源流视频分辨率进行转码。
*
* - `0`：关闭；
*
* - `1`：开启。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "AutoTransResolution")
private Integer autoTransResolution;
/**
* 是否开启转码视频码率不超过源流码率，默认值为 `1` 表示开启。开启后，当源流码率低于转码配置码率时，将按照源流视频码率进行转码。
*
* - `0`：关闭；
*
* - `1`：开启。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "AutoTransVb")
private Integer autoTransVb;
/**
* 是否开启转码视频帧率不超过源流帧率，默认值为 `1` 表示开启。开启后，当源流帧率低于转码配置帧率时，将按照源流视频帧率进行转码。
*
* - `0`：关闭；
*
* - `1`：开启。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "AutoTransVr")
private Integer autoTransVr;
/**
* 转码输出视频中 2 个参考帧之间的最大 B 帧数量，默认值为 `3`，取值为 `0` 时表示去除 B 帧。
*
*
*
* 最大 B 帧数量的取值范围根据视频编码格式（Vcodec）的不同有所差异，取值范围如下所示。
*
* - 视频编码格式为 H.264 （`Vcodec` 取值为 `h264`）时取值范围为 [0,7]；
*
* - 视频编码格式为 H.265 或 H.266 （`Vcodec` 取值为 `h265` 或 `h266`）时取值范围为 [0,3]、7、15。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "BFrames")
private Integer bFrames;
/**
* 视频帧率，单位为 fps，默认值为 `25`，取值为 `0` 时表示与源流视频帧率相同。
*
*
*
* 视频帧率的取值范围根据视频编码格式（`Vcodec`）的不同有所差异，视频码率的取值范围如下所示。
*
*
*
* - 视频编码格式为 H.264 或 H.265 （`Vcodec` 取值为 `h264` 或 `h265`）时，视频帧率取值范围为 [0,60]；
*
* - 视频编码格式为 H.266 （`Vcodec` 取值为 `h266`）时，视频帧率取值范围为 [0,35]。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "FPS")
private Integer fPS;
/**
* IDR 帧之间的最大间隔时间，单位为秒，默认值为 `4`，取值范围为 [1,20]。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "GOP")
private Integer gOP;
/**
* 视频高度，默认值为 `0`。
*
*
*
* 视频高度的取值范围根据视频编码格式（`Vcodec`）的不同所有差异，视频高度取值如下所示。
*
* - 视频编码格式为 H.264 或 H.265 （`Vcodec` 取值为 `h264` 或 `h265`）时，取值范围为 [150,1920]；
*
* - 视频编码格式为 H.266 （`Vcodec` 取值为 `h266`）时，不支持设置 `Width` 和 `Height`。
*
*
*
* :::tip
*
* - 当关闭视频分辨率自适应（`As` 取值为 `0`）时，转码分辨率将取 `Width` 和 `Height` 的值对转码视频进行拉伸；
*
* - 当关闭视频分辨率自适应（`As` 取值为 `0`）时，`Width` 和 `Height` 任一取值为 `0` 时，转码视频将保持源流尺寸。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Height")
private Integer height;
/**
* 长边长度，默认值为 `0`。配置不同的转码类型（`Roi`）和视频编码方式（`Vcodec`）时，短边长度的取值范围存在如下。
*
*
*
* - 转码类型为标准转码（`Roi` 取值为 `false`）时：
*
* - 视频编码方式为 H.264 （`Vcodec` 取值为 `h264`）时取值范围为 0 和 [150,4096]；
*
* - 视频编码方式为 H.265 （`Vcodec` 取值为 `h265`）时取值范围为 0 和 [150,7680]；
*
* - 视频编码方式为 H.266 （`Vcodec` 取值为 `h266`）时取值范围为 0 和 [150,1280]。
*
* - 转码类型为极智超清转码（`Roi` 取值为 `true`）时：
*
* - 视频编码方式为 H.264 或 H.265 （`Vcodec` 取值为 `h264` 或 `h265`）时取值范围为 0 和 [150,1920]。
*
*
*
* :::tip
*
* - 当开启视频分辨率自适应模式时（`As` 取值为 `1`）时，参数生效，反之则不生效。
*
* - 当开启视频分辨率自适应模式时（`As` 取值为 `1`）时，如果 `LongSide` 、 `ShortSide` 、`Width` 、`Height` 同时取 `0`，表示保持源流尺寸。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "LongSide")
private Integer longSide;
/**
* 转码类型是否为极智超清转码，默认值为 `false`，取值及含义如下。
*
* - `true`：极智超清转码；
*
* - `false`：标准转码。
*
*
*
* :::tip
*
* 视频编码格式为 H.266 （`Vcodec` 取值为 `h266`）时，转码类型不支持极智超清转码。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Roi")
private Boolean roi;
/**
* 短边长度，默认值为 `0`。配置不同的转码类型（`Roi`）和视频编码方式（`Vcodec`）时，短边长度的取值范围存在如下。
*
* - 转码类型为标准转码（`Roi` 取值为 `false`）时：
*
* - 视频编码方式为 H.264 （`Vcodec` 取值为 `h264`）时取值范围为 0 和 [150,2160]；
*
* - 视频编码方式为 H.265 （`Vcodec` 取值为 `h265`）时取值范围为 0 和 [150,4096]；
*
* - 视频编码方式为 H.266 （`Vcodec` 取值为 `h266`）时取值范围为 0 和 [150,720]。
*
* - 转码类型为极智超清转码（`Roi` 取值为 `true`）时：
*
* - 视频编码方式为 `H.264` 或 `H.265` （`Vcodec` 取值为 `h264` 或 `h265`）时取值范围为 0 和 [150,1920]。
*
* :::tip
*
* - 当开启视频分辨率自适应模式（`As` 取值为 `1`）时，参数生效，反之则不生效。
*
* - 当开启视频分辨率自适应模式（`As` 取值为 `1`）时，如果 `LongSide` 、 `ShortSide` 、`Width` 、`Height` 同时取 `0`，表示保持源流尺寸。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "ShortSide")
private Integer shortSide;
/**
* 转码停止时长，支持触发方式为拉流转码（`TransType` 取值为 `Pull`）时设置，表示断开拉流后转码停止的时长，单位为秒，取值范围为 `-1` 和 [0,300]，`-1` 表示不停止转码，默认值为 `60`。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "StopInterval")
private Integer stopInterval;
/**
* 转码后缀，支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）和短横线（-）组成，长度为 1 到 10 个字符。
*
*
*
* 转码后缀通常以流名称后缀的形式来使用，常见的标识有 `_sd`、`_hd`、`_uhd`，例如，当转码配置的标识为 `_hd` 时，拉取转码流时转码流的流名名称为 `源流的流名称_hd`。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "SuffixName")
private String suffixName;
/**
* 视频编码格式，支持的取值及含义如下所示。
*
* - `h264`：使用 H.264 视频编码格式；
*
* - `h265`：使用 H.265 视频编码格式；
*
* - `h266`：使用 H.266 视频编码格式；
*
* - `copy`：不进行视频转码，所有视频编码参数不生效，视频编码参数包括视频帧率（`FPS`）、视频码率（`VideoBitrate`）、分辨率设置（`As`、`Width`、`Height`、`ShortSide`、`LongSide`）、`GOP` 和 `BFrames` 等。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Vcodec")
private String vcodec;
/**
* 域名空间，即直播流地址的域名所属的域名空间。您可以调用 [`ListDomainDetail`](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看需要转码的直播流使用的域名所属的域名空间。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Vhost")
private String vhost;
/**
* 视频码率，单位为 bps，默认值为 `1000000`；取值为 `0` 时，表示与源流的视频码率相同。
*
*
*
* 视频码率的取值范围根据视频编码格式（`Vcodec`）的不同有所差异，视频码率的取值范围如下所示。
*
* - 视频编码格式为 H.264 或 H.265 （`Vcodec` 取值为 `h264` 或 `h265`）时，视频码率取值范围为 [0,30000000]；
*
* - 视频编码格式为 H.266 （`Vcodec` 取值为 `h266`）时，视频码率取值范围为 [0,6000000]。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "VideoBitrate")
private Integer videoBitrate;
/**
* 视频宽度，单位为 px，默认值为 `0`。
*
*
*
* 视频宽度的取值范围根据视频编码格式（`Vcodec`）的不同所有差异，视频宽度取值如下所示。
*
* - 视频编码格式为 H.264 或 H.265 （`Vcodec` 取值为 `h264` 或 `h265`）时，取值范围为 [150,1920]；
*
* - 视频编码格式为 H.266 （`Vcodec` 取值为 `h266`）时，不支持设置 Width 和 Height。
*
*
*
* :::tip
*
* - 当关闭视频分辨率自适应（`As` 取值为 `0`）时，转码分辨率将取 `Width` 和 `Height` 的值对转码视频进行拉伸；
*
* - 当关闭视频分辨率自适应（`As` 取值为 `0`）时，`Width` 和 `Height` 任一取值为 `0` 时，转码视频将保持源流尺寸。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Width")
private Integer width;
/**
* 转码触发方式，默认值为 `Pull`，支持的取值及含义如下。
*
* - `Push`：推流转码，直播推流后会自动启动转码任务，生成转码流；
*
* - `Pull`：拉流转码，直播推流后，需要主动播放转码流才会启动转码任务，生成转码流。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "TransType")
private String transType;
@Override
public String toString() {
return JSON.toJSONString(this);
}
}