com.tencentcloudapi.mps.v20190612.models

Class SubtitleTemplate

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.mps.v20190612.models.SubtitleTemplate

public class SubtitleTemplate
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
SubtitleTemplate()
SubtitleTemplate(SubtitleTemplate source) 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.

Method Summary

Modifier and Type	Method and Description
String	getAlignment() Get 对齐方式，，取值：top: 顶部对齐，字幕顶部按位置固定，底部随行数变化。bottom: 底部对齐，字幕底部按位置固定，顶部随行数变化。 注意：此字段可能返回 null，表示取不到有效值。
Float	getBoardAlpha() Get 字幕背景板透明度，取值范围：[0, 1] 0：完全透明 1：完全不透明 默认值：0.8。 注意：此字段可能返回 null，表示取不到有效值。
String	getBoardColor() Get 底板颜色。格式：0xRRGGBB， 默认值：0x000000（黑色）。 注意：此字段可能返回 null，表示取不到有效值。
Long	getBoardHeight() Get 底板的高度。单位为像素，取值范围：[0,4096]。 默认为源视频高像素的15%。 注意：此字段可能返回 null，表示取不到有效值。
Long	getBoardWidth() Get 底板的宽度，单位为像素，取值范围：[0,4096]。 默认源视频宽像素的90%。 注意：此字段可能返回 null，表示取不到有效值。
String	getBoardY() Get 字幕背景底板的y轴坐标位置；支持像素和百分比格式： - 像素：Npx，N范围：[0,4096]。 - 百分百：N%，N范围：[0,100]；例如10%表示字幕背景底板y坐标=10%*源视频高度。 不传表示不开启字幕背景底板。 注意：坐标轴原点位于源视频的中轴线底部，字幕背景底板的基准点在其中轴线底部，参考下图：  注意：此字段可能返回 null，表示取不到有效值。
Float	getFontAlpha() Get 文字透明度，取值范围：(0, 1] 0：完全透明 1：完全不透明 默认值：1。 注意：此字段可能返回 null，表示取不到有效值。
String	getFontColor() Get 字体颜色，格式：0xRRGGBB，默认值：0xFFFFFF（白色）。 注意：此字段可能返回 null，表示取不到有效值。
String	getFontSize() Get 字体大小，格式：Npx，N 为数值，不指定则以字幕文件中为准。 默认源视频高度的5%。 注意：此字段可能返回 null，表示取不到有效值。
String	getFontType() Get 字体类型，支持： hei.ttf：黑体 song.ttf：宋体 kai.ttf（推荐）或 simkai.ttf：楷体 msyh.ttf：微软雅黑 msyhbd.ttf：微软雅黑加粗 hkjgt.ttf：华康金刚体 dhttx.ttf：典黑体特细 xqgdzt.ttf：喜鹊古字典体 qpcyt.ttf：巧拼超圆体 arial.ttf：仅支持英文 dinalternate.ttf：DIN Alternate Bold helveticalt.ttf：Helvetica helveticains.ttf：Helvetica Inserat trajanpro.ttf：TrajanPro-Bold korean.ttf：韩语 japanese.ttf：日语 thai.ttf：泰语 默认：hei.ttf 黑体。注意：楷体推荐使用kai.ttf 注意：此字段可能返回 null，表示取不到有效值。
Long	getLineSpacing() Get 行间距。正整数 [0, 1000] 注意：此字段可能返回 null，表示取不到有效值。
Float	getOutlineAlpha() Get 描边透明度。(0，1] 正浮点数 注意：此字段可能返回 null，表示取不到有效值。
String	getOutlineColor() Get 描边颜色。6位16进制RGB 注意：此字段可能返回 null，表示取不到有效值。
Float	getOutlineWidth() Get 描边宽度 注意：此字段可能返回 null，表示取不到有效值。
String	getPath() Get 要压制到视频中的字幕文件地址。 注意：此字段可能返回 null，表示取不到有效值。
Float	getShadowAlpha() Get 阴影透明度。(0，1] 正浮点数 注意：此字段可能返回 null，表示取不到有效值。
String	getShadowColor() Get 阴影颜色。6位16进制RGB 注意：此字段可能返回 null，表示取不到有效值。
Float	getShadowWidth() Get 阴影宽度。浮点数 [0, 1000] 注意：此字段可能返回 null，表示取不到有效值。
Long	getStreamIndex() Get 指定要压制到视频中的字幕轨道，Streamindex的取值从0开始，0表示使用源视频中的第一条字幕轨。如果指定了Path，则优先使用Path。Path 和 StreamIndex 至少指定一个。 - 注意：StreamIndex必须与源文件中的字幕轨索引一致。例如，源文件中的字幕轨为stream#0:3，则StreamIndex应为3，否则可能导致任务处理失败。 注意：此字段可能返回 null，表示取不到有效值。
MediaInputInfo	getSubtitleFileInput() Get 要压制到视频中的字幕文件的输入信息，目前仅支持存储在COS的字幕文件 注意：此字段可能返回 null，表示取不到有效值。
String	getYPos() Get 字幕y轴坐标位置，指定此参数会忽略字幕文件自带坐标；支持像素和百分比格式： - 像素：Npx，N范围：[0,4096]。 - 百分百：N%，N范围：[0,100]；例如10%表示字幕y坐标=10%*源视频高度。 默认值：源视频高度*4%。 注意：坐标轴原点在源视频中轴线底部，字幕基准点在字幕中轴线底部，参考下图：  注意：此字段可能返回 null，表示取不到有效值。
void	setAlignment(String Alignment) Set 对齐方式，，取值：top: 顶部对齐，字幕顶部按位置固定，底部随行数变化。bottom: 底部对齐，字幕底部按位置固定，顶部随行数变化。 注意：此字段可能返回 null，表示取不到有效值。
void	setBoardAlpha(Float BoardAlpha) Set 字幕背景板透明度，取值范围：[0, 1] 0：完全透明 1：完全不透明 默认值：0.8。 注意：此字段可能返回 null，表示取不到有效值。
void	setBoardColor(String BoardColor) Set 底板颜色。格式：0xRRGGBB， 默认值：0x000000（黑色）。 注意：此字段可能返回 null，表示取不到有效值。
void	setBoardHeight(Long BoardHeight) Set 底板的高度。单位为像素，取值范围：[0,4096]。 默认为源视频高像素的15%。 注意：此字段可能返回 null，表示取不到有效值。
void	setBoardWidth(Long BoardWidth) Set 底板的宽度，单位为像素，取值范围：[0,4096]。 默认源视频宽像素的90%。 注意：此字段可能返回 null，表示取不到有效值。
void	setBoardY(String BoardY) Set 字幕背景底板的y轴坐标位置；支持像素和百分比格式： - 像素：Npx，N范围：[0,4096]。 - 百分百：N%，N范围：[0,100]；例如10%表示字幕背景底板y坐标=10%*源视频高度。 不传表示不开启字幕背景底板。 注意：坐标轴原点位于源视频的中轴线底部，字幕背景底板的基准点在其中轴线底部，参考下图：  注意：此字段可能返回 null，表示取不到有效值。
void	setFontAlpha(Float FontAlpha) Set 文字透明度，取值范围：(0, 1] 0：完全透明 1：完全不透明 默认值：1。 注意：此字段可能返回 null，表示取不到有效值。
void	setFontColor(String FontColor) Set 字体颜色，格式：0xRRGGBB，默认值：0xFFFFFF（白色）。 注意：此字段可能返回 null，表示取不到有效值。
void	setFontSize(String FontSize) Set 字体大小，格式：Npx，N 为数值，不指定则以字幕文件中为准。 默认源视频高度的5%。 注意：此字段可能返回 null，表示取不到有效值。
void	setFontType(String FontType) Set 字体类型，支持： hei.ttf：黑体 song.ttf：宋体 kai.ttf（推荐）或 simkai.ttf：楷体 msyh.ttf：微软雅黑 msyhbd.ttf：微软雅黑加粗 hkjgt.ttf：华康金刚体 dhttx.ttf：典黑体特细 xqgdzt.ttf：喜鹊古字典体 qpcyt.ttf：巧拼超圆体 arial.ttf：仅支持英文 dinalternate.ttf：DIN Alternate Bold helveticalt.ttf：Helvetica helveticains.ttf：Helvetica Inserat trajanpro.ttf：TrajanPro-Bold korean.ttf：韩语 japanese.ttf：日语 thai.ttf：泰语 默认：hei.ttf 黑体。注意：楷体推荐使用kai.ttf 注意：此字段可能返回 null，表示取不到有效值。
void	setLineSpacing(Long LineSpacing) Set 行间距。正整数 [0, 1000] 注意：此字段可能返回 null，表示取不到有效值。
void	setOutlineAlpha(Float OutlineAlpha) Set 描边透明度。(0，1] 正浮点数 注意：此字段可能返回 null，表示取不到有效值。
void	setOutlineColor(String OutlineColor) Set 描边颜色。6位16进制RGB 注意：此字段可能返回 null，表示取不到有效值。
void	setOutlineWidth(Float OutlineWidth) Set 描边宽度 注意：此字段可能返回 null，表示取不到有效值。
void	setPath(String Path) Set 要压制到视频中的字幕文件地址。 注意：此字段可能返回 null，表示取不到有效值。
void	setShadowAlpha(Float ShadowAlpha) Set 阴影透明度。(0，1] 正浮点数 注意：此字段可能返回 null，表示取不到有效值。
void	setShadowColor(String ShadowColor) Set 阴影颜色。6位16进制RGB 注意：此字段可能返回 null，表示取不到有效值。
void	setShadowWidth(Float ShadowWidth) Set 阴影宽度。浮点数 [0, 1000] 注意：此字段可能返回 null，表示取不到有效值。
void	setStreamIndex(Long StreamIndex) Set 指定要压制到视频中的字幕轨道，Streamindex的取值从0开始，0表示使用源视频中的第一条字幕轨。如果指定了Path，则优先使用Path。Path 和 StreamIndex 至少指定一个。 - 注意：StreamIndex必须与源文件中的字幕轨索引一致。例如，源文件中的字幕轨为stream#0:3，则StreamIndex应为3，否则可能导致任务处理失败。 注意：此字段可能返回 null，表示取不到有效值。
void	setSubtitleFileInput(MediaInputInfo SubtitleFileInput) Set 要压制到视频中的字幕文件的输入信息，目前仅支持存储在COS的字幕文件 注意：此字段可能返回 null，表示取不到有效值。
void	setYPos(String YPos) Set 字幕y轴坐标位置，指定此参数会忽略字幕文件自带坐标；支持像素和百分比格式： - 像素：Npx，N范围：[0,4096]。 - 百分百：N%，N范围：[0,100]；例如10%表示字幕y坐标=10%*源视频高度。 默认值：源视频高度*4%。 注意：坐标轴原点在源视频中轴线底部，字幕基准点在字幕中轴线底部，参考下图：  注意：此字段可能返回 null，表示取不到有效值。
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubtitleTemplate

