com.tencentcloudapi.vod.v20180717.models.CreateSampleSnapshotTemplateRequest Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.tencentcloudapi.vod.v20180717.models;

import com.tencentcloudapi.common.AbstractModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;

public class CreateSampleSnapshotTemplateRequest extends AbstractModel{

    /**
    * 采样截图类型，取值：
Percent：按百分比。
Time：按时间间隔。
    */
    @SerializedName("SampleType")
    @Expose
    private String SampleType;

    /**
    * 采样间隔。
当 SampleType 为 Percent 时，指定采样间隔的百分比。
当 SampleType 为 Time 时，指定采样间隔的时间，单位为秒。
    */
    @SerializedName("SampleInterval")
    @Expose
    private Long SampleInterval;

    /**
    * 点播[子应用](/document/product/266/14574) ID。如果要访问子应用中的资源，则将该字段填写为子应用 ID；否则无需填写该字段。
    */
    @SerializedName("SubAppId")
    @Expose
    private Long SubAppId;

    /**
    * 采样截图模板名称，长度限制：64 个字符。
    */
    @SerializedName("Name")
    @Expose
    private String Name;

    /**
    * 截图宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
当 Width、Height 均为 0，则分辨率同源；
当 Width 为 0，Height 非 0，则 Width 按比例缩放；
当 Width 非 0，Height 为 0，则 Height 按比例缩放；
当 Width、Height 均非 0，则分辨率按用户指定。
默认值：0。
    */
    @SerializedName("Width")
    @Expose
    private Long Width;

    /**
    * 截图高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
当 Width、Height 均为 0，则分辨率同源；
当 Width 为 0，Height 非 0，则 Width 按比例缩放；
当 Width 非 0，Height 为 0，则 Height 按比例缩放；
当 Width、Height 均非 0，则分辨率按用户指定。
默认值：0。
    */
    @SerializedName("Height")
    @Expose
    private Long Height;

    /**
    * 分辨率自适应，可选值：
open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。
默认值：open。
    */
    @SerializedName("ResolutionAdaptive")
    @Expose
    private String ResolutionAdaptive;

    /**
    * 图片格式，取值为 jpg 和 png。默认为 jpg。
    */
    @SerializedName("Format")
    @Expose
    private String Format;

    /**
    * 模板描述信息，长度限制：256 个字符。
    */
    @SerializedName("Comment")
    @Expose
    private String Comment;

    /**
    * 填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式：
 stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“；
black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。
white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。
gauss：高斯模糊，保持视频宽高比不变，边缘剩余部分使用高斯模糊。
默认值：black 。
    */
    @SerializedName("FillType")
    @Expose
    private String FillType;

    /**
     * Get 采样截图类型，取值：
Percent：按百分比。
Time：按时间间隔。 
     * @return SampleType 采样截图类型，取值：
Percent：按百分比。
Time：按时间间隔。
     */
    public String getSampleType() {
        return this.SampleType;
    }

    /**
     * Set 采样截图类型，取值：
Percent：按百分比。
Time：按时间间隔。
     * @param SampleType 采样截图类型，取值：
Percent：按百分比。
Time：按时间间隔。
     */
    public void setSampleType(String SampleType) {
        this.SampleType = SampleType;
    }

    /**
     * Get 采样间隔。
当 SampleType 为 Percent 时，指定采样间隔的百分比。
当 SampleType 为 Time 时，指定采样间隔的时间，单位为秒。 
     * @return SampleInterval 采样间隔。
当 SampleType 为 Percent 时，指定采样间隔的百分比。
当 SampleType 为 Time 时，指定采样间隔的时间，单位为秒。
     */
    public Long getSampleInterval() {
        return this.SampleInterval;
    }

    /**
     * Set 采样间隔。
当 SampleType 为 Percent 时，指定采样间隔的百分比。
当 SampleType 为 Time 时，指定采样间隔的时间，单位为秒。
     * @param SampleInterval 采样间隔。
当 SampleType 为 Percent 时，指定采样间隔的百分比。
当 SampleType 为 Time 时，指定采样间隔的时间，单位为秒。
     */
    public void setSampleInterval(Long SampleInterval) {
        this.SampleInterval = SampleInterval;
    }

