Package com.tencentcloudapi.mps.v20190612.models

Class TranscodeTaskInput

    • Constructor Summary

      Constructors 
      Constructor Description
      TranscodeTaskInput()  
      TranscodeTaskInput​(TranscodeTaskInput 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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Long getDefinition()
      Get 视频转码模板 ID。
      Float getEndTimeOffset()
      Get 转码后视频的终止时间偏移，单位：秒。 不填或填0，表示转码后的视频持续到原始视频的末尾终止； 当数值大于0时（假设为 n），表示转码后的视频持续到原始视频第 n 秒时终止； 当数值小于0时（假设为 -n），表示转码后的视频持续到原始视频结束 n 秒前终止。
      HeadTailParameter getHeadTailParameter()
      Get 片头片尾参数。 注意：此字段可能返回 null，表示取不到有效值。
      MosaicInput[] getMosaicSet()
      Get 马赛克列表，最大可支持 10 张。
      NumberFormat getObjectNumberFormat()
      Get 转码后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。
      String getOutputObjectPath()
      Get 转码后主文件的输出路径，可以为相对路径或者绝对路径。如果不填，则默认为相对路径：`{inputName}_transcode_{definition}.{format}`。
      TaskOutputStorage getOutputStorage()
      Get 转码后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。
      OverrideTranscodeParameter getOverrideParameter()
      Get 视频转码自定义参数，当 Definition 不填 0 时有效。 当填写了该结构中的部分转码参数时，将使用填写的参数覆盖转码模板中的参数。 该参数用于高度定制场景，建议您仅使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。
      RawTranscodeParameter getRawParameter()
      Get 视频转码自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。
      String getSegmentObjectName()
      Get 转码后分片文件的输出路径（转码 HLS 时 ts 的路径），只能为相对路径。如果不填，则默认为：`{inputName}_transcode_{definition}_{number}.{format}`。
      Float getStartTimeOffset()
      Get 转码后的视频的起始时间偏移，单位：秒。 不填或填0，表示转码后的视频从原始视频的起始位置开始； 当数值大于0时（假设为 n），表示转码后的视频从原始视频的第 n 秒位置开始； 当数值小于0时（假设为 -n），表示转码后的视频从原始视频结束 n 秒前的位置开始。
      WatermarkInput[] getWatermarkSet()
      Get 水印列表，支持多张图片或文字水印，最大可支持 10 张。 注意：此字段可能返回 null，表示取不到有效值。
      void setDefinition​(Long Definition)
      Set 视频转码模板 ID。
      void setEndTimeOffset​(Float EndTimeOffset)
      Set 转码后视频的终止时间偏移，单位：秒。 不填或填0，表示转码后的视频持续到原始视频的末尾终止； 当数值大于0时（假设为 n），表示转码后的视频持续到原始视频第 n 秒时终止； 当数值小于0时（假设为 -n），表示转码后的视频持续到原始视频结束 n 秒前终止。
      void setHeadTailParameter​(HeadTailParameter HeadTailParameter)
      Set 片头片尾参数。 注意：此字段可能返回 null，表示取不到有效值。
      void setMosaicSet​(MosaicInput[] MosaicSet)
      Set 马赛克列表，最大可支持 10 张。
      void setObjectNumberFormat​(NumberFormat ObjectNumberFormat)
      Set 转码后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。
      void setOutputObjectPath​(String OutputObjectPath)
      Set 转码后主文件的输出路径，可以为相对路径或者绝对路径。如果不填，则默认为相对路径：`{inputName}_transcode_{definition}.{format}`。
      void setOutputStorage​(TaskOutputStorage OutputStorage)
      Set 转码后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。
      void setOverrideParameter​(OverrideTranscodeParameter OverrideParameter)
      Set 视频转码自定义参数，当 Definition 不填 0 时有效。 当填写了该结构中的部分转码参数时，将使用填写的参数覆盖转码模板中的参数。 该参数用于高度定制场景，建议您仅使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。
      void setRawParameter​(RawTranscodeParameter RawParameter)
      Set 视频转码自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。
      void setSegmentObjectName​(String SegmentObjectName)
      Set 转码后分片文件的输出路径（转码 HLS 时 ts 的路径），只能为相对路径。如果不填，则默认为：`{inputName}_transcode_{definition}_{number}.{format}`。
      void setStartTimeOffset​(Float StartTimeOffset)
      Set 转码后的视频的起始时间偏移，单位：秒。 不填或填0，表示转码后的视频从原始视频的起始位置开始； 当数值大于0时（假设为 n），表示转码后的视频从原始视频的第 n 秒位置开始； 当数值小于0时（假设为 -n），表示转码后的视频从原始视频结束 n 秒前的位置开始。
      void setWatermarkSet​(WatermarkInput[] WatermarkSet)
      Set 水印列表，支持多张图片或文字水印，最大可支持 10 张。 注意：此字段可能返回 null，表示取不到有效值。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • TranscodeTaskInput

        public TranscodeTaskInput()

      • TranscodeTaskInput

        public TranscodeTaskInput​(TranscodeTaskInput 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

      • getDefinition

        public Long getDefinition()
        Get 视频转码模板 ID。
        Returns:
        Definition 视频转码模板 ID。

      • setDefinition

        public void setDefinition​(Long Definition)
        Set 视频转码模板 ID。
        Parameters:
        Definition - 视频转码模板 ID。

      • getRawParameter

        public RawTranscodeParameter getRawParameter()
        Get 视频转码自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        RawParameter 视频转码自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。

      • setRawParameter

        public void setRawParameter​(RawTranscodeParameter RawParameter)
        Set 视频转码自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        RawParameter - 视频转码自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。

      • getOverrideParameter

        public OverrideTranscodeParameter getOverrideParameter()
        Get 视频转码自定义参数，当 Definition 不填 0 时有效。 当填写了该结构中的部分转码参数时，将使用填写的参数覆盖转码模板中的参数。 该参数用于高度定制场景，建议您仅使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        OverrideParameter 视频转码自定义参数，当 Definition 不填 0 时有效。 当填写了该结构中的部分转码参数时，将使用填写的参数覆盖转码模板中的参数。 该参数用于高度定制场景，建议您仅使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。

      • setOverrideParameter

        public void setOverrideParameter​(OverrideTranscodeParameter OverrideParameter)
        Set 视频转码自定义参数，当 Definition 不填 0 时有效。 当填写了该结构中的部分转码参数时，将使用填写的参数覆盖转码模板中的参数。 该参数用于高度定制场景，建议您仅使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        OverrideParameter - 视频转码自定义参数，当 Definition 不填 0 时有效。 当填写了该结构中的部分转码参数时，将使用填写的参数覆盖转码模板中的参数。 该参数用于高度定制场景，建议您仅使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。

      • getWatermarkSet

        public WatermarkInput[] getWatermarkSet()
        Get 水印列表，支持多张图片或文字水印，最大可支持 10 张。 注意：此字段可能返回 null，表示取不到有效值。
        Returns:
        WatermarkSet 水印列表，支持多张图片或文字水印，最大可支持 10 张。 注意：此字段可能返回 null，表示取不到有效值。

      • setWatermarkSet

        public void setWatermarkSet​(WatermarkInput[] WatermarkSet)
        Set 水印列表，支持多张图片或文字水印，最大可支持 10 张。 注意：此字段可能返回 null，表示取不到有效值。
        Parameters:
        WatermarkSet - 水印列表，支持多张图片或文字水印，最大可支持 10 张。 注意：此字段可能返回 null，表示取不到有效值。

      • getMosaicSet

        public MosaicInput[] getMosaicSet()
        Get 马赛克列表，最大可支持 10 张。
        Returns:
        MosaicSet 马赛克列表，最大可支持 10 张。

      • setMosaicSet

        public void setMosaicSet​(MosaicInput[] MosaicSet)
        Set 马赛克列表，最大可支持 10 张。
        Parameters:
        MosaicSet - 马赛克列表，最大可支持 10 张。

      • getStartTimeOffset

        public Float getStartTimeOffset()
        Get 转码后的视频的起始时间偏移，单位：秒。
      • 不填或填0，表示转码后的视频从原始视频的起始位置开始；
      • 当数值大于0时（假设为 n），表示转码后的视频从原始视频的第 n 秒位置开始；
      • 当数值小于0时（假设为 -n），表示转码后的视频从原始视频结束 n 秒前的位置开始。
Returns:
StartTimeOffset 转码后的视频的起始时间偏移，单位：秒。
  • 不填或填0，表示转码后的视频从原始视频的起始位置开始；
  • 当数值大于0时（假设为 n），表示转码后的视频从原始视频的第 n 秒位置开始；
  • 当数值小于0时（假设为 -n），表示转码后的视频从原始视频结束 n 秒前的位置开始。
    • Parameters:
    StartTimeOffset - 转码后的视频的起始时间偏移，单位：秒。
  • 不填或填0，表示转码后的视频从原始视频的起始位置开始；
  • 当数值大于0时（假设为 n），表示转码后的视频从原始视频的第 n 秒位置开始；
  • 当数值小于0时（假设为 -n），表示转码后的视频从原始视频结束 n 秒前的位置开始。