public SubtitleTemplate()

SubtitleTemplate

public SubtitleTemplate(SubtitleTemplate source)

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.

Method Detail

getPath

public String getPath()

Get 要压制到视频中的字幕文件地址。 注意：此字段可能返回 null，表示取不到有效值。

Returns:

Path 要压制到视频中的字幕文件地址。 注意：此字段可能返回 null，表示取不到有效值。

setPath

public void setPath(String Path)

Set 要压制到视频中的字幕文件地址。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

Path - 要压制到视频中的字幕文件地址。 注意：此字段可能返回 null，表示取不到有效值。

getStreamIndex

public Long getStreamIndex()

Get 指定要压制到视频中的字幕轨道，Streamindex的取值从0开始，0表示使用源视频中的第一条字幕轨。如果指定了Path，则优先使用Path。Path 和 StreamIndex 至少指定一个。 - 注意：StreamIndex必须与源文件中的字幕轨索引一致。例如，源文件中的字幕轨为stream#0:3，则StreamIndex应为3，否则可能导致任务处理失败。 注意：此字段可能返回 null，表示取不到有效值。

Returns:

StreamIndex 指定要压制到视频中的字幕轨道，Streamindex的取值从0开始，0表示使用源视频中的第一条字幕轨。如果指定了Path，则优先使用Path。Path 和 StreamIndex 至少指定一个。 - 注意：StreamIndex必须与源文件中的字幕轨索引一致。例如，源文件中的字幕轨为stream#0:3，则StreamIndex应为3，否则可能导致任务处理失败。 注意：此字段可能返回 null，表示取不到有效值。

