MixParam (Huawei Cloud SDK for CLOUDRTC 3.0.72 API)

java.lang.Object
- com.huaweicloud.sdk.cloudrtc.v2.model.MixParam

```
public class MixParam
extends Object
```
合流参数 - 纯音频录制 encode_template 填 audio_only，音频合流会动态选择最大三方的声音。 layout_template、layout_panes 以及其他视频相关参数都不填，填就忽略。 - 音视频录制（包括共享桌面） encode_template 非 audio_only，layout_template必须非空。音频合流会动态选择最大三方的声音

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MixParam.EncodeTemplateEnum` 输出编码模板名称 - 1920x1080_30_4620：输出流是1080p，帧率30，码率4.62Mbps - 1920x1080_15_3460：输出流是1080p，帧率15，码率3.46Mbps - 1280x720_30_3420：输出流是720p，帧率30，码率3.42Mbps - 1280x720_15_2260：输出流是720p，帧率15，码率2.26Mbps

Constructor Summary

Constructors
Constructor and Description

MixParam()

Constructors
Constructor and Description
`MixParam()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MixParam`	`addLayoutPanesItem(MixLayoutPane layoutPanesItem)`
`MixParam`	`addUserBackgroundImagesItem(MixUserBackgroundImage userBackgroundImagesItem)`
`boolean`	`equals(Object o)`
`String`	`getBackgroundImage()` 画布背景图地址，图片先上传obs，格式s3://bucket/object。默认使用等比缩放裁剪，保证铺满。
`String`	`getDefaultUserBackgroundImage()` 默认用户背景图地址，图片先上传obs，格式s3://bucket/object。默认使用等比缩放裁剪，保证铺满。
`MixParam.EncodeTemplateEnum`	`getEncodeTemplate()` 输出编码模板名称 - 1920x1080_30_4620：输出流是1080p，帧率30，码率4.62Mbps - 1920x1080_15_3460：输出流是1080p，帧率15，码率3.46Mbps - 1280x720_30_3420：输出流是720p，帧率30，码率3.42Mbps - 1280x720_15_2260：输出流是720p，帧率15，码率2.26Mbps
`List<MixLayoutPane>`	`getLayoutPanes()` 需要混流的视频列表。若不需要混流视频，则可不传递该参数。 nine_grids_view模板不需要填写本字段。
`String`	`getLayoutTemplate()` 视频布局模板编号，不混视频的时候，不需要带。 - nine_grids_view：九宫格模板（自适应模板） - screen_share_left：主视图在左边的屏幕共享模板（自适应模板） - screen_share_right：主视图在右边的屏幕共享模板（自适应模板） - custom：自定义布局
`Integer`	`getMaxIdleTime()` 最长空闲频道时间。取值范围：[5，43200]，默认值为30。单位：秒。如果频道内无连麦方的状态持续超过该时间，录制程序会自动退出。退出后，再次调用start请求，会产生新的录制任务。连麦方指：joiner或者publisher的用户。 minimum: 5 maximum: 43200
`String`	`getRoomId()` 房间id
`String`	`getScreenBackgroundImage()` 共享屏幕的背景图地址，图片先上传obs，格式s3://bucket/object。在一大多小的布局场景下，无论大窗是显示非指定用户（屏幕共享人的桌面）还是指定用户的共享桌面，都通过该字段指定背景图。
`List<MixUserBackgroundImage>`	`getUserBackgroundImages()` 指定用户背景图，优先级大于default_user_background_image
`int`	`hashCode()`
`void`	`setBackgroundImage(String backgroundImage)`
`void`	`setDefaultUserBackgroundImage(String defaultUserBackgroundImage)`
`void`	`setEncodeTemplate(MixParam.EncodeTemplateEnum encodeTemplate)`
`void`	`setLayoutPanes(List<MixLayoutPane> layoutPanes)`
`void`	`setLayoutTemplate(String layoutTemplate)`
`void`	`setMaxIdleTime(Integer maxIdleTime)`
`void`	`setRoomId(String roomId)`
`void`	`setScreenBackgroundImage(String screenBackgroundImage)`
`void`	`setUserBackgroundImages(List<MixUserBackgroundImage> userBackgroundImages)`
`String`	`toString()`
`MixParam`	`withBackgroundImage(String backgroundImage)`
`MixParam`	`withDefaultUserBackgroundImage(String defaultUserBackgroundImage)`
`MixParam`	`withEncodeTemplate(MixParam.EncodeTemplateEnum encodeTemplate)`
`MixParam`	`withLayoutPanes(java.util.function.Consumer<List<MixLayoutPane>> layoutPanesSetter)`
`MixParam`	`withLayoutPanes(List<MixLayoutPane> layoutPanes)`
`MixParam`	`withLayoutTemplate(String layoutTemplate)`
`MixParam`	`withMaxIdleTime(Integer maxIdleTime)`
`MixParam`	`withRoomId(String roomId)`
`MixParam`	`withScreenBackgroundImage(String screenBackgroundImage)`
`MixParam`	`withUserBackgroundImages(java.util.function.Consumer<List<MixUserBackgroundImage>> userBackgroundImagesSetter)`
`MixParam`	`withUserBackgroundImages(List<MixUserBackgroundImage> userBackgroundImages)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MixParam
```
public MixParam()
```
- Method Detail
  - withRoomId
