Package com.tencentcloudapi.trtc.v20190722.models

Class MixLayoutParams

    • Constructor Summary

      Constructors 
      Constructor Description
      MixLayoutParams()  
      MixLayoutParams​(MixLayoutParams 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
      String getBackGroundColor()
      Get 录制背景颜色，RGB的颜色表的16进制表示，每个颜色通过8bit长度标识，默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500，格式规范：‘#‘开头，后面跟固定RGB的颜色值
      Long getBackgroundImageRenderMode()
      Get 背景画面宽高比不一致的时候处理方案，与MixLayoufList定义的RenderMode一致。
      String getBackgroundImageUrl()
      Get 图片的url地址， 只支持jpg， png，大小限制不超过5M，url不可包含中文。
      String getDefaultSubBackgroundImage()
      Get 子画面占位图url地址， 只支持jpg， png，大小限制不超过5M，宽高比不一致的处理方案同 RenderMode。
      Long getMaxResolutionUserAlign()
      Get 屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。
      String getMaxResolutionUserId()
      Get 在布局模式为1：悬浮布局和 2：屏幕分享布局时，设定为显示大视频画面的UserId。不填的话：悬浮布局默认是第一个进房间的主播，屏幕分享布局默认是背景色
      Long getMediaId()
      Get 主辅路标识， 0：主流（默认）； 1：辅流（屏幕分享）； 这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路，MixLayoutList内代表的是自定义用户的主辅路。
      MixLayout[] getMixLayoutList()
      Get 如果MixLayoutMode 选择为4自定义布局模式的话，设置此参数为每个主播所对应的布局画面的详细信息，最大不超过25个。
      Long getMixLayoutMode()
      Get 布局模式: 1：悬浮布局； 2：屏幕分享布局； 3：九宫格布局（默认）； 4：自定义布局； 悬浮布局：默认第一个进入房间的主播（也可以指定一个主播）的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列，显示为小画面，小画面悬浮于大画面之上。当画面数量小于等于17个时，每行4个（4 x 4排列）。当画面数量大于17个时，重新布局小画面为每行5个（5 x 5）排列。最多支持25个画面，如果用户只发送音频，仍然会占用画面位置。 屏幕分享布局：指定一个主播在屏幕左侧的大画面位置（如果不指定，那么大画面位置为背景色），其他主播自上而下依次垂直排列于右侧。当画面数量少于17个的时候，右侧每列最多8人，最多占据两列。当画面数量多于17个的时候，超过17个画面的主播从左下角开始依次水平排列。最多支持25个画面，如果主播只发送音频，仍然会占用画面位置。 九宫格布局：根据主播的数量自动调整每个画面的大小，每个主播的画面大小一致，最多支持25个画面。 自定义布局：根据需要在MixLayoutList内定制每个主播画面的布局。
      Long getPlaceHolderMode()
      Get 设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。
      Long getRenderMode()
      Get 模板布局下，背景画面宽高比不一致的时候处理方案。自定义布局不生效，与MixLayoufList定义的RenderMode一致。
      WaterMark[] getWaterMarkList()
      Get 水印布局参数， 最多支持25个。
      void setBackGroundColor​(String BackGroundColor)
      Set 录制背景颜色，RGB的颜色表的16进制表示，每个颜色通过8bit长度标识，默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500，格式规范：‘#‘开头，后面跟固定RGB的颜色值
      void setBackgroundImageRenderMode​(Long BackgroundImageRenderMode)
      Set 背景画面宽高比不一致的时候处理方案，与MixLayoufList定义的RenderMode一致。
      void setBackgroundImageUrl​(String BackgroundImageUrl)
      Set 图片的url地址， 只支持jpg， png，大小限制不超过5M，url不可包含中文。
      void setDefaultSubBackgroundImage​(String DefaultSubBackgroundImage)
      Set 子画面占位图url地址， 只支持jpg， png，大小限制不超过5M，宽高比不一致的处理方案同 RenderMode。
      void setMaxResolutionUserAlign​(Long MaxResolutionUserAlign)
      Set 屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。
      void setMaxResolutionUserId​(String MaxResolutionUserId)
      Set 在布局模式为1：悬浮布局和 2：屏幕分享布局时，设定为显示大视频画面的UserId。不填的话：悬浮布局默认是第一个进房间的主播，屏幕分享布局默认是背景色
      void setMediaId​(Long MediaId)
      Set 主辅路标识， 0：主流（默认）； 1：辅流（屏幕分享）； 这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路，MixLayoutList内代表的是自定义用户的主辅路。
      void setMixLayoutList​(MixLayout[] MixLayoutList)
      Set 如果MixLayoutMode 选择为4自定义布局模式的话，设置此参数为每个主播所对应的布局画面的详细信息，最大不超过25个。
      void setMixLayoutMode​(Long MixLayoutMode)
      Set 布局模式: 1：悬浮布局； 2：屏幕分享布局； 3：九宫格布局（默认）； 4：自定义布局； 悬浮布局：默认第一个进入房间的主播（也可以指定一个主播）的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列，显示为小画面，小画面悬浮于大画面之上。当画面数量小于等于17个时，每行4个（4 x 4排列）。当画面数量大于17个时，重新布局小画面为每行5个（5 x 5）排列。最多支持25个画面，如果用户只发送音频，仍然会占用画面位置。 屏幕分享布局：指定一个主播在屏幕左侧的大画面位置（如果不指定，那么大画面位置为背景色），其他主播自上而下依次垂直排列于右侧。当画面数量少于17个的时候，右侧每列最多8人，最多占据两列。当画面数量多于17个的时候，超过17个画面的主播从左下角开始依次水平排列。最多支持25个画面，如果主播只发送音频，仍然会占用画面位置。 九宫格布局：根据主播的数量自动调整每个画面的大小，每个主播的画面大小一致，最多支持25个画面。 自定义布局：根据需要在MixLayoutList内定制每个主播画面的布局。
      void setPlaceHolderMode​(Long PlaceHolderMode)
      Set 设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。
      void setRenderMode​(Long RenderMode)
      Set 模板布局下，背景画面宽高比不一致的时候处理方案。自定义布局不生效，与MixLayoufList定义的RenderMode一致。
      void setWaterMarkList​(WaterMark[] WaterMarkList)
      Set 水印布局参数， 最多支持25个。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • MixLayoutParams

        public MixLayoutParams()

      • MixLayoutParams

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

      • getMixLayoutMode

        public Long getMixLayoutMode()
        Get 布局模式: 1：悬浮布局； 2：屏幕分享布局； 3：九宫格布局（默认）； 4：自定义布局； 悬浮布局：默认第一个进入房间的主播（也可以指定一个主播）的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列，显示为小画面，小画面悬浮于大画面之上。当画面数量小于等于17个时，每行4个（4 x 4排列）。当画面数量大于17个时，重新布局小画面为每行5个（5 x 5）排列。最多支持25个画面，如果用户只发送音频，仍然会占用画面位置。 屏幕分享布局：指定一个主播在屏幕左侧的大画面位置（如果不指定，那么大画面位置为背景色），其他主播自上而下依次垂直排列于右侧。当画面数量少于17个的时候，右侧每列最多8人，最多占据两列。当画面数量多于17个的时候，超过17个画面的主播从左下角开始依次水平排列。最多支持25个画面，如果主播只发送音频，仍然会占用画面位置。 九宫格布局：根据主播的数量自动调整每个画面的大小，每个主播的画面大小一致，最多支持25个画面。 自定义布局：根据需要在MixLayoutList内定制每个主播画面的布局。
        Returns:
        MixLayoutMode 布局模式: 1：悬浮布局； 2：屏幕分享布局； 3：九宫格布局（默认）； 4：自定义布局； 悬浮布局：默认第一个进入房间的主播（也可以指定一个主播）的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列，显示为小画面，小画面悬浮于大画面之上。当画面数量小于等于17个时，每行4个（4 x 4排列）。当画面数量大于17个时，重新布局小画面为每行5个（5 x 5）排列。最多支持25个画面，如果用户只发送音频，仍然会占用画面位置。 屏幕分享布局：指定一个主播在屏幕左侧的大画面位置（如果不指定，那么大画面位置为背景色），其他主播自上而下依次垂直排列于右侧。当画面数量少于17个的时候，右侧每列最多8人，最多占据两列。当画面数量多于17个的时候，超过17个画面的主播从左下角开始依次水平排列。最多支持25个画面，如果主播只发送音频，仍然会占用画面位置。 九宫格布局：根据主播的数量自动调整每个画面的大小，每个主播的画面大小一致，最多支持25个画面。 自定义布局：根据需要在MixLayoutList内定制每个主播画面的布局。

      • setMixLayoutMode

        public void setMixLayoutMode​(Long MixLayoutMode)
        Set 布局模式: 1：悬浮布局； 2：屏幕分享布局； 3：九宫格布局（默认）； 4：自定义布局； 悬浮布局：默认第一个进入房间的主播（也可以指定一个主播）的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列，显示为小画面，小画面悬浮于大画面之上。当画面数量小于等于17个时，每行4个（4 x 4排列）。当画面数量大于17个时，重新布局小画面为每行5个（5 x 5）排列。最多支持25个画面，如果用户只发送音频，仍然会占用画面位置。 屏幕分享布局：指定一个主播在屏幕左侧的大画面位置（如果不指定，那么大画面位置为背景色），其他主播自上而下依次垂直排列于右侧。当画面数量少于17个的时候，右侧每列最多8人，最多占据两列。当画面数量多于17个的时候，超过17个画面的主播从左下角开始依次水平排列。最多支持25个画面，如果主播只发送音频，仍然会占用画面位置。 九宫格布局：根据主播的数量自动调整每个画面的大小，每个主播的画面大小一致，最多支持25个画面。 自定义布局：根据需要在MixLayoutList内定制每个主播画面的布局。
        Parameters:
        MixLayoutMode - 布局模式: 1：悬浮布局； 2：屏幕分享布局； 3：九宫格布局（默认）； 4：自定义布局； 悬浮布局：默认第一个进入房间的主播（也可以指定一个主播）的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列，显示为小画面，小画面悬浮于大画面之上。当画面数量小于等于17个时，每行4个（4 x 4排列）。当画面数量大于17个时，重新布局小画面为每行5个（5 x 5）排列。最多支持25个画面，如果用户只发送音频，仍然会占用画面位置。 屏幕分享布局：指定一个主播在屏幕左侧的大画面位置（如果不指定，那么大画面位置为背景色），其他主播自上而下依次垂直排列于右侧。当画面数量少于17个的时候，右侧每列最多8人，最多占据两列。当画面数量多于17个的时候，超过17个画面的主播从左下角开始依次水平排列。最多支持25个画面，如果主播只发送音频，仍然会占用画面位置。 九宫格布局：根据主播的数量自动调整每个画面的大小，每个主播的画面大小一致，最多支持25个画面。 自定义布局：根据需要在MixLayoutList内定制每个主播画面的布局。

      • getMixLayoutList

        public MixLayout[] getMixLayoutList()
        Get 如果MixLayoutMode 选择为4自定义布局模式的话，设置此参数为每个主播所对应的布局画面的详细信息，最大不超过25个。
        Returns:
        MixLayoutList 如果MixLayoutMode 选择为4自定义布局模式的话，设置此参数为每个主播所对应的布局画面的详细信息，最大不超过25个。

      • setMixLayoutList

        public void setMixLayoutList​(MixLayout[] MixLayoutList)
        Set 如果MixLayoutMode 选择为4自定义布局模式的话，设置此参数为每个主播所对应的布局画面的详细信息，最大不超过25个。
        Parameters:
        MixLayoutList - 如果MixLayoutMode 选择为4自定义布局模式的话，设置此参数为每个主播所对应的布局画面的详细信息，最大不超过25个。

      • getBackGroundColor

        public String getBackGroundColor()
        Get 录制背景颜色，RGB的颜色表的16进制表示，每个颜色通过8bit长度标识，默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500，格式规范：‘#‘开头，后面跟固定RGB的颜色值
        Returns:
        BackGroundColor 录制背景颜色，RGB的颜色表的16进制表示，每个颜色通过8bit长度标识，默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500，格式规范：‘#‘开头，后面跟固定RGB的颜色值

      • setBackGroundColor

        public void setBackGroundColor​(String BackGroundColor)
        Set 录制背景颜色，RGB的颜色表的16进制表示，每个颜色通过8bit长度标识，默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500，格式规范：‘#‘开头，后面跟固定RGB的颜色值
        Parameters:
        BackGroundColor - 录制背景颜色，RGB的颜色表的16进制表示，每个颜色通过8bit长度标识，默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500，格式规范：‘#‘开头，后面跟固定RGB的颜色值

      • getMaxResolutionUserId

        public String getMaxResolutionUserId()
        Get 在布局模式为1：悬浮布局和 2：屏幕分享布局时，设定为显示大视频画面的UserId。不填的话：悬浮布局默认是第一个进房间的主播，屏幕分享布局默认是背景色
        Returns:
        MaxResolutionUserId 在布局模式为1：悬浮布局和 2：屏幕分享布局时，设定为显示大视频画面的UserId。不填的话：悬浮布局默认是第一个进房间的主播，屏幕分享布局默认是背景色

      • setMaxResolutionUserId

        public void setMaxResolutionUserId​(String MaxResolutionUserId)
        Set 在布局模式为1：悬浮布局和 2：屏幕分享布局时，设定为显示大视频画面的UserId。不填的话：悬浮布局默认是第一个进房间的主播，屏幕分享布局默认是背景色
        Parameters:
        MaxResolutionUserId - 在布局模式为1：悬浮布局和 2：屏幕分享布局时，设定为显示大视频画面的UserId。不填的话：悬浮布局默认是第一个进房间的主播，屏幕分享布局默认是背景色

      • getMediaId

        public Long getMediaId()
        Get 主辅路标识， 0：主流（默认）； 1：辅流（屏幕分享）； 这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路，MixLayoutList内代表的是自定义用户的主辅路。
        Returns:
        MediaId 主辅路标识， 0：主流（默认）； 1：辅流（屏幕分享）； 这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路，MixLayoutList内代表的是自定义用户的主辅路。

      • setMediaId

        public void setMediaId​(Long MediaId)
        Set 主辅路标识， 0：主流（默认）； 1：辅流（屏幕分享）； 这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路，MixLayoutList内代表的是自定义用户的主辅路。
        Parameters:
        MediaId - 主辅路标识， 0：主流（默认）； 1：辅流（屏幕分享）； 这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路，MixLayoutList内代表的是自定义用户的主辅路。

      • getBackgroundImageUrl

        public String getBackgroundImageUrl()
        Get 图片的url地址， 只支持jpg， png，大小限制不超过5M，url不可包含中文。
        Returns:
        BackgroundImageUrl 图片的url地址， 只支持jpg， png，大小限制不超过5M，url不可包含中文。

      • setBackgroundImageUrl

        public void setBackgroundImageUrl​(String BackgroundImageUrl)
        Set 图片的url地址， 只支持jpg， png，大小限制不超过5M，url不可包含中文。
        Parameters:
        BackgroundImageUrl - 图片的url地址， 只支持jpg， png，大小限制不超过5M，url不可包含中文。

      • getPlaceHolderMode

        public Long getPlaceHolderMode()
        Get 设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。
        Returns:
        PlaceHolderMode 设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。

      • setPlaceHolderMode

        public void setPlaceHolderMode​(Long PlaceHolderMode)
        Set 设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。
        Parameters:
        PlaceHolderMode - 设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。

      • getBackgroundImageRenderMode

        public Long getBackgroundImageRenderMode()
        Get 背景画面宽高比不一致的时候处理方案，与MixLayoufList定义的RenderMode一致。
        Returns:
        BackgroundImageRenderMode 背景画面宽高比不一致的时候处理方案，与MixLayoufList定义的RenderMode一致。

      • setBackgroundImageRenderMode

        public void setBackgroundImageRenderMode​(Long BackgroundImageRenderMode)
        Set 背景画面宽高比不一致的时候处理方案，与MixLayoufList定义的RenderMode一致。
        Parameters:
        BackgroundImageRenderMode - 背景画面宽高比不一致的时候处理方案，与MixLayoufList定义的RenderMode一致。

      • getDefaultSubBackgroundImage

        public String getDefaultSubBackgroundImage()
        Get 子画面占位图url地址， 只支持jpg， png，大小限制不超过5M，宽高比不一致的处理方案同 RenderMode。
        Returns:
        DefaultSubBackgroundImage 子画面占位图url地址， 只支持jpg， png，大小限制不超过5M，宽高比不一致的处理方案同 RenderMode。

      • setDefaultSubBackgroundImage

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

      • getWaterMarkList

        public WaterMark[] getWaterMarkList()
        Get 水印布局参数， 最多支持25个。
        Returns:
        WaterMarkList 水印布局参数， 最多支持25个。

      • setWaterMarkList

        public void setWaterMarkList​(WaterMark[] WaterMarkList)
        Set 水印布局参数， 最多支持25个。
        Parameters:
        WaterMarkList - 水印布局参数， 最多支持25个。

      • getRenderMode

        public Long getRenderMode()
        Get 模板布局下，背景画面宽高比不一致的时候处理方案。自定义布局不生效，与MixLayoufList定义的RenderMode一致。
        Returns:
        RenderMode 模板布局下，背景画面宽高比不一致的时候处理方案。自定义布局不生效，与MixLayoufList定义的RenderMode一致。

      • setRenderMode

        public void setRenderMode​(Long RenderMode)
        Set 模板布局下，背景画面宽高比不一致的时候处理方案。自定义布局不生效，与MixLayoufList定义的RenderMode一致。
        Parameters:
        RenderMode - 模板布局下，背景画面宽高比不一致的时候处理方案。自定义布局不生效，与MixLayoufList定义的RenderMode一致。

      • getMaxResolutionUserAlign

        public Long getMaxResolutionUserAlign()
        Get 屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。
        Returns:
        MaxResolutionUserAlign 屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。

      • setMaxResolutionUserAlign

        public void setMaxResolutionUserAlign​(Long MaxResolutionUserAlign)
        Set 屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。
        Parameters:
        MaxResolutionUserAlign - 屏幕分享模板有效。设置为1时代表大画面居右，小画面居左布局。默认为0。