setStreamIndex

public void setStreamIndex(Long StreamIndex)

Set 指定要压制到视频中的字幕轨道，Streamindex的取值从0开始，0表示使用源视频中的第一条字幕轨。如果指定了Path，则优先使用Path。Path 和 StreamIndex 至少指定一个。 - 注意：StreamIndex必须与源文件中的字幕轨索引一致。例如，源文件中的字幕轨为stream#0:3，则StreamIndex应为3，否则可能导致任务处理失败。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

StreamIndex - 指定要压制到视频中的字幕轨道，Streamindex的取值从0开始，0表示使用源视频中的第一条字幕轨。如果指定了Path，则优先使用Path。Path 和 StreamIndex 至少指定一个。 - 注意：StreamIndex必须与源文件中的字幕轨索引一致。例如，源文件中的字幕轨为stream#0:3，则StreamIndex应为3，否则可能导致任务处理失败。 注意：此字段可能返回 null，表示取不到有效值。

getSubtitleFileInput

public MediaInputInfo getSubtitleFileInput()

Get 要压制到视频中的字幕文件的输入信息，目前仅支持存储在COS的字幕文件 注意：此字段可能返回 null，表示取不到有效值。

Returns:

SubtitleFileInput 要压制到视频中的字幕文件的输入信息，目前仅支持存储在COS的字幕文件 注意：此字段可能返回 null，表示取不到有效值。

