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

    /**
    * Video stream encoder. Valid values:
libx264: H.264
libx265: H.265
av1: AOMedia Video 1
Currently, a resolution within 640x480 must be specified for H.265. and the `av1` container only supports mp4.
    */
    @SerializedName("Codec")
    @Expose
    private String Codec;

    /**
    * Video frame rate in Hz. Value range: [0,100].
If the value is 0, the frame rate will be the same as that of the source video.
    */
    @SerializedName("Fps")
    @Expose
    private Long Fps;

    /**
    * Bitrate of video stream in Kbps. Value range: 0 and [128, 35,000].
If the value is 0, the bitrate of the video will be the same as that of the source video.
    */
    @SerializedName("Bitrate")
    @Expose
    private Long Bitrate;

    /**
    * 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.
Note: this field may return null, indicating that no valid values can be obtained.
    */
    @SerializedName("ResolutionAdaptive")
    @Expose
    private String ResolutionAdaptive;

    /**
    * Maximum value of the width (or long side) of a video stream 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.
Note: this field may return null, indicating that no valid values can be obtained.
    */
    @SerializedName("Width")
    @Expose
    private Long Width;

    /**
    * Maximum value of the height (or short side) of a video stream 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.
Note: this field may return null, indicating that no valid values can be obtained.
    */
    @SerializedName("Height")
    @Expose
    private Long Height;

    /**
    * Fill type, the way of processing a screenshot when the configured aspect ratio is different from that of the source video. Valid values:
stretch: stretches the video image frame by frame to fill the screen. The video image may become "squashed" or "stretched" after transcoding.
black: fills the uncovered area with black color, without changing the image's aspect ratio.
white: fills the uncovered area with white color, without changing the image's aspect ratio.
gauss: applies Gaussian blur to the uncovered area, without changing the image's aspect ratio.
Default value: black
    */
    @SerializedName("FillType")
    @Expose
    private String FillType;

    /**
    * Video Constant Rate Factor (CRF). Value range: 1-51.
If this parameter is specified, CRF will be used to control video bitrate for transcoding and the original video bitrate will not be used.
We don’t recommend specifying this parameter unless you have special requirements.
    */
    @SerializedName("Vcrf")
    @Expose
    private Long Vcrf;

    /**
    * I-frame interval in frames. Valid values: 0 and 1-100000.
When this parameter is set to 0 or left empty, `Gop` will be automatically set.
    */
    @SerializedName("Gop")
    @Expose
    private Long Gop;

    /**
     * Get Video stream encoder. Valid values:
libx264: H.264
libx265: H.265
av1: AOMedia Video 1
Currently, a resolution within 640x480 must be specified for H.265. and the `av1` container only supports mp4. 
     * @return Codec Video stream encoder. Valid values:
libx264: H.264
libx265: H.265
av1: AOMedia Video 1
Currently, a resolution within 640x480 must be specified for H.265. and the `av1` container only supports mp4.
     */
    public String getCodec() {
        return this.Codec;
    }

    /**
     * Set Video stream encoder. Valid values:
libx264: H.264
libx265: H.265
av1: AOMedia Video 1
Currently, a resolution within 640x480 must be specified for H.265. and the `av1` container only supports mp4.
     * @param Codec Video stream encoder. Valid values:
libx264: H.264
libx265: H.265
av1: AOMedia Video 1
Currently, a resolution within 640x480 must be specified for H.265. and the `av1` container only supports mp4.
     */
    public void setCodec(String Codec) {
        this.Codec = Codec;
    }

    /**
     * Get Video frame rate in Hz. Value range: [0,100].
If the value is 0, the frame rate will be the same as that of the source video. 
     * @return Fps Video frame rate in Hz. Value range: [0,100].
If the value is 0, the frame rate will be the same as that of the source video.
     */
    public Long getFps() {
        return this.Fps;
    }

    /**
     * Set Video frame rate in Hz. Value range: [0,100].
If the value is 0, the frame rate will be the same as that of the source video.
     * @param Fps Video frame rate in Hz. Value range: [0,100].
If the value is 0, the frame rate will be the same as that of the source video.
     */
    public void setFps(Long Fps) {
        this.Fps = Fps;
    }

    /**
     * Get Bitrate of video stream in Kbps. Value range: 0 and [128, 35,000].
If the value is 0, the bitrate of the video will be the same as that of the source video. 
     * @return Bitrate Bitrate of video stream in Kbps. Value range: 0 and [128, 35,000].
If the value is 0, the bitrate of the video will be the same as that of the source video.
     */
    public Long getBitrate() {
        return this.Bitrate;
    }

    /**
     * Set Bitrate of video stream in Kbps. Value range: 0 and [128, 35,000].
If the value is 0, the bitrate of the video will be the same as that of the source video.
     * @param Bitrate Bitrate of video stream in Kbps. Value range: 0 and [128, 35,000].
If the value is 0, the bitrate of the video will be the same as that of the source video.
     */
    public void setBitrate(Long Bitrate) {
        this.Bitrate = Bitrate;
    }

    /**
     * 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.
Note: this field may return null, indicating that no valid values can be obtained. 
     * @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.
Note: this field may return null, indicating that no valid values can be obtained.
     */
    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.
