com.tencentcloudapi.vod.v20180717.models.ModifySampleSnapshotTemplateRequest 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 ModifySampleSnapshotTemplateRequest extends AbstractModel{

    /**
    * Unique ID of a sampled screencapturing template.
    */
    @SerializedName("Definition")
    @Expose
    private Long Definition;

    /**
    * Name of a sampled screencapturing template. Length limit: 64 characters.
    */
    @SerializedName("Name")
    @Expose
    private String Name;

    /**
    * Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096].
If both `Width` and `Height` are 0, the resolution will be the same as that of the source video;
If `Width` is 0, but `Height` is not 0, `Width` will be proportionally scaled;
If `Width` is not 0, but `Height` is 0, `Height` will be proportionally scaled;
If both `Width` and `Height` are not 0, the custom resolution will be used.
Default value: 0.
    */
    @SerializedName("Width")
    @Expose
    private Long Width;

    /**
    * Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096].
If both `Width` and `Height` are 0, the resolution will be the same as that of the source video;
If `Width` is 0, but `Height` is not 0, `Width` will be proportionally scaled;
If `Width` is not 0, but `Height` is 0, `Height` will be proportionally scaled;
If both `Width` and `Height` are not 0, the custom resolution will be used.
Default value: 0.
    */
    @SerializedName("Height")
    @Expose
    private Long Height;

    /**
    * Resolution adaption. Valid values:
open: enabled. In this case, `Width` represents the long side of a video, while `Height` the short side;
close: disabled. In this case, `Width` represents the width of a video, while `Height` the height.
Default value: open.
    */
    @SerializedName("ResolutionAdaptive")
    @Expose
    private String ResolutionAdaptive;

    /**
    * Sampled screencapturing type. Valid values:
Percent: by percent.
Time: by time interval.
    */
    @SerializedName("SampleType")
    @Expose
    private String SampleType;

    /**
    * Sampling interval.
If `SampleType` is `Percent`, sampling will be performed at an interval of the specified percentage.
If `SampleType` is `Time`, sampling will be performed at the specified time interval in seconds.
    */
    @SerializedName("SampleInterval")
    @Expose
    private Long SampleInterval;

    /**
    * Image format. Valid values: jpg, png.
    */
    @SerializedName("Format")
    @Expose
    private String Format;

    /**
    * Template description. Length limit: 256 characters.
    */
    @SerializedName("Comment")
    @Expose
    private String Comment;

    /**
    * ID of a [subapplication](https://intl.cloud.tencent.com/document/product/266/14574?from_cn_redirect=1) in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.
    */
    @SerializedName("SubAppId")
    @Expose
    private Long SubAppId;

    /**
    * Fill type. "Fill" refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported:
 stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot "shorter" or "longer";
black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks.
white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks.
gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.
Default value: black.
    */
    @SerializedName("FillType")
    @Expose
    private String FillType;

    /**
     * Get Unique ID of a sampled screencapturing template. 
     * @return Definition Unique ID of a sampled screencapturing template.
     */
    public Long getDefinition() {
        return this.Definition;
    }

    /**
     * Set Unique ID of a sampled screencapturing template.
     * @param Definition Unique ID of a sampled screencapturing template.
     */
    public void setDefinition(Long Definition) {
        this.Definition = Definition;
    }

    /**
     * Get Name of a sampled screencapturing template. Length limit: 64 characters. 
     * @return Name Name of a sampled screencapturing template. Length limit: 64 characters.
     */
    public String getName() {
        return this.Name;
    }

    /**
     * Set Name of a sampled screencapturing template. Length limit: 64 characters.
     * @param Name Name of a sampled screencapturing template. Length limit: 64 characters.
     */
    public void setName(String Name) {
        this.Name = Name;
    }

    /**
     * Get Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096].
If both `Width` and `Height` are 0, the resolution will be the same as that of the source video;
If `Width` is 0, but `Height` is not 0, `Width` will be proportionally scaled;
If `Width` is not 0, but `Height` is 0, `Height` will be proportionally scaled;
If both `Width` and `Height` are not 0, the custom resolution will be used.
Default value: 0. 
     * @return Width Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096].
If both `Width` and `Height` are 0, the resolution will be the same as that of the source video;
If `Width` is 0, but `Height` is not 0, `Width` will be proportionally scaled;
If `Width` is not 0, but `Height` is 0, `Height` will be proportionally scaled;
If both `Width` and `Height` are not 0, the custom resolution will be used.
Default value: 0.
     */
    public Long getWidth() {
        return this.Width;
    }

    /**
     * Set Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096].
If both `Width` and `Height` are 0, the resolution will be the same as that of the source video;
If `Width` is 0, but `Height` is not 0, `Width` will be proportionally scaled;
If `Width` is not 0, but `Height` is 0, `Height` will be proportionally scaled;
If both `Width` and `Height` are not 0, the custom resolution will be used.
Default value: 0.
     * @param Width Maximum value of the width (or long side) of a screenshot in px. Value range: 0 and [128, 4,096].
If both `Width` and `Height` are 0, the resolution will be the same as that of the source video;
If `Width` is 0, but `Height` is not 0, `Width` will be proportionally scaled;
If `Width` is not 0, but `Height` is 0, `Height` will be proportionally scaled;
If both `Width` and `Height` are not 0, the custom resolution will be used.
Default value: 0.
     */
    public void setWidth(Long Width) {
        this.Width = Width;
    }

    /**
     * Get Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096].
If both `Width` and `Height` are 0, the resolution will be the same as that of the source video;
If `Width` is 0, but `Height` is not 0, `Width` will be proportionally scaled;
If `Width` is not 0, but `Height` is 0, `Height` will be proportionally scaled;
If both `Width` and `Height` are not 0, the custom resolution will be used.
Default value: 0. 
     * @return Height Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096].
If both `Width` and `Height` are 0, the resolution will be the same as that of the source video;
If `Width` is 0, but `Height` is not 0, `Width` will be proportionally scaled;
If `Width` is not 0, but `Height` is 0, `Height` will be proportionally scaled;
If both `Width` and `Height` are not 0, the custom resolution will be used.
Default value: 0.
     */
    public Long getHeight() {
        return this.Height;
    }

    /**
     * Set Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096].
If both `Width` and `Height` are 0, the resolution will be the same as that of the source video;
If `Width` is 0, but `Height` is not 0, `Width` will be proportionally scaled;
If `Width` is not 0, but `Height` is 0, `Height` will be proportionally scaled;
If both `Width` and `Height` are not 0, the custom resolution will be used.
Default value: 0.
     * @param Height Maximum value of the height (or short side) of a screenshot in px. Value range: 0 and [128, 4,096].
If both `Width` and `Height` are 0, the resolution will be the same as that of the source video;
If `Width` is 0, but `Height` is not 0, `Width` will be proportionally scaled;
If `Width` is not 0, but `Height` is 0, `Height` will be proportionally scaled;
If both `Width` and `Height` are not 0, the custom resolution will be used.
Default value: 0.
     */
    public void setHeight(Long Height) {
        this.Height = Height;
    }

    /**
     * Get Resolution adaption. Valid values:
open: enabled. In this case, `Width` represents the long side of a video, while `Height` the short side;
close: disabled. In this case, `Width` represents the width of a video, while `Height` the height.
Default value: open. 
     * @return ResolutionAdaptive Resolution adaption. Valid values:
open: enabled. In this case, `Width` represents the long side of a video, while `Height` the short side;
close: disabled. In this case, `Width` represents the width of a video, while `Height` the height.
Default value: open.
     */
    public String getResolutionAdaptive() {
        return this.ResolutionAdaptive;
    }

    /**
     * Set Resolution adaption. Valid values:
open: enabled. In this case, `Width` represents the long side of a video, while `Height` the short side;
close: disabled. In this case, `Width` represents the width of a video, while `Height` the height.
Default value: open.
     * @param ResolutionAdaptive Resolution adaption. Valid values:
open: enabled. In this case, `Width` represents the long side of a video, while `Height` the short side;
close: disabled. In this case, `Width` represents the width of a video, while `Height` the height.
Default value: open.
     */
    public void setResolutionAdaptive(String ResolutionAdaptive) {
        this.ResolutionAdaptive = ResolutionAdaptive;
    }

    /**
     * Get Sampled screencapturing type. Valid values:
Percent: by percent.
Time: by time interval. 
     * @return SampleType Sampled screencapturing type. Valid values:
Percent: by percent.
Time: by time interval.
     */
    public String getSampleType() {
        return this.SampleType;
    }

    /**
     * Set Sampled screencapturing type. Valid values:
Percent: by percent.
Time: by time interval.
     * @param SampleType Sampled screencapturing type. Valid values:
Percent: by percent.
Time: by time interval.
     */
    public void setSampleType(String SampleType) {
        this.SampleType = SampleType;
    }

    /**
     * Get Sampling interval.
If `SampleType` is `Percent`, sampling will be performed at an interval of the specified percentage.
If `SampleType` is `Time`, sampling will be performed at the specified time interval in seconds. 
     * @return SampleInterval Sampling interval.
If `SampleType` is `Percent`, sampling will be performed at an interval of the specified percentage.
If `SampleType` is `Time`, sampling will be performed at the specified time interval in seconds.
     */
    public Long getSampleInterval() {
        return this.SampleInterval;
    }

    /**
     * Set Sampling interval.
If `SampleType` is `Percent`, sampling will be performed at an interval of the specified percentage.
If `SampleType` is `Time`, sampling will be performed at the specified time interval in seconds.
     * @param SampleInterval Sampling interval.
If `SampleType` is `Percent`, sampling will be performed at an interval of the specified percentage.
If `SampleType` is `Time`, sampling will be performed at the specified time interval in seconds.
     */
    public void setSampleInterval(Long SampleInterval) {
        this.SampleInterval = SampleInterval;
    }

    /**
     * Get Image format. Valid values: jpg, png. 
     * @return Format Image format. Valid values: jpg, png.
     */
    public String getFormat() {
        return this.Format;
    }

    /**
     * Set Image format. Valid values: jpg, png.
     * @param Format Image format. Valid values: jpg, png.
     */
    public void setFormat(String Format) {
        this.Format = Format;
    }

    /**
     * Get Template description. Length limit: 256 characters. 
     * @return Comment Template description. Length limit: 256 characters.
     */
    public String getComment() {
        return this.Comment;
    }

    /**
     * Set Template description. Length limit: 256 characters.
     * @param Comment Template description. Length limit: 256 characters.
     */
    public void setComment(String Comment) {
        this.Comment = Comment;
    }

    /**
     * Get ID of a [subapplication](https://intl.cloud.tencent.com/document/product/266/14574?from_cn_redirect=1) in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. 
     * @return SubAppId ID of a [subapplication](https://intl.cloud.tencent.com/document/product/266/14574?from_cn_redirect=1) in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.
     */
    public Long getSubAppId() {
        return this.SubAppId;
    }

    /**
     * Set ID of a [subapplication](https://intl.cloud.tencent.com/document/product/266/14574?from_cn_redirect=1) in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.
     * @param SubAppId ID of a [subapplication](https://intl.cloud.tencent.com/document/product/266/14574?from_cn_redirect=1) in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.
     */
    public void setSubAppId(Long SubAppId) {
        this.SubAppId = SubAppId;
    }

    /**
     * Get Fill type. "Fill" refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported:
 stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot "shorter" or "longer";
black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks.
white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks.
gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.
Default value: black. 
     * @return FillType Fill type. "Fill" refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported:
 stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot "shorter" or "longer";
black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks.
white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks.
gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.
Default value: black.
     */
    public String getFillType() {
        return this.FillType;
    }

    /**
     * Set Fill type. "Fill" refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported:
 stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot "shorter" or "longer";
black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks.
white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks.
gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.
Default value: black.
     * @param FillType Fill type. "Fill" refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported:
 stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot "shorter" or "longer";
black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks.
white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks.
gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur.
Default value: black.
     */
    public void setFillType(String FillType) {
        this.FillType = FillType;
    }

    public ModifySampleSnapshotTemplateRequest() {
    }

    /**
     * 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 ModifySampleSnapshotTemplateRequest(ModifySampleSnapshotTemplateRequest source) {
        if (source.Definition != null) {
            this.Definition = new Long(source.Definition);
        }
        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.SampleType != null) {
            this.SampleType = new String(source.SampleType);
        }
        if (source.SampleInterval != null) {
            this.SampleInterval = new Long(source.SampleInterval);
        }
        if (source.Format != null) {
            this.Format = new String(source.Format);
        }
        if (source.Comment != null) {
            this.Comment = new String(source.Comment);
        }
        if (source.SubAppId != null) {
            this.SubAppId = new Long(source.SubAppId);
        }
        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 + "Definition", this.Definition);
        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 + "SampleType", this.SampleType);
        this.setParamSimple(map, prefix + "SampleInterval", this.SampleInterval);
        this.setParamSimple(map, prefix + "Format", this.Format);
        this.setParamSimple(map, prefix + "Comment", this.Comment);
        this.setParamSimple(map, prefix + "SubAppId", this.SubAppId);
        this.setParamSimple(map, prefix + "FillType", this.FillType);

    }
}