com.volcengine.model.live.v20230101.UpdatePullToPushTaskBody Maven / Gradle / Ivy
Show all versions of volc-sdk-java Show documentation
package com.volcengine.model.live.v20230101;
import com.alibaba.fastjson.JSON;
import java.util.List;
/**
* UpdatePullToPushTaskBody
*/
@lombok.Data
public final class UpdatePullToPushTaskBody {
/**
* 拉流转推任务的名称，默认为空表示不配置任务名称。支持由中文、大小写字母（A - Z、a - z）和数字（0 - 9）组成，长度为 1 到 20 各字符。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Title")
private String title;
/**
* 任务 ID，任务的唯一标识，您可以通过[获取拉流转推任务列表](https://www.volcengine.com/docs/6469/1126896)接口获取。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "TaskId")
private String taskId;
/**
* 任务的开始时间，Unix 时间戳，单位为秒。
*
* :::tip
*
* 拉流转推任务持续时间最长为 7 天。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "StartTime")
private Integer startTime;
/**
* 任务等结束时间，Unix 时间戳，单位为秒。
*
* :::tip
*
* 拉流转推任务持续时间最长为 7 天。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "EndTime")
private Integer endTime;
/**
* 接收拉流转推任务状态回调的地址，最大长度为 2000 个字符。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "CallbackURL")
private String callbackURL;
/**
* 拉流来源类型，支持的取值及含义如下。
*
*
*
* - `0`：直播源；
*
* - `1`：点播视频。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Type")
private Integer type;
/**
* 点播视频文件循环播放模式，当拉流来源类型为点播视频时为必选参数，参数取值及含义如下所示。
*
*
*
* - `-1`：无限次循环，至任务结束；
*
* - `0`：有限次循环，循环次数以 PlayTimes 取值为准；
*
* - `>0`：有限次循环，循环次数以 CycleMode 取值为准。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "CycleMode")
private Integer cycleMode;
/**
* 推流地址，即直播源或点播视频转推的目标地址。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "DstAddr")
private String dstAddr;
/**
* 直播源的拉流地址，拉流来源类型为直播源（Type 为 0）时，为必选参数，最大长度为 1000 个字符。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "SrcAddr")
private String srcAddr;
/**
* 点播视频播放地址列表，拉流来源类型为点播视频（Type 为 1）时，为必选参数，最多支持传入 30 个点播视频播放地址，每个地址最大长度为 1000 个字符。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "SrcAddrS")
private List srcAddrS;
/**
* 推流的流名称，推流地址（DstAddr）为空时必传；反之，则该参数不生效
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Stream")
private String stream;
/**
* 推流应用名称，推流地址（DstAddr）为空时必传；反之，则该参数不生效
*/
@com.alibaba.fastjson.annotation.JSONField(name = "App")
private String app;
/**
* 推流域名，推流地址（DstAddr）为空时必传；反之，则该参数不生效
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Domain")
private String domain;
/**
* 为拉流转推视频添加的水印配置信息。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Watermark")
private UpdatePullToPushTaskBodyWatermark watermark;
/**
* 是否开启点播预热，开启点播预热后，系统会自动将点播视频文件缓存到 CDN 节点上，当用户请求直播时，可以直播从 CDN 节点获取视频，从而提高直播流畅度。
*
* 拉流来源类型为点播视频（Type 为 1）时，参数生效。
*
* - `0`：不开启；
*
* - `1`：开启（默认值）。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "PreDownload")
private Integer preDownload;
/**
* 点播文件启播时间偏移值，单位为秒，数量与拉流地址列表中地址数量相等，缺省情况下表示不进行偏移。
*
* 拉流来源类型为点播视频（Type 为 1）时，参数生效。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "OffsetS")
private List offsetS;
/**
* 续播策略，续播策略指转推点播视频进行直播时出现断流并恢复后，如何继续播放的策略，拉流来源类型为点播视频（Type 为 1）时参数生效，支持的取值及含义如下。
*
*
*
* - `0`：从断流处续播（默认值）；
*
* - `1`：从断流处+自然流逝时长处续播。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "ContinueStrategy")
private Integer continueStrategy;
/**
* 点播文件启播时间偏移值，单位为秒，仅当点播视频播放地址列表（SrcAddrS）只有一个地址，且未配置 Offsets 时生效，缺省情况下表示不进行偏移。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Offset")
private Float offset;
/**
* 点播视频文件循环播放次数，当 CycleMode 取值为 0 时，PlayTimes 取值将作为循环播放次数。
*
* :::tip
*
* PlayTimes 为冗余参数，您可以将 PlayTimes 置 0 后直接使用 CycleMode 指定点播视频文件循环播放次数。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "PlayTimes")
private Integer playTimes;
/**
* 点播文件地址和开始播放、结束播放的时间设置。
*
* :::tip
*
* - 当 Type 为点播类型时配置生效。
*
* - 与 SrcAddrS 和 OffsetS 字段不可同时填写。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "VodSrcAddrs")
private List vodSrcAddrs;
/**
* 任务所属的群组名称，您可以通过[获取拉流转推任务列表](https://www.volcengine.com/docs/6469/1126896)接口获取。
*
* :::tip
*
* - 群组名称不支持更新，仅做校验使用。
*
* - 使用主账号调用时，为非必填。
*
* - 使用子账号调用时，为必填。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "GroupName")
private String groupName;
@Override
public String toString() {
return JSON.toJSONString(this);
}
}