Class WatermarkInput

    • Constructor Summary

      Constructors 
      Constructor Description
      WatermarkInput()  
      WatermarkInput​(WatermarkInput 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 秒前消失。
      RawWatermarkParameter getRawParameter()
      Get 水印自定义参数,当 Definition 填 0 时有效。 该参数用于高度定制场景,建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。
      Float getStartTimeOffset()
      Get 水印的起始时间偏移,单位:秒。不填或填0,表示水印从画面出现时开始显现。 不填或填0,表示水印从画面开始就出现; 当数值大于0时(假设为 n),表示水印从画面开始的第 n 秒出现; 当数值小于0时(假设为 -n),表示水印从离画面结束 n 秒前开始出现。
      String getSvgContent()
      Get SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。
      String getTextContent()
      Get 文字内容,长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。
      void setDefinition​(Long Definition)
      Set 水印模板 ID。
      void setEndTimeOffset​(Float EndTimeOffset)
      Set 水印的结束时间偏移,单位:秒。 不填或填0,表示水印持续到画面结束; 当数值大于0时(假设为 n),表示水印持续到第 n 秒时消失; 当数值小于0时(假设为 -n),表示水印持续到离画面结束 n 秒前消失。
      void setRawParameter​(RawWatermarkParameter RawParameter)
      Set 水印自定义参数,当 Definition 填 0 时有效。 该参数用于高度定制场景,建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。
      void setStartTimeOffset​(Float StartTimeOffset)
      Set 水印的起始时间偏移,单位:秒。不填或填0,表示水印从画面出现时开始显现。 不填或填0,表示水印从画面开始就出现; 当数值大于0时(假设为 n),表示水印从画面开始的第 n 秒出现; 当数值小于0时(假设为 -n),表示水印从离画面结束 n 秒前开始出现。
      void setSvgContent​(String SvgContent)
      Set SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。
      void setTextContent​(String TextContent)
      Set 文字内容,长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.
    • Constructor Detail

      • WatermarkInput

        public WatermarkInput()
      • WatermarkInput

        public WatermarkInput​(WatermarkInput 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 RawWatermarkParameter getRawParameter()
        Get 水印自定义参数,当 Definition 填 0 时有效。 该参数用于高度定制场景,建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。
        Returns:
        RawParameter 水印自定义参数,当 Definition 填 0 时有效。 该参数用于高度定制场景,建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。
      • setRawParameter

        public void setRawParameter​(RawWatermarkParameter RawParameter)
        Set 水印自定义参数,当 Definition 填 0 时有效。 该参数用于高度定制场景,建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。
        Parameters:
        RawParameter - 水印自定义参数,当 Definition 填 0 时有效。 该参数用于高度定制场景,建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。
      • getTextContent

        public String getTextContent()
        Get 文字内容,长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。
        Returns:
        TextContent 文字内容,长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。
      • setTextContent

        public void setTextContent​(String TextContent)
        Set 文字内容,长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。
        Parameters:
        TextContent - 文字内容,长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。
      • getSvgContent

        public String getSvgContent()
        Get SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。
        Returns:
        SvgContent SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。
      • setSvgContent

        public void setSvgContent​(String SvgContent)
        Set SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。
        Parameters:
        SvgContent - SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。
      • getStartTimeOffset

        public Float getStartTimeOffset()
        Get 水印的起始时间偏移,单位:秒。不填或填0,表示水印从画面出现时开始显现。
      • 不填或填0,表示水印从画面开始就出现;
      • 当数值大于0时(假设为 n),表示水印从画面开始的第 n 秒出现;
      • 当数值小于0时(假设为 -n),表示水印从离画面结束 n 秒前开始出现。
Returns:
StartTimeOffset 水印的起始时间偏移,单位:秒。不填或填0,表示水印从画面出现时开始显现。
  • 不填或填0,表示水印从画面开始就出现;
  • 当数值大于0时(假设为 n),表示水印从画面开始的第 n 秒出现;
  • 当数值小于0时(假设为 -n),表示水印从离画面结束 n 秒前开始出现。
  • Parameters:
    StartTimeOffset - 水印的起始时间偏移,单位:秒。不填或填0,表示水印从画面出现时开始显现。
  • 不填或填0,表示水印从画面开始就出现;
  • 当数值大于0时(假设为 n),表示水印从画面开始的第 n 秒出现;
  • 当数值小于0时(假设为 -n),表示水印从离画面结束 n 秒前开始出现。