    /**
     * Get 点播[子应用](/document/product/266/14574) ID。如果要访问子应用中的资源，则将该字段填写为子应用 ID；否则无需填写该字段。 
     * @return SubAppId 点播[子应用](/document/product/266/14574) ID。如果要访问子应用中的资源，则将该字段填写为子应用 ID；否则无需填写该字段。
     */
    public Long getSubAppId() {
        return this.SubAppId;
    }

    /**
     * Set 点播[子应用](/document/product/266/14574) ID。如果要访问子应用中的资源，则将该字段填写为子应用 ID；否则无需填写该字段。
     * @param SubAppId 点播[子应用](/document/product/266/14574) ID。如果要访问子应用中的资源，则将该字段填写为子应用 ID；否则无需填写该字段。
     */
    public void setSubAppId(Long SubAppId) {
        this.SubAppId = SubAppId;
    }

    /**
     * Get 采样截图模板名称，长度限制：64 个字符。 
     * @return Name 采样截图模板名称，长度限制：64 个字符。
     */
    public String getName() {
        return this.Name;
    }

    /**
     * Set 采样截图模板名称，长度限制：64 个字符。
     * @param Name 采样截图模板名称，长度限制：64 个字符。
     */
    public void setName(String Name) {
        this.Name = Name;
    }

    /**
     * Get 截图宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
当 Width、Height 均为 0，则分辨率同源；
当 Width 为 0，Height 非 0，则 Width 按比例缩放；
当 Width 非 0，Height 为 0，则 Height 按比例缩放；
当 Width、Height 均非 0，则分辨率按用户指定。
默认值：0。 
     * @return Width 截图宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
当 Width、Height 均为 0，则分辨率同源；
当 Width 为 0，Height 非 0，则 Width 按比例缩放；
当 Width 非 0，Height 为 0，则 Height 按比例缩放；
当 Width、Height 均非 0，则分辨率按用户指定。
默认值：0。
     */
    public Long getWidth() {
        return this.Width;
    }

    /**
     * Set 截图宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
当 Width、Height 均为 0，则分辨率同源；
当 Width 为 0，Height 非 0，则 Width 按比例缩放；
当 Width 非 0，Height 为 0，则 Height 按比例缩放；
当 Width、Height 均非 0，则分辨率按用户指定。
默认值：0。
     * @param Width 截图宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
当 Width、Height 均为 0，则分辨率同源；
当 Width 为 0，Height 非 0，则 Width 按比例缩放；
当 Width 非 0，Height 为 0，则 Height 按比例缩放；
当 Width、Height 均非 0，则分辨率按用户指定。
默认值：0。
     */
    public void setWidth(Long Width) {
        this.Width = Width;
    }

    /**
     * Get 截图高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
当 Width、Height 均为 0，则分辨率同源；
当 Width 为 0，Height 非 0，则 Width 按比例缩放；
当 Width 非 0，Height 为 0，则 Height 按比例缩放；
当 Width、Height 均非 0，则分辨率按用户指定。
默认值：0。 
     * @return Height 截图高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
当 Width、Height 均为 0，则分辨率同源；
当 Width 为 0，Height 非 0，则 Width 按比例缩放；
当 Width 非 0，Height 为 0，则 Height 按比例缩放；
当 Width、Height 均非 0，则分辨率按用户指定。
默认值：0。
     */
    public Long getHeight() {
        return this.Height;
    }

    /**
     * Set 截图高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
当 Width、Height 均为 0，则分辨率同源；
当 Width 为 0，Height 非 0，则 Width 按比例缩放；
当 Width 非 0，Height 为 0，则 Height 按比例缩放；
当 Width、Height 均非 0，则分辨率按用户指定。
默认值：0。
     * @param Height 截图高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。
当 Width、Height 均为 0，则分辨率同源；
当 Width 为 0，Height 非 0，则 Width 按比例缩放；
当 Width 非 0，Height 为 0，则 Height 按比例缩放；
当 Width、Height 均非 0，则分辨率按用户指定。
默认值：0。
     */
    public void setHeight(Long Height) {
        this.Height = Height;
    }

    /**
     * Get 分辨率自适应，可选值：
open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。
默认值：open。 
     * @return ResolutionAdaptive 分辨率自适应，可选值：
open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。
默认值：open。
     */
    public String getResolutionAdaptive() {
        return this.ResolutionAdaptive;
    }

