Package com.tencentcloudapi.trtc.v20190722.models

Class MixLayout

    • Constructor Summary

      Constructors 
      Constructor Description
      MixLayout()  
      MixLayout​(MixLayout 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 getAlpha()
      Get 画布的透明度值，取值范围[0, 255]。0表示不透明，255表示全透明。默认值为0。
      Long getHeight()
      Get 画布上该画面高度的相对值，取值范围 [0, 1920]，与Top相加不应超过画布的高。
      Long getImageLayer()
      Get 该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。
      Long getLeft()
      Get 画布上该画面左上角的 x 轴坐标，取值范围 [0, 1920]，不能超过画布的宽。
      Long getMediaId()
      Get 对应订阅流的主辅路标识： 0：主流（默认）； 1：辅流；
      Long getRenderMode()
      Get 0 ：拉伸模式，这个模式下整个视频内容会全部显示，并填满子画面，在源视频和目的视频宽高比不一致的时候，画面不会缺少内容，但是画面可能产生形变； 1 ：剪裁模式（默认），这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸，并填满子画面画布，在源视频和目的视频宽高比不一致的时候，画面保持不变形，但是会被剪裁； 2 ：填黑模式，这个模式下会严格保持源视频的宽高比进行等比缩放，在源视频和目的视频宽高比不一致的时候，画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景； 3 ：智能拉伸模式，这个模式类似剪裁模式，区别是在源视频和目的视频宽高比不一致的时候，限制了最大剪裁比例为画面的宽度或者高度的20%；
      String getSubBackgroundImage()
      Get 图片的url地址， 只支持jpg， png，大小限制不超过5M，宽高比不一致的处理方案同 RenderMode。
      Long getTop()
      Get 画布上该画面左上角的 y 轴坐标，取值范围 [0, 1920]，不能超过画布的高。
      String getUserId()
      Get 字符串内容为待显示在该画面的主播对应的UserId，如果不指定，会按照主播加入房间的顺序匹配。
      Long getWidth()
      Get 画布上该画面宽度的相对值，取值范围 [0, 1920]，与Left相加不应超过画布的宽。
      void setAlpha​(Long Alpha)
      Set 画布的透明度值，取值范围[0, 255]。0表示不透明，255表示全透明。默认值为0。
      void setHeight​(Long Height)
      Set 画布上该画面高度的相对值，取值范围 [0, 1920]，与Top相加不应超过画布的高。
      void setImageLayer​(Long ImageLayer)
      Set 该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。
      void setLeft​(Long Left)
      Set 画布上该画面左上角的 x 轴坐标，取值范围 [0, 1920]，不能超过画布的宽。
      void setMediaId​(Long MediaId)
      Set 对应订阅流的主辅路标识： 0：主流（默认）； 1：辅流；
      void setRenderMode​(Long RenderMode)
      Set 0 ：拉伸模式，这个模式下整个视频内容会全部显示，并填满子画面，在源视频和目的视频宽高比不一致的时候，画面不会缺少内容，但是画面可能产生形变； 1 ：剪裁模式（默认），这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸，并填满子画面画布，在源视频和目的视频宽高比不一致的时候，画面保持不变形，但是会被剪裁； 2 ：填黑模式，这个模式下会严格保持源视频的宽高比进行等比缩放，在源视频和目的视频宽高比不一致的时候，画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景； 3 ：智能拉伸模式，这个模式类似剪裁模式，区别是在源视频和目的视频宽高比不一致的时候，限制了最大剪裁比例为画面的宽度或者高度的20%；
      void setSubBackgroundImage​(String SubBackgroundImage)
      Set 图片的url地址， 只支持jpg， png，大小限制不超过5M，宽高比不一致的处理方案同 RenderMode。
      void setTop​(Long Top)
      Set 画布上该画面左上角的 y 轴坐标，取值范围 [0, 1920]，不能超过画布的高。
      void setUserId​(String UserId)
      Set 字符串内容为待显示在该画面的主播对应的UserId，如果不指定，会按照主播加入房间的顺序匹配。
      void setWidth​(Long Width)
      Set 画布上该画面宽度的相对值，取值范围 [0, 1920]，与Left相加不应超过画布的宽。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • MixLayout

        public MixLayout()

      • MixLayout

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

      • getTop

        public Long getTop()
        Get 画布上该画面左上角的 y 轴坐标，取值范围 [0, 1920]，不能超过画布的高。
        Returns:
        Top 画布上该画面左上角的 y 轴坐标，取值范围 [0, 1920]，不能超过画布的高。

      • setTop

        public void setTop​(Long Top)
        Set 画布上该画面左上角的 y 轴坐标，取值范围 [0, 1920]，不能超过画布的高。
        Parameters:
        Top - 画布上该画面左上角的 y 轴坐标，取值范围 [0, 1920]，不能超过画布的高。

      • getLeft

        public Long getLeft()
        Get 画布上该画面左上角的 x 轴坐标，取值范围 [0, 1920]，不能超过画布的宽。
        Returns:
        Left 画布上该画面左上角的 x 轴坐标，取值范围 [0, 1920]，不能超过画布的宽。

      • setLeft

        public void setLeft​(Long Left)
        Set 画布上该画面左上角的 x 轴坐标，取值范围 [0, 1920]，不能超过画布的宽。
        Parameters:
        Left - 画布上该画面左上角的 x 轴坐标，取值范围 [0, 1920]，不能超过画布的宽。

      • getWidth

        public Long getWidth()
        Get 画布上该画面宽度的相对值，取值范围 [0, 1920]，与Left相加不应超过画布的宽。
        Returns:
        Width 画布上该画面宽度的相对值，取值范围 [0, 1920]，与Left相加不应超过画布的宽。

      • setWidth

        public void setWidth​(Long Width)
        Set 画布上该画面宽度的相对值，取值范围 [0, 1920]，与Left相加不应超过画布的宽。
        Parameters:
        Width - 画布上该画面宽度的相对值，取值范围 [0, 1920]，与Left相加不应超过画布的宽。

      • getHeight

        public Long getHeight()
        Get 画布上该画面高度的相对值，取值范围 [0, 1920]，与Top相加不应超过画布的高。
        Returns:
        Height 画布上该画面高度的相对值，取值范围 [0, 1920]，与Top相加不应超过画布的高。

      • setHeight

        public void setHeight​(Long Height)
        Set 画布上该画面高度的相对值，取值范围 [0, 1920]，与Top相加不应超过画布的高。
        Parameters:
        Height - 画布上该画面高度的相对值，取值范围 [0, 1920]，与Top相加不应超过画布的高。

      • getUserId

        public String getUserId()
        Get 字符串内容为待显示在该画面的主播对应的UserId，如果不指定，会按照主播加入房间的顺序匹配。
        Returns:
        UserId 字符串内容为待显示在该画面的主播对应的UserId，如果不指定，会按照主播加入房间的顺序匹配。

      • setUserId

        public void setUserId​(String UserId)
        Set 字符串内容为待显示在该画面的主播对应的UserId，如果不指定，会按照主播加入房间的顺序匹配。
        Parameters:
        UserId - 字符串内容为待显示在该画面的主播对应的UserId，如果不指定，会按照主播加入房间的顺序匹配。

      • getAlpha

        public Long getAlpha()
        Get 画布的透明度值，取值范围[0, 255]。0表示不透明，255表示全透明。默认值为0。
        Returns:
        Alpha 画布的透明度值，取值范围[0, 255]。0表示不透明，255表示全透明。默认值为0。

      • setAlpha

        public void setAlpha​(Long Alpha)
        Set 画布的透明度值，取值范围[0, 255]。0表示不透明，255表示全透明。默认值为0。
        Parameters:
        Alpha - 画布的透明度值，取值范围[0, 255]。0表示不透明，255表示全透明。默认值为0。

      • getRenderMode

        public Long getRenderMode()
        Get 0 ：拉伸模式，这个模式下整个视频内容会全部显示，并填满子画面，在源视频和目的视频宽高比不一致的时候，画面不会缺少内容，但是画面可能产生形变； 1 ：剪裁模式（默认），这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸，并填满子画面画布，在源视频和目的视频宽高比不一致的时候，画面保持不变形，但是会被剪裁； 2 ：填黑模式，这个模式下会严格保持源视频的宽高比进行等比缩放，在源视频和目的视频宽高比不一致的时候，画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景； 3 ：智能拉伸模式，这个模式类似剪裁模式，区别是在源视频和目的视频宽高比不一致的时候，限制了最大剪裁比例为画面的宽度或者高度的20%；
        Returns:
        RenderMode 0 ：拉伸模式，这个模式下整个视频内容会全部显示，并填满子画面，在源视频和目的视频宽高比不一致的时候，画面不会缺少内容，但是画面可能产生形变； 1 ：剪裁模式（默认），这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸，并填满子画面画布，在源视频和目的视频宽高比不一致的时候，画面保持不变形，但是会被剪裁； 2 ：填黑模式，这个模式下会严格保持源视频的宽高比进行等比缩放，在源视频和目的视频宽高比不一致的时候，画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景； 3 ：智能拉伸模式，这个模式类似剪裁模式，区别是在源视频和目的视频宽高比不一致的时候，限制了最大剪裁比例为画面的宽度或者高度的20%；

      • setRenderMode

        public void setRenderMode​(Long RenderMode)
        Set 0 ：拉伸模式，这个模式下整个视频内容会全部显示，并填满子画面，在源视频和目的视频宽高比不一致的时候，画面不会缺少内容，但是画面可能产生形变； 1 ：剪裁模式（默认），这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸，并填满子画面画布，在源视频和目的视频宽高比不一致的时候，画面保持不变形，但是会被剪裁； 2 ：填黑模式，这个模式下会严格保持源视频的宽高比进行等比缩放，在源视频和目的视频宽高比不一致的时候，画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景； 3 ：智能拉伸模式，这个模式类似剪裁模式，区别是在源视频和目的视频宽高比不一致的时候，限制了最大剪裁比例为画面的宽度或者高度的20%；
        Parameters:
        RenderMode - 0 ：拉伸模式，这个模式下整个视频内容会全部显示，并填满子画面，在源视频和目的视频宽高比不一致的时候，画面不会缺少内容，但是画面可能产生形变； 1 ：剪裁模式（默认），这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸，并填满子画面画布，在源视频和目的视频宽高比不一致的时候，画面保持不变形，但是会被剪裁； 2 ：填黑模式，这个模式下会严格保持源视频的宽高比进行等比缩放，在源视频和目的视频宽高比不一致的时候，画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景； 3 ：智能拉伸模式，这个模式类似剪裁模式，区别是在源视频和目的视频宽高比不一致的时候，限制了最大剪裁比例为画面的宽度或者高度的20%；

      • getMediaId

        public Long getMediaId()
        Get 对应订阅流的主辅路标识： 0：主流（默认）； 1：辅流；
        Returns:
        MediaId 对应订阅流的主辅路标识： 0：主流（默认）； 1：辅流；

      • setMediaId

        public void setMediaId​(Long MediaId)
        Set 对应订阅流的主辅路标识： 0：主流（默认）； 1：辅流；
        Parameters:
        MediaId - 对应订阅流的主辅路标识： 0：主流（默认）； 1：辅流；

      • getImageLayer

        public Long getImageLayer()
        Get 该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。
        Returns:
        ImageLayer 该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。

      • setImageLayer

        public void setImageLayer​(Long ImageLayer)
        Set 该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。
        Parameters:
        ImageLayer - 该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。

      • getSubBackgroundImage

        public String getSubBackgroundImage()
        Get 图片的url地址， 只支持jpg， png，大小限制不超过5M，宽高比不一致的处理方案同 RenderMode。
        Returns:
        SubBackgroundImage 图片的url地址， 只支持jpg， png，大小限制不超过5M，宽高比不一致的处理方案同 RenderMode。

      • setSubBackgroundImage

        public void setSubBackgroundImage​(String SubBackgroundImage)
        Set 图片的url地址， 只支持jpg， png，大小限制不超过5M，宽高比不一致的处理方案同 RenderMode。
        Parameters:
        SubBackgroundImage - 图片的url地址， 只支持jpg， png，大小限制不超过5M，宽高比不一致的处理方案同 RenderMode。