com.volcengine.model.live.v20230101.UpdateWatermarkPresetBody Maven / Gradle / Ivy
Show all versions of volc-sdk-java Show documentation
package com.volcengine.model.live.v20230101;
import com.alibaba.fastjson.JSON;
/**
* UpdateWatermarkPresetBody
*/
@lombok.Data
public final class UpdateWatermarkPresetBody {
/**
* 应用名称，您可以调用 [ListVhostWatermarkPreset](https://www.volcengine.com/docs/6469/1126889) 接口，查看待更新水印配置的 App 取值。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "App")
private String app;
/**
* 直播画面方向，支持 2 种取值。
*
* - `vertical`：竖屏；
*
* - `horizontal`：横屏。
*
* :::tip
*
* 该参数属于历史版本参数，预计将于未来移除。建议使用预览背景高度（PreviewHeight）、预览背景宽度（PreviewWidth）参数代替。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Orientation")
private String orientation;
/**
* 水印图片编码字符串，图片最大 2MB，最小 100Bytes，最大分辨率为 1080×1080。图片使用 data URI 协议，格式为：`data:[];[base64],`。
*
* - `mediatype`：图片类型，支持 png、jpg、jpeg 格式；
*
* - `data`：base64 编码的图片字符串。
*
*
*
* :::warning
*
* 如果水印图片不更新，请勿在更新配置时传入该参数，否则会造成水印无法显示。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Picture")
private String picture;
/**
* 水平偏移，表示水印左侧边与转码流画面左侧边之间的距离，使用相对比率，取值范围为 [0,1]。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "PosX")
private Float posX;
/**
* 垂直偏移，表示水印顶部边与转码流画面顶部边之间的距离，使用相对比率，取值范围为 [0,1]。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "PosY")
private Float posY;
/**
* 水印相对宽度，水印宽度占直播转码流画面宽度的比例，取值范围为 [0,1]，水印高度会随宽度等比缩放。与水印相对高度字段冲突，请选择其中一个传参。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "RelativeWidth")
private Float relativeWidth;
/**
* 域名空间，您可以调用 [ListVhostWatermarkPreset](https://www.volcengine.com/docs/6469/1126889) 接口，查看待更新水印配置的 Vhost 取值。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Vhost")
private String vhost;
/**
* 水印图片对应的 HTTP 地址。与水印图片编码字符串字段二选一传入。同时传入时，以水印图片编码字符串参数为准。
*
* :::warning
*
* 如果水印图片不更新，请勿在更新配置时传入该参数，否则会造成水印无法显示。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "PictureUrl")
private String pictureUrl;
/**
* 水印图片预览背景高度，单位为 px。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "PreviewHeight")
private Float previewHeight;
/**
* 水印图片预览背景宽度，单位为 px。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "PreviewWidth")
private Float previewWidth;
/**
* 水印相对高度，水印高度占直播转码流画面高度的比例，取值范围为 [0,1]，水印宽度会随高度等比缩放。与水印相对宽度字段冲突，请选择其中一个传参。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "RelativeHeight")
private Float relativeHeight;
/**
* 流名称，您可以调用 [ListVhostWatermarkPreset](https://www.volcengine.com/docs/6469/1126889) 接口，查看待更新水印配置的 Stream 取值。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Stream")
private String stream;
@Override
public String toString() {
return JSON.toJSONString(this);
}
}