• Home
• com.tencentcloudapi
• tencentcloud-sdk-java-intl-en
• 3.0.1001
• source code
• SubtitleTemplate.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.tencentcloudapi.mps.v20190612.models.SubtitleTemplate Maven / Gradle / Ivy

/*
 * 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.mps.v20190612.models;

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

public class SubtitleTemplate extends AbstractModel {

    /**
    * The URL of the subtitles to add to the video.
Note: This field may return·null, indicating that no valid values can be obtained.
    */
    @SerializedName("Path")
    @Expose
    private String Path;

    /**
    * The subtitle track to add to the video. If both `Path` and `StreamIndex` are specified, `Path` will be used. You need to specify at least one of the two parameters.
Note: This field may return·null, indicating that no valid values can be obtained.
    */
    @SerializedName("StreamIndex")
    @Expose
    private Long StreamIndex;

    /**
    * The font. Valid values:
`hei.ttf`: Heiti.
`song.ttf`: Songti.
`simkai.ttf`: Kaiti.
`arial.ttf`: Arial.
The default is `hei.ttf`.
Note: This field may return·null, indicating that no valid values can be obtained.
    */
    @SerializedName("FontType")
    @Expose
    private String FontType;

    /**
    * The font size (pixels). If this is not specified, the font size in the subtitle file will be used.
Note: This field may return·null, indicating that no valid values can be obtained.
    */
    @SerializedName("FontSize")
    @Expose
    private String FontSize;

    /**
    * The font color in 0xRRGGBB format. Default value: 0xFFFFFF (white).
Note: This field may return·null, indicating that no valid values can be obtained.
    */
    @SerializedName("FontColor")
    @Expose
    private String FontColor;

    /**
    * The text transparency. Value range: 0-1.
`0`: Fully transparent.
`1`: Fully opaque.
Default value: 1.
Note: This field may return·null, indicating that no valid values can be obtained.
    */
    @SerializedName("FontAlpha")
    @Expose
    private Float FontAlpha;

    /**
     * Get The URL of the subtitles to add to the video.
Note: This field may return·null, indicating that no valid values can be obtained. 
     * @return Path The URL of the subtitles to add to the video.
Note: This field may return·null, indicating that no valid values can be obtained.
     */
    public String getPath() {
        return this.Path;
    }

    /**
     * Set The URL of the subtitles to add to the video.
Note: This field may return·null, indicating that no valid values can be obtained.
     * @param Path The URL of the subtitles to add to the video.
Note: This field may return·null, indicating that no valid values can be obtained.
     */
    public void setPath(String Path) {
        this.Path = Path;
    }

    /**
     * Get The subtitle track to add to the video. If both `Path` and `StreamIndex` are specified, `Path` will be used. You need to specify at least one of the two parameters.
Note: This field may return·null, indicating that no valid values can be obtained. 
     * @return StreamIndex The subtitle track to add to the video. If both `Path` and `StreamIndex` are specified, `Path` will be used. You need to specify at least one of the two parameters.
Note: This field may return·null, indicating that no valid values can be obtained.
     */
    public Long getStreamIndex() {
        return this.StreamIndex;
    }

    /**
     * Set The subtitle track to add to the video. If both `Path` and `StreamIndex` are specified, `Path` will be used. You need to specify at least one of the two parameters.
Note: This field may return·null, indicating that no valid values can be obtained.
     * @param StreamIndex The subtitle track to add to the video. If both `Path` and `StreamIndex` are specified, `Path` will be used. You need to specify at least one of the two parameters.
Note: This field may return·null, indicating that no valid values can be obtained.
     */
    public void setStreamIndex(Long StreamIndex) {
        this.StreamIndex = StreamIndex;
    }

    /**
     * Get The font. Valid values:
`hei.ttf`: Heiti.
`song.ttf`: Songti.
`simkai.ttf`: Kaiti.
`arial.ttf`: Arial.
The default is `hei.ttf`.
Note: This field may return·null, indicating that no valid values can be obtained. 
     * @return FontType The font. Valid values:
`hei.ttf`: Heiti.
`song.ttf`: Songti.
`simkai.ttf`: Kaiti.
`arial.ttf`: Arial.
The default is `hei.ttf`.
Note: This field may return·null, indicating that no valid values can be obtained.
     */
    public String getFontType() {
        return this.FontType;
    }

    /**
     * Set The font. Valid values:
`hei.ttf`: Heiti.
`song.ttf`: Songti.
`simkai.ttf`: Kaiti.
`arial.ttf`: Arial.
The default is `hei.ttf`.
Note: This field may return·null, indicating that no valid values can be obtained.
     * @param FontType The font. Valid values:
`hei.ttf`: Heiti.
`song.ttf`: Songti.
`simkai.ttf`: Kaiti.
`arial.ttf`: Arial.
The default is `hei.ttf`.
Note: This field may return·null, indicating that no valid values can be obtained.
     */
    public void setFontType(String FontType) {
        this.FontType = FontType;
    }

    /**
     * Get The font size (pixels). If this is not specified, the font size in the subtitle file will be used.
Note: This field may return·null, indicating that no valid values can be obtained. 
     * @return FontSize The font size (pixels). If this is not specified, the font size in the subtitle file will be used.
Note: This field may return·null, indicating that no valid values can be obtained.
     */
    public String getFontSize() {
        return this.FontSize;
    }

    /**
     * Set The font size (pixels). If this is not specified, the font size in the subtitle file will be used.
Note: This field may return·null, indicating that no valid values can be obtained.
     * @param FontSize The font size (pixels). If this is not specified, the font size in the subtitle file will be used.
Note: This field may return·null, indicating that no valid values can be obtained.
     */
    public void setFontSize(String FontSize) {
        this.FontSize = FontSize;
    }

    /**
     * Get The font color in 0xRRGGBB format. Default value: 0xFFFFFF (white).
Note: This field may return·null, indicating that no valid values can be obtained. 
     * @return FontColor The font color in 0xRRGGBB format. Default value: 0xFFFFFF (white).
Note: This field may return·null, indicating that no valid values can be obtained.
     */
    public String getFontColor() {
        return this.FontColor;
    }

    /**
     * Set The font color in 0xRRGGBB format. Default value: 0xFFFFFF (white).
Note: This field may return·null, indicating that no valid values can be obtained.
     * @param FontColor The font color in 0xRRGGBB format. Default value: 0xFFFFFF (white).
Note: This field may return·null, indicating that no valid values can be obtained.
     */
    public void setFontColor(String FontColor) {
        this.FontColor = FontColor;
    }

    /**
     * Get The text transparency. Value range: 0-1.
`0`: Fully transparent.
`1`: Fully opaque.
Default value: 1.
Note: This field may return·null, indicating that no valid values can be obtained. 
     * @return FontAlpha The text transparency. Value range: 0-1.
`0`: Fully transparent.
`1`: Fully opaque.
Default value: 1.
Note: This field may return·null, indicating that no valid values can be obtained.
     */
    public Float getFontAlpha() {
        return this.FontAlpha;
    }

    /**
     * Set The text transparency. Value range: 0-1.
`0`: Fully transparent.
`1`: Fully opaque.
Default value: 1.
Note: This field may return·null, indicating that no valid values can be obtained.
     * @param FontAlpha The text transparency. Value range: 0-1.
`0`: Fully transparent.
`1`: Fully opaque.
Default value: 1.
Note: This field may return·null, indicating that no valid values can be obtained.
     */
    public void setFontAlpha(Float FontAlpha) {
        this.FontAlpha = FontAlpha;
    }

    public SubtitleTemplate() {
    }

    /**
     * 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 SubtitleTemplate(SubtitleTemplate source) {
        if (source.Path != null) {
            this.Path = new String(source.Path);
        }
        if (source.StreamIndex != null) {
            this.StreamIndex = new Long(source.StreamIndex);
        }
        if (source.FontType != null) {
            this.FontType = new String(source.FontType);
        }
        if (source.FontSize != null) {
            this.FontSize = new String(source.FontSize);
        }
        if (source.FontColor != null) {
            this.FontColor = new String(source.FontColor);
        }
        if (source.FontAlpha != null) {
            this.FontAlpha = new Float(source.FontAlpha);
        }
    }


    /**
     * Internal implementation, normal users should not use it.
     */
    public void toMap(HashMap map, String prefix) {
        this.setParamSimple(map, prefix + "Path", this.Path);
        this.setParamSimple(map, prefix + "StreamIndex", this.StreamIndex);
        this.setParamSimple(map, prefix + "FontType", this.FontType);
        this.setParamSimple(map, prefix + "FontSize", this.FontSize);
        this.setParamSimple(map, prefix + "FontColor", this.FontColor);
        this.setParamSimple(map, prefix + "FontAlpha", this.FontAlpha);

    }
}