com.huaweicloud.sdk.cloudrtc.v2.model

Class UpdateMixParam

java.lang.Object

com.huaweicloud.sdk.cloudrtc.v2.model.UpdateMixParam

public class UpdateMixParam
extends Object

可修改的合流参数

Constructor Summary

Constructors

Constructor and Description
UpdateMixParam()

Method Summary

Modifier and Type	Method and Description
UpdateMixParam	addLayoutPanesItem(MixLayoutPane layoutPanesItem)
UpdateMixParam	addUserBackgroundImagesItem(MixUserBackgroundImage userBackgroundImagesItem)
boolean	equals(Object o)
String	getBackgroundImage() 画布背景图地址，图片先上传obs。默认使用等比缩放裁剪，保证铺满。格式s3://bucket/object
String	getDefaultUserBackgroundImage() 默认用户背景图地址，图片先上传obs，格式s3://bucket/object。默认使用等比缩放裁剪，保证铺满。
List<MixLayoutPane>	getLayoutPanes() 需要混流的视频列表。若不需要视频混流，则可不传递该参数。
String	getLayoutTemplate() 视频布局模板编号，仅支持自定义模板之间的更新。
Integer	getMaxIdleTime() 最长空闲频道时间。 取值范围：[5，43200]，默认值为30。 单位：秒。 如果频道内无连麦方的状态持续超过该时间，录制程序会自动退出。退出后，再次调用start请求，会产生新的录制任务。 连麦方指：joiner或者publisher的用户。 minimum: 5 maximum: 43200
String	getScreenBackgroundImage() 共享屏幕的背景图地址，图片先上传obs，格式s3://bucket/object。 在一大多小的布局场景下，无论大窗是显示非指定用户（屏幕共享人的桌面）还是指定用户的共享桌面，都通过该字段指定背景图。
List<MixUserBackgroundImage>	getUserBackgroundImages() 指定用户背景图，优先级大于default_user_background_image
int	hashCode()
void	setBackgroundImage(String backgroundImage)
void	setDefaultUserBackgroundImage(String defaultUserBackgroundImage)
void	setLayoutPanes(List<MixLayoutPane> layoutPanes)
void	setLayoutTemplate(String layoutTemplate)
void	setMaxIdleTime(Integer maxIdleTime)
void	setScreenBackgroundImage(String screenBackgroundImage)
void	setUserBackgroundImages(List<MixUserBackgroundImage> userBackgroundImages)
String	toString()
UpdateMixParam	withBackgroundImage(String backgroundImage)
UpdateMixParam	withDefaultUserBackgroundImage(String defaultUserBackgroundImage)
UpdateMixParam	withLayoutPanes(java.util.function.Consumer<List<MixLayoutPane>> layoutPanesSetter)
UpdateMixParam	withLayoutPanes(List<MixLayoutPane> layoutPanes)
UpdateMixParam	withLayoutTemplate(String layoutTemplate)
UpdateMixParam	withMaxIdleTime(Integer maxIdleTime)
UpdateMixParam	withScreenBackgroundImage(String screenBackgroundImage)
UpdateMixParam	withUserBackgroundImages(java.util.function.Consumer<List<MixUserBackgroundImage>> userBackgroundImagesSetter)
UpdateMixParam	withUserBackgroundImages(List<MixUserBackgroundImage> userBackgroundImages)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateMixParam

public UpdateMixParam()

Method Detail

withLayoutTemplate

public UpdateMixParam withLayoutTemplate(String layoutTemplate)

getLayoutTemplate

public String getLayoutTemplate()

视频布局模板编号，仅支持自定义模板之间的更新。

Returns:

layoutTemplate

setLayoutTemplate

public void setLayoutTemplate(String layoutTemplate)

withBackgroundImage

public UpdateMixParam withBackgroundImage(String backgroundImage)

getBackgroundImage

public String getBackgroundImage()

画布背景图地址，图片先上传obs。默认使用等比缩放裁剪，保证铺满。格式s3://bucket/object

Returns:

backgroundImage

setBackgroundImage

public void setBackgroundImage(String backgroundImage)

withDefaultUserBackgroundImage

public UpdateMixParam withDefaultUserBackgroundImage(String defaultUserBackgroundImage)

getDefaultUserBackgroundImage

public String getDefaultUserBackgroundImage()

默认用户背景图地址，图片先上传obs，格式s3://bucket/object。默认使用等比缩放裁剪，保证铺满。

Returns:

defaultUserBackgroundImage

setDefaultUserBackgroundImage

public void setDefaultUserBackgroundImage(String defaultUserBackgroundImage)

withScreenBackgroundImage

public UpdateMixParam withScreenBackgroundImage(String screenBackgroundImage)

getScreenBackgroundImage

public String getScreenBackgroundImage()

共享屏幕的背景图地址，图片先上传obs，格式s3://bucket/object。 在一大多小的布局场景下，无论大窗是显示非指定用户（屏幕共享人的桌面）还是指定用户的共享桌面，都通过该字段指定背景图。

Returns:

screenBackgroundImage

setScreenBackgroundImage

public void setScreenBackgroundImage(String screenBackgroundImage)

withMaxIdleTime

public UpdateMixParam 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)

withLayoutPanes

public UpdateMixParam withLayoutPanes(List<MixLayoutPane> layoutPanes)

addLayoutPanesItem

public UpdateMixParam addLayoutPanesItem(MixLayoutPane layoutPanesItem)

withLayoutPanes

public UpdateMixParam withLayoutPanes(java.util.function.Consumer<List<MixLayoutPane>> layoutPanesSetter)

getLayoutPanes

public List<MixLayoutPane> getLayoutPanes()

需要混流的视频列表。若不需要视频混流，则可不传递该参数。

Returns:

layoutPanes

setLayoutPanes

public void setLayoutPanes(List<MixLayoutPane> layoutPanes)

withUserBackgroundImages

public UpdateMixParam withUserBackgroundImages(List<MixUserBackgroundImage> userBackgroundImages)

addUserBackgroundImagesItem

public UpdateMixParam addUserBackgroundImagesItem(MixUserBackgroundImage userBackgroundImagesItem)

withUserBackgroundImages

public UpdateMixParam 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