Note: this field may return null, indicating that no valid values can be obtained.
     * @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.
Note: this field may return null, indicating that no valid values can be obtained.
     */
    public void setResolutionAdaptive(String ResolutionAdaptive) {
        this.ResolutionAdaptive = ResolutionAdaptive;
    }

    /**
     * Get Maximum value of the width (or long side) of a video stream 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.
Note: this field may return null, indicating that no valid values can be obtained. 
     * @return Width Maximum value of the width (or long side) of a video stream 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.
Note: this field may return null, indicating that no valid values can be obtained.
     */
    public Long getWidth() {
        return this.Width;
    }

    /**
     * Set Maximum value of the width (or long side) of a video stream 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.
Note: this field may return null, indicating that no valid values can be obtained.
     * @param Width Maximum value of the width (or long side) of a video stream 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.
Note: this field may return null, indicating that no valid values can be obtained.
     */
    public void setWidth(Long Width) {
        this.Width = Width;
    }

    /**
     * Get Maximum value of the height (or short side) of a video stream 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.
Note: this field may return null, indicating that no valid values can be obtained. 
     * @return Height Maximum value of the height (or short side) of a video stream 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.
Note: this field may return null, indicating that no valid values can be obtained.
     */
    public Long getHeight() {
        return this.Height;
    }

    /**
     * Set Maximum value of the height (or short side) of a video stream 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.
Note: this field may return null, indicating that no valid values can be obtained.
     * @param Height Maximum value of the height (or short side) of a video stream 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.
Note: this field may return null, indicating that no valid values can be obtained.
     */
    public void setHeight(Long Height) {
        this.Height = Height;
    }

    /**
     * Get Fill type, the way of processing a screenshot when the configured aspect ratio is different from that of the source video. Valid values:
stretch: stretches the video image frame by frame to fill the screen. The video image may become "squashed" or "stretched" after transcoding.
black: fills the uncovered area with black color, without changing the image's aspect ratio.
white: fills the uncovered area with white color, without changing the image's aspect ratio.
gauss: applies Gaussian blur to the uncovered area, without changing the image's aspect ratio.
Default value: black 
     * @return FillType Fill type, the way of processing a screenshot when the configured aspect ratio is different from that of the source video. Valid values:
stretch: stretches the video image frame by frame to fill the screen. The video image may become "squashed" or "stretched" after transcoding.
black: fills the uncovered area with black color, without changing the image's aspect ratio.
white: fills the uncovered area with white color, without changing the image's aspect ratio.
gauss: applies Gaussian blur to the uncovered area, without changing the image's aspect ratio.
Default value: black
     */
    public String getFillType() {
        return this.FillType;
    }

    /**
     * Set Fill type, the way of processing a screenshot when the configured aspect ratio is different from that of the source video. Valid values:
stretch: stretches the video image frame by frame to fill the screen. The video image may become "squashed" or "stretched" after transcoding.
black: fills the uncovered area with black color, without changing the image's aspect ratio.
white: fills the uncovered area with white color, without changing the image's aspect ratio.
gauss: applies Gaussian blur to the uncovered area, without changing the image's aspect ratio.
Default value: black
     * @param FillType Fill type, the way of processing a screenshot when the configured aspect ratio is different from that of the source video. Valid values:
stretch: stretches the video image frame by frame to fill the screen. The video image may become "squashed" or "stretched" after transcoding.
black: fills the uncovered area with black color, without changing the image's aspect ratio.
white: fills the uncovered area with white color, without changing the image's aspect ratio.
gauss: applies Gaussian blur to the uncovered area, without changing the image's aspect ratio.
Default value: black
     */
    public void setFillType(String FillType) {
        this.FillType = FillType;
    }

    /**
     * Get Video Constant Rate Factor (CRF). Value range: 1-51.
If this parameter is specified, CRF will be used to control video bitrate for transcoding and the original video bitrate will not be used.
We don’t recommend specifying this parameter unless you have special requirements. 
     * @return Vcrf Video Constant Rate Factor (CRF). Value range: 1-51.
If this parameter is specified, CRF will be used to control video bitrate for transcoding and the original video bitrate will not be used.
We don’t recommend specifying this parameter unless you have special requirements.
     */
    public Long getVcrf() {
        return this.Vcrf;
    }

    /**
     * Set Video Constant Rate Factor (CRF). Value range: 1-51.
If this parameter is specified, CRF will be used to control video bitrate for transcoding and the original video bitrate will not be used.
We don’t recommend specifying this parameter unless you have special requirements.
     * @param Vcrf Video Constant Rate Factor (CRF). Value range: 1-51.
If this parameter is specified, CRF will be used to control video bitrate for transcoding and the original video bitrate will not be used.
We don’t recommend specifying this parameter unless you have special requirements.
     */
    public void setVcrf(Long Vcrf) {
        this.Vcrf = Vcrf;
    }

    /**
     * Get I-frame interval in frames. Valid values: 0 and 1-100000.
When this parameter is set to 0 or left empty, `Gop` will be automatically set. 
     * @return Gop I-frame interval in frames. Valid values: 0 and 1-100000.
When this parameter is set to 0 or left empty, `Gop` will be automatically set.
     */
    public Long getGop() {
        return this.Gop;
    }

    /**
     * Set I-frame interval in frames. Valid values: 0 and 1-100000.
When this parameter is set to 0 or left empty, `Gop` will be automatically set.
     * @param Gop I-frame interval in frames. Valid values: 0 and 1-100000.
When this parameter is set to 0 or left empty, `Gop` will be automatically set.
     */
    public void setGop(Long Gop) {
        this.Gop = Gop;
    }

    public VideoTemplateInfo() {
    }

    /**
     * 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 VideoTemplateInfo(VideoTemplateInfo source) {
        if (source.Codec != null) {
            this.Codec = new String(source.Codec);
        }
        if (source.Fps != null) {
            this.Fps = new Long(source.Fps);
        }
        if (source.Bitrate != null) {
            this.Bitrate = new Long(source.Bitrate);
        }
        if (source.ResolutionAdaptive != null) {
            this.ResolutionAdaptive = new String(source.ResolutionAdaptive);
        }
        if (source.Width != null) {
            this.Width = new Long(source.Width);
        }
        if (source.Height != null) {
            this.Height = new Long(source.Height);
        }
        if (source.FillType != null) {
            this.FillType = new String(source.FillType);
        }
        if (source.Vcrf != null) {
            this.Vcrf = new Long(source.Vcrf);
        }
        if (source.Gop != null) {
            this.Gop = new Long(source.Gop);
        }
    }


    /**
     * Internal implementation, normal users should not use it.
     */
    public void toMap(HashMap map, String prefix) {
        this.setParamSimple(map, prefix + "Codec", this.Codec);
        this.setParamSimple(map, prefix + "Fps", this.Fps);
        this.setParamSimple(map, prefix + "Bitrate", this.Bitrate);
        this.setParamSimple(map, prefix + "ResolutionAdaptive", this.ResolutionAdaptive);
        this.setParamSimple(map, prefix + "Width", this.Width);
        this.setParamSimple(map, prefix + "Height", this.Height);
        this.setParamSimple(map, prefix + "FillType", this.FillType);
        this.setParamSimple(map, prefix + "Vcrf", this.Vcrf);
        this.setParamSimple(map, prefix + "Gop", this.Gop);

    }
}