```
public MixParam withRoomId(String roomId)
```
  - getRoomId
```
public String getRoomId()
```
    房间id
    
    Returns:
    
    roomId
  - setRoomId
```
public void setRoomId(String roomId)
```
  - withEncodeTemplate
```
public MixParam withEncodeTemplate(MixParam.EncodeTemplateEnum encodeTemplate)
```
  - getEncodeTemplate
```
public MixParam.EncodeTemplateEnum getEncodeTemplate()
```
    输出编码模板名称 - 1920x1080_30_4620：输出流是1080p，帧率30，码率4.62Mbps - 1920x1080_15_3460：输出流是1080p，帧率15，码率3.46Mbps - 1280x720_30_3420：输出流是720p，帧率30，码率3.42Mbps - 1280x720_15_2260：输出流是720p，帧率15，码率2.26Mbps
    
    Returns:
    
    encodeTemplate
  - setEncodeTemplate
```
public void setEncodeTemplate(MixParam.EncodeTemplateEnum encodeTemplate)
```
  - withMaxIdleTime
```
public MixParam withMaxIdleTime(Integer maxIdleTime)
```
  - getMaxIdleTime
```
public Integer getMaxIdleTime()
```
    最长空闲频道时间。取值范围：[5，43200]，默认值为30。单位：秒。如果频道内无连麦方的状态持续超过该时间，录制程序会自动退出。退出后，再次调用start请求，会产生新的录制任务。连麦方指：joiner或者publisher的用户。 minimum: 5 maximum: 43200
    
    Returns:
    
    maxIdleTime
  - setMaxIdleTime
```
public void setMaxIdleTime(Integer maxIdleTime)
```
  - withLayoutTemplate
```
public MixParam withLayoutTemplate(String layoutTemplate)
```
  - getLayoutTemplate
```
public String getLayoutTemplate()
```
    视频布局模板编号，不混视频的时候，不需要带。 - nine_grids_view：九宫格模板（自适应模板） - screen_share_left：主视图在左边的屏幕共享模板（自适应模板） - screen_share_right：主视图在右边的屏幕共享模板（自适应模板） - custom：自定义布局
    
    Returns:
    
    layoutTemplate
  - setLayoutTemplate
```
public void setLayoutTemplate(String layoutTemplate)
```
  - withDefaultUserBackgroundImage
```
public MixParam withDefaultUserBackgroundImage(String defaultUserBackgroundImage)
```
  - getDefaultUserBackgroundImage
