Package com.tencentcloudapi.live.v20180801.models

Class CommonMixLayoutParams

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getColor()
      Get 当InputType为3(画布)时，该值表示画布的颜色。 常用的颜色有： 红色：0xCC0033。 黄色：0xCC9900。 绿色：0xCCCC33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。
      Float getImageHeight()
      Get 输入画面在输出时的高度。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为输入流的高度。 使用百分比时，期望输出为（百分比 * 背景高）。
      Long getImageLayer()
      Get 输入图层。取值范围[1，16]。 1)背景流（即大主播画面或画布）的 image_layer 填1。 2)纯音频混流，该参数也需填。 注意：不同输入，该值不可重复
      Float getImageWidth()
      Get 输入画面在输出时的宽度。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为输入流的宽度。 使用百分比时，期望输出为（百分比 * 背景宽）。
      Long getInputType()
      Get 输入类型。取值范围[0，5]。 不填默认为0。 0表示输入流为音视频。 2表示输入流为图片。 3表示输入流为画布。 4表示输入流为音频。 5表示输入流为纯视频。
      Float getLocationX()
      Get 输入在输出画面的X偏移。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为0。 相对于大主播背景画面左上角的横向偏移。 使用百分比时，期望输出为（百分比 * 背景宽）。
      Float getLocationY()
      Get 输入在输出画面的Y偏移。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为0。 相对于大主播背景画面左上角的纵向偏移。 使用百分比时，期望输出为（百分比 * 背景宽）
      Long getWatermarkId()
      Get 当InputType为2(图片)时，该值是水印ID。
      void setColor​(String Color)
      Set 当InputType为3(画布)时，该值表示画布的颜色。 常用的颜色有： 红色：0xCC0033。 黄色：0xCC9900。 绿色：0xCCCC33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。
      void setImageHeight​(Float ImageHeight)
      Set 输入画面在输出时的高度。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为输入流的高度。 使用百分比时，期望输出为（百分比 * 背景高）。
      void setImageLayer​(Long ImageLayer)
      Set 输入图层。取值范围[1，16]。 1)背景流（即大主播画面或画布）的 image_layer 填1。 2)纯音频混流，该参数也需填。 注意：不同输入，该值不可重复
      void setImageWidth​(Float ImageWidth)
      Set 输入画面在输出时的宽度。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为输入流的宽度。 使用百分比时，期望输出为（百分比 * 背景宽）。
      void setInputType​(Long InputType)
      Set 输入类型。取值范围[0，5]。 不填默认为0。 0表示输入流为音视频。 2表示输入流为图片。 3表示输入流为画布。 4表示输入流为音频。 5表示输入流为纯视频。
      void setLocationX​(Float LocationX)
      Set 输入在输出画面的X偏移。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为0。 相对于大主播背景画面左上角的横向偏移。 使用百分比时，期望输出为（百分比 * 背景宽）。
      void setLocationY​(Float LocationY)
      Set 输入在输出画面的Y偏移。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为0。 相对于大主播背景画面左上角的纵向偏移。 使用百分比时，期望输出为（百分比 * 背景宽）
      void setWatermarkId​(Long WatermarkId)
      Set 当InputType为2(图片)时，该值是水印ID。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • CommonMixLayoutParams

        public CommonMixLayoutParams()

      • CommonMixLayoutParams

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

      • getImageLayer

        public Long getImageLayer()
        Get 输入图层。取值范围[1，16]。 1)背景流（即大主播画面或画布）的 image_layer 填1。 2)纯音频混流，该参数也需填。 注意：不同输入，该值不可重复
        Returns:
        ImageLayer 输入图层。取值范围[1，16]。 1)背景流（即大主播画面或画布）的 image_layer 填1。 2)纯音频混流，该参数也需填。 注意：不同输入，该值不可重复

      • setImageLayer

        public void setImageLayer​(Long ImageLayer)
        Set 输入图层。取值范围[1，16]。 1)背景流（即大主播画面或画布）的 image_layer 填1。 2)纯音频混流，该参数也需填。 注意：不同输入，该值不可重复
        Parameters:
        ImageLayer - 输入图层。取值范围[1，16]。 1)背景流（即大主播画面或画布）的 image_layer 填1。 2)纯音频混流，该参数也需填。 注意：不同输入，该值不可重复

      • getInputType

        public Long getInputType()
        Get 输入类型。取值范围[0，5]。 不填默认为0。 0表示输入流为音视频。 2表示输入流为图片。 3表示输入流为画布。 4表示输入流为音频。 5表示输入流为纯视频。
        Returns:
        InputType 输入类型。取值范围[0，5]。 不填默认为0。 0表示输入流为音视频。 2表示输入流为图片。 3表示输入流为画布。 4表示输入流为音频。 5表示输入流为纯视频。

      • setInputType

        public void setInputType​(Long InputType)
        Set 输入类型。取值范围[0，5]。 不填默认为0。 0表示输入流为音视频。 2表示输入流为图片。 3表示输入流为画布。 4表示输入流为音频。 5表示输入流为纯视频。
        Parameters:
        InputType - 输入类型。取值范围[0，5]。 不填默认为0。 0表示输入流为音视频。 2表示输入流为图片。 3表示输入流为画布。 4表示输入流为音频。 5表示输入流为纯视频。

      • getImageHeight

        public Float getImageHeight()
        Get 输入画面在输出时的高度。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为输入流的高度。 使用百分比时，期望输出为（百分比 * 背景高）。
        Returns:
        ImageHeight 输入画面在输出时的高度。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为输入流的高度。 使用百分比时，期望输出为（百分比 * 背景高）。

      • setImageHeight

        public void setImageHeight​(Float ImageHeight)
        Set 输入画面在输出时的高度。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为输入流的高度。 使用百分比时，期望输出为（百分比 * 背景高）。
        Parameters:
        ImageHeight - 输入画面在输出时的高度。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为输入流的高度。 使用百分比时，期望输出为（百分比 * 背景高）。

      • getImageWidth

        public Float getImageWidth()
        Get 输入画面在输出时的宽度。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为输入流的宽度。 使用百分比时，期望输出为（百分比 * 背景宽）。
        Returns:
        ImageWidth 输入画面在输出时的宽度。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为输入流的宽度。 使用百分比时，期望输出为（百分比 * 背景宽）。

      • setImageWidth

        public void setImageWidth​(Float ImageWidth)
        Set 输入画面在输出时的宽度。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为输入流的宽度。 使用百分比时，期望输出为（百分比 * 背景宽）。
        Parameters:
        ImageWidth - 输入画面在输出时的宽度。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为输入流的宽度。 使用百分比时，期望输出为（百分比 * 背景宽）。

      • getLocationX

        public Float getLocationX()
        Get 输入在输出画面的X偏移。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为0。 相对于大主播背景画面左上角的横向偏移。 使用百分比时，期望输出为（百分比 * 背景宽）。
        Returns:
        LocationX 输入在输出画面的X偏移。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为0。 相对于大主播背景画面左上角的横向偏移。 使用百分比时，期望输出为（百分比 * 背景宽）。

      • setLocationX

        public void setLocationX​(Float LocationX)
        Set 输入在输出画面的X偏移。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为0。 相对于大主播背景画面左上角的横向偏移。 使用百分比时，期望输出为（百分比 * 背景宽）。
        Parameters:
        LocationX - 输入在输出画面的X偏移。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为0。 相对于大主播背景画面左上角的横向偏移。 使用百分比时，期望输出为（百分比 * 背景宽）。

      • getLocationY

        public Float getLocationY()
        Get 输入在输出画面的Y偏移。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为0。 相对于大主播背景画面左上角的纵向偏移。 使用百分比时，期望输出为（百分比 * 背景宽）
        Returns:
        LocationY 输入在输出画面的Y偏移。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为0。 相对于大主播背景画面左上角的纵向偏移。 使用百分比时，期望输出为（百分比 * 背景宽）

      • setLocationY

        public void setLocationY​(Float LocationY)
        Set 输入在输出画面的Y偏移。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为0。 相对于大主播背景画面左上角的纵向偏移。 使用百分比时，期望输出为（百分比 * 背景宽）
        Parameters:
        LocationY - 输入在输出画面的Y偏移。取值范围： 像素：[0，2000] 百分比：[0.01，0.99] 不填默认为0。 相对于大主播背景画面左上角的纵向偏移。 使用百分比时，期望输出为（百分比 * 背景宽）

      • getColor

        public String getColor()
        Get 当InputType为3(画布)时，该值表示画布的颜色。 常用的颜色有： 红色：0xCC0033。 黄色：0xCC9900。 绿色：0xCCCC33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。
        Returns:
        Color 当InputType为3(画布)时，该值表示画布的颜色。 常用的颜色有： 红色：0xCC0033。 黄色：0xCC9900。 绿色：0xCCCC33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。

      • setColor

        public void setColor​(String Color)
        Set 当InputType为3(画布)时，该值表示画布的颜色。 常用的颜色有： 红色：0xCC0033。 黄色：0xCC9900。 绿色：0xCCCC33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。
        Parameters:
        Color - 当InputType为3(画布)时，该值表示画布的颜色。 常用的颜色有： 红色：0xCC0033。 黄色：0xCC9900。 绿色：0xCCCC33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。

      • getWatermarkId

        public Long getWatermarkId()
        Get 当InputType为2(图片)时，该值是水印ID。
        Returns:
        WatermarkId 当InputType为2(图片)时，该值是水印ID。

      • setWatermarkId

        public void setWatermarkId​(Long WatermarkId)
        Set 当InputType为2(图片)时，该值是水印ID。
        Parameters:
        WatermarkId - 当InputType为2(图片)时，该值是水印ID。