    /**
     * Set 分辨率自适应，可选值：
open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。
默认值：open。
     * @param ResolutionAdaptive 分辨率自适应，可选值：
open：开启，此时，Width 代表视频的长边，Height 表示视频的短边；
close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。
默认值：open。
     */
    public void setResolutionAdaptive(String ResolutionAdaptive) {
        this.ResolutionAdaptive = ResolutionAdaptive;
    }

    /**
     * Get 图片格式，取值为 jpg 和 png。默认为 jpg。 
     * @return Format 图片格式，取值为 jpg 和 png。默认为 jpg。
     */
    public String getFormat() {
        return this.Format;
    }

    /**
     * Set 图片格式，取值为 jpg 和 png。默认为 jpg。
     * @param Format 图片格式，取值为 jpg 和 png。默认为 jpg。
     */
    public void setFormat(String Format) {
        this.Format = Format;
    }

    /**
     * Get 模板描述信息，长度限制：256 个字符。 
     * @return Comment 模板描述信息，长度限制：256 个字符。
     */
    public String getComment() {
        return this.Comment;
    }

    /**
     * Set 模板描述信息，长度限制：256 个字符。
     * @param Comment 模板描述信息，长度限制：256 个字符。
     */
    public void setComment(String Comment) {
        this.Comment = Comment;
    }

    /**
     * Get 填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式：
 stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“；
black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。
white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。
gauss：高斯模糊，保持视频宽高比不变，边缘剩余部分使用高斯模糊。
默认值：black 。 
     * @return FillType 填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式：
 stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“；
black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。
white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。
gauss：高斯模糊，保持视频宽高比不变，边缘剩余部分使用高斯模糊。
默认值：black 。
     */
    public String getFillType() {
        return this.FillType;
    }

    /**
     * Set 填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式：
 stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“；
black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。
white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。
gauss：高斯模糊，保持视频宽高比不变，边缘剩余部分使用高斯模糊。
默认值：black 。
     * @param FillType 填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式：
 stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“；
black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。
white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。
gauss：高斯模糊，保持视频宽高比不变，边缘剩余部分使用高斯模糊。
默认值：black 。
     */
    public void setFillType(String FillType) {
        this.FillType = FillType;
    }

    public CreateSampleSnapshotTemplateRequest() {
    }

    /**
     * NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
     *       and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
     */
    public CreateSampleSnapshotTemplateRequest(CreateSampleSnapshotTemplateRequest source) {
        if (source.SampleType != null) {
            this.SampleType = new String(source.SampleType);
        }
        if (source.SampleInterval != null) {
            this.SampleInterval = new Long(source.SampleInterval);
        }
        if (source.SubAppId != null) {
            this.SubAppId = new Long(source.SubAppId);
        }
        if (source.Name != null) {
            this.Name = new String(source.Name);
        }
        if (source.Width != null) {
            this.Width = new Long(source.Width);
        }
        if (source.Height != null) {
            this.Height = new Long(source.Height);
        }
        if (source.ResolutionAdaptive != null) {
            this.ResolutionAdaptive = new String(source.ResolutionAdaptive);
        }
        if (source.Format != null) {
            this.Format = new String(source.Format);
        }
        if (source.Comment != null) {
            this.Comment = new String(source.Comment);
        }
        if (source.FillType != null) {
            this.FillType = new String(source.FillType);
        }
    }


    /**
     * Internal implementation, normal users should not use it.
     */
    public void toMap(HashMap map, String prefix) {
        this.setParamSimple(map, prefix + "SampleType", this.SampleType);
        this.setParamSimple(map, prefix + "SampleInterval", this.SampleInterval);
        this.setParamSimple(map, prefix + "SubAppId", this.SubAppId);
        this.setParamSimple(map, prefix + "Name", this.Name);
        this.setParamSimple(map, prefix + "Width", this.Width);
        this.setParamSimple(map, prefix + "Height", this.Height);
        this.setParamSimple(map, prefix + "ResolutionAdaptive", this.ResolutionAdaptive);
        this.setParamSimple(map, prefix + "Format", this.Format);
        this.setParamSimple(map, prefix + "Comment", this.Comment);
        this.setParamSimple(map, prefix + "FillType", this.FillType);

    }
}