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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-intl-en Show documentation
Tencent Cloud API SDK for Java
There is a newer version: 3.0.1034
Show newest version
/*
 * 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 CoverBySnapshotTaskInput extends AbstractModel{

    /**
    * Time point screencapturing template ID.
    */
    @SerializedName("Definition")
    @Expose
    private Long Definition;

    /**
    * Screencapturing mode. Valid values:
Time: screencaptures by time point
Percent: screencaptures by percentage
    */
    @SerializedName("PositionType")
    @Expose
    private String PositionType;

    /**
    * Screenshot position:
For time point screencapturing, this means to take a screenshot at a specified time point (in seconds) and use it as the cover
For percentage screencapturing, this value means to take a screenshot at a specified percentage of the video duration and use it as the cover
    */
    @SerializedName("PositionValue")
    @Expose
    private Float PositionValue;

    /**
    * List of up to 10 image or text watermarks.
Note: this field may return null, indicating that no valid values can be obtained.
    */
    @SerializedName("WatermarkSet")
    @Expose
    private WatermarkInput [] WatermarkSet;

    /**
     * Get Time point screencapturing template ID. 
     * @return Definition Time point screencapturing template ID.
     */
    public Long getDefinition() {
        return this.Definition;
    }

    /**
     * Set Time point screencapturing template ID.
     * @param Definition Time point screencapturing template ID.
     */
    public void setDefinition(Long Definition) {
        this.Definition = Definition;
    }

    /**
     * Get Screencapturing mode. Valid values:
Time: screencaptures by time point
Percent: screencaptures by percentage 
     * @return PositionType Screencapturing mode. Valid values:
Time: screencaptures by time point
Percent: screencaptures by percentage
     */
    public String getPositionType() {
        return this.PositionType;
    }

    /**
     * Set Screencapturing mode. Valid values:
Time: screencaptures by time point
Percent: screencaptures by percentage
     * @param PositionType Screencapturing mode. Valid values:
Time: screencaptures by time point
Percent: screencaptures by percentage
     */
    public void setPositionType(String PositionType) {
        this.PositionType = PositionType;
    }

    /**
     * Get Screenshot position:
For time point screencapturing, this means to take a screenshot at a specified time point (in seconds) and use it as the cover
For percentage screencapturing, this value means to take a screenshot at a specified percentage of the video duration and use it as the cover 
     * @return PositionValue Screenshot position:
For time point screencapturing, this means to take a screenshot at a specified time point (in seconds) and use it as the cover
For percentage screencapturing, this value means to take a screenshot at a specified percentage of the video duration and use it as the cover
     */
    public Float getPositionValue() {
        return this.PositionValue;
    }

    /**
     * Set Screenshot position:
For time point screencapturing, this means to take a screenshot at a specified time point (in seconds) and use it as the cover
For percentage screencapturing, this value means to take a screenshot at a specified percentage of the video duration and use it as the cover
     * @param PositionValue Screenshot position:
For time point screencapturing, this means to take a screenshot at a specified time point (in seconds) and use it as the cover
For percentage screencapturing, this value means to take a screenshot at a specified percentage of the video duration and use it as the cover
     */
    public void setPositionValue(Float PositionValue) {
        this.PositionValue = PositionValue;
    }

    /**
     * Get List of up to 10 image or text watermarks.
Note: this field may return null, indicating that no valid values can be obtained. 
     * @return WatermarkSet List of up to 10 image or text watermarks.
Note: this field may return null, indicating that no valid values can be obtained.
     */
    public WatermarkInput [] getWatermarkSet() {
        return this.WatermarkSet;
    }

    /**
     * Set List of up to 10 image or text watermarks.
Note: this field may return null, indicating that no valid values can be obtained.
     * @param WatermarkSet List of up to 10 image or text watermarks.
Note: this field may return null, indicating that no valid values can be obtained.
     */
    public void setWatermarkSet(WatermarkInput [] WatermarkSet) {
        this.WatermarkSet = WatermarkSet;
    }

    public CoverBySnapshotTaskInput() {
    }

    /**
     * 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 CoverBySnapshotTaskInput(CoverBySnapshotTaskInput source) {
        if (source.Definition != null) {
            this.Definition = new Long(source.Definition);
        }
        if (source.PositionType != null) {
            this.PositionType = new String(source.PositionType);
        }
        if (source.PositionValue != null) {
            this.PositionValue = new Float(source.PositionValue);
        }
        if (source.WatermarkSet != null) {
            this.WatermarkSet = new WatermarkInput[source.WatermarkSet.length];
            for (int i = 0; i < source.WatermarkSet.length; i++) {
                this.WatermarkSet[i] = new WatermarkInput(source.WatermarkSet[i]);
            }
        }
    }


    /**
     * 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 + "PositionType", this.PositionType);
        this.setParamSimple(map, prefix + "PositionValue", this.PositionValue);
        this.setParamArrayObj(map, prefix + "WatermarkSet.", this.WatermarkSet);

    }
}