com.volcengine.model.acep.ScreenShotBody Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of volc-sdk-java Show documentation
The VOLC Engine SDK for Java
There is a newer version: 1.0.192
package com.volcengine.model.acep;


import com.alibaba.fastjson.JSON;

/**
 * ScreenShotBody
 */
@lombok.Data
public final class ScreenShotBody  {

    /**
     * 实例 ID，可通过调用 `ListPod` 接口获取。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "PodId")
    private String podId;

    /**
     * 实例所属业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "ProductId")
    private String productId;

    /**
     * 截图请求的唯一标识，防止由于网络等原因造成重复请求，同一 `RoundId` 在 5 分钟内只可使用一次。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "RoundId")
    private String roundId;

    /**
     * 是否保存截图文件在云手机实例：
     *
     *
     *
     * - true：上传截图文件到火山引擎对象存储，并保存截图文件在云手机实例中。
     *
     * 	
     *
     * - false：默认值，上传截图文件到火山引擎对象存储，上传完成后，删除保存在云手机实例中的文件。
     *
     * 	
     *
     *
     *
     * 截图文件保存和清理逻辑如下：
     *
     *
     *
     * - 当保存截图文件在云手机实例时，截图超过 1000 张时会清理之前保存的截图文件；
     *
     * 	
     *
     * - 当上传截图文件到火山引擎对象存储时，截图上传到对象存储成功后再清理云手机实例中的截图文件；
     *
     * 	
     *
     * - 当云手机存储空间小于 600MB 时：
     *
     * 	- 若设置该参数为 `true`，则不可执行截图操作；
     *
     * 	- 若设置该参数为 `false`，可执行截图操作。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "IsSavedOnPod")
    private Boolean isSavedOnPod;

    /**
     * 截图画面横竖屏旋转：
     *
     *
     *
     * - 0：默认值，截图方向不做处理；
     *
     * - 1：截图画面旋转为竖屏：
     *
     * 	- 手机竖屏的截图，不做处理；
     *
     * 	- 手机横屏的截图，截图顺时针旋转 90 度。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "Rotation")
    private Integer rotation;

    /**
     * 截图事件是否广播：
     *
     *
     *
     * - true：默认值，广播；
     *
     * 	
     *
     * - false：不广播。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "IsBroadcasted")
    private Boolean isBroadcasted;

    /**
     * 设置截图地址回调触发的频次：
     *
     * - 0/1/置空：当前行为/默认行为，表示每次调用本接口发起截图，都会刷新 URL，触发新的截图地址回调；
     *
     * - -1：URL 固定不刷新，直到 7 天刷新一次 URL（由于 TOS 的 URL 链接有效期为 7 天）；
     *
     * - 其他数值：截图累计 xx 次后，再刷新 URL，刷新 URL 再触发回调。URL 不变，则不触发新的回调。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "Interval")
    private Integer interval;

    @Override
    public String toString() {
        return JSON.toJSONString(this);
    }
}