```
public String getDefaultUserBackgroundImage()
```
    默认用户背景图地址，图片先上传obs，格式s3://bucket/object。默认使用等比缩放裁剪，保证铺满。
    
    Returns:
    
    defaultUserBackgroundImage
  - setDefaultUserBackgroundImage
```
public void setDefaultUserBackgroundImage(String defaultUserBackgroundImage)
```
  - withScreenBackgroundImage
```
public MixParam withScreenBackgroundImage(String screenBackgroundImage)
```
  - getScreenBackgroundImage
```
public String getScreenBackgroundImage()
```
    共享屏幕的背景图地址，图片先上传obs，格式s3://bucket/object。在一大多小的布局场景下，无论大窗是显示非指定用户（屏幕共享人的桌面）还是指定用户的共享桌面，都通过该字段指定背景图。
    
    Returns:
    
    screenBackgroundImage
  - setScreenBackgroundImage
```
public void setScreenBackgroundImage(String screenBackgroundImage)
```
  - withBackgroundImage
```
public MixParam withBackgroundImage(String backgroundImage)
```
  - getBackgroundImage
```
public String getBackgroundImage()
```
    画布背景图地址，图片先上传obs，格式s3://bucket/object。默认使用等比缩放裁剪，保证铺满。
    
    Returns:
    
    backgroundImage
  - setBackgroundImage
```
public void setBackgroundImage(String backgroundImage)
```
  - withLayoutPanes
```
public MixParam withLayoutPanes(List<MixLayoutPane> layoutPanes)
```
  - addLayoutPanesItem
```
public MixParam addLayoutPanesItem(MixLayoutPane layoutPanesItem)
```
  - withLayoutPanes
```
public MixParam withLayoutPanes(java.util.function.Consumer<List<MixLayoutPane>> layoutPanesSetter)
```
  - getLayoutPanes
```
public List<MixLayoutPane> getLayoutPanes()
```
    需要混流的视频列表。若不需要混流视频，则可不传递该参数。 nine_grids_view模板不需要填写本字段。
    
    Returns:
    
    layoutPanes
  - setLayoutPanes
```
public void setLayoutPanes(List<MixLayoutPane> layoutPanes)
```
  - withUserBackgroundImages
```
public MixParam withUserBackgroundImages(List<MixUserBackgroundImage> userBackgroundImages)
```
  - addUserBackgroundImagesItem
```
public MixParam addUserBackgroundImagesItem(MixUserBackgroundImage userBackgroundImagesItem)
```
  - withUserBackgroundImages
```
public MixParam withUserBackgroundImages(java.util.function.Consumer<List<MixUserBackgroundImage>> userBackgroundImagesSetter)
```
  - getUserBackgroundImages
```
public List<MixUserBackgroundImage> getUserBackgroundImages()
```
    指定用户背景图，优先级大于default_user_background_image
    
    Returns:
    
    userBackgroundImages
  - setUserBackgroundImages
```
public void setUserBackgroundImages(List<MixUserBackgroundImage> userBackgroundImages)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MixParam

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MixParam

Method Detail

withRoomId

getRoomId

setRoomId

withEncodeTemplate

getEncodeTemplate

setEncodeTemplate

withMaxIdleTime

getMaxIdleTime

setMaxIdleTime

withLayoutTemplate

getLayoutTemplate

setLayoutTemplate

withDefaultUserBackgroundImage

getDefaultUserBackgroundImage

setDefaultUserBackgroundImage

withScreenBackgroundImage

getScreenBackgroundImage

setScreenBackgroundImage

withBackgroundImage

getBackgroundImage

setBackgroundImage

withLayoutPanes

addLayoutPanesItem

withLayoutPanes

getLayoutPanes

setLayoutPanes

withUserBackgroundImages

addUserBackgroundImagesItem

withUserBackgroundImages

getUserBackgroundImages

setUserBackgroundImages

equals

hashCode

toString