setSubtitleFileInput

public void setSubtitleFileInput(MediaInputInfo SubtitleFileInput)

Set 要压制到视频中的字幕文件的输入信息，目前仅支持存储在COS的字幕文件 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

SubtitleFileInput - 要压制到视频中的字幕文件的输入信息，目前仅支持存储在COS的字幕文件 注意：此字段可能返回 null，表示取不到有效值。

getFontType

public String getFontType()

Get 字体类型，支持：

hei.ttf：黑体 song.ttf：宋体 kai.ttf（推荐）或 simkai.ttf：楷体 msyh.ttf：微软雅黑 msyhbd.ttf：微软雅黑加粗 hkjgt.ttf：华康金刚体 dhttx.ttf：典黑体特细 xqgdzt.ttf：喜鹊古字典体 qpcyt.ttf：巧拼超圆体 arial.ttf：仅支持英文 dinalternate.ttf：DIN Alternate Bold helveticalt.ttf：Helvetica helveticains.ttf：Helvetica Inserat trajanpro.ttf：TrajanPro-Bold korean.ttf：韩语 japanese.ttf：日语 thai.ttf：泰语 默认：hei.ttf 黑体。注意：楷体推荐使用kai.ttf 注意：此字段可能返回 null，表示取不到有效值。

Returns:

FontType 字体类型，支持：

hei.ttf：黑体

song.ttf：宋体

kai.ttf（推荐）或 simkai.ttf：楷体

msyh.ttf：微软雅黑

msyhbd.ttf：微软雅黑加粗

hkjgt.ttf：华康金刚体

dhttx.ttf：典黑体特细

xqgdzt.ttf：喜鹊古字典体

qpcyt.ttf：巧拼超圆体

arial.ttf：仅支持英文

dinalternate.ttf：DIN Alternate Bold

helveticalt.ttf：Helvetica

helveticains.ttf：Helvetica Inserat

trajanpro.ttf：TrajanPro-Bold

korean.ttf：韩语

japanese.ttf：日语

thai.ttf：泰语

默认：hei.ttf 黑体。注意：楷体推荐使用kai.ttf 注意：此字段可能返回 null，表示取不到有效值。

setFontType

public void setFontType(String FontType)

Set 字体类型，支持：

hei.ttf：黑体 song.ttf：宋体 kai.ttf（推荐）或 simkai.ttf：楷体 msyh.ttf：微软雅黑 msyhbd.ttf：微软雅黑加粗 hkjgt.ttf：华康金刚体 dhttx.ttf：典黑体特细 xqgdzt.ttf：喜鹊古字典体 qpcyt.ttf：巧拼超圆体 arial.ttf：仅支持英文 dinalternate.ttf：DIN Alternate Bold helveticalt.ttf：Helvetica helveticains.ttf：Helvetica Inserat trajanpro.ttf：TrajanPro-Bold korean.ttf：韩语 japanese.ttf：日语 thai.ttf：泰语 默认：hei.ttf 黑体。注意：楷体推荐使用kai.ttf 注意：此字段可能返回 null，表示取不到有效值。