com.herewhite.sdk.RoomParams class 参考

适用版本：Whiteboard Android SDK 2.16.134。

RoomParams 类，用于配置实时房间的参数。

@note RoomParams 类中所有的方法都必须在 joinRoom 前调用；成功加入房间后，调用该类中的任何方法都不会生效。

父类：WhiteObject；继承接口详见父类。

属性与 JSON 字段

Java 非公开字段通过对应 getter/setter 访问；可选包装类型未设置时通常不写入 JSON。初值包含字段声明及无参构造中的直接赋值；其他构造参数以签名为准。

字段	声明	源码初值	说明
uuid	String uuid	未显式赋值	模型属性；通过对应 getter/setter 访问。
roomToken	String roomToken	未显式赋值	模型属性；通过对应 getter/setter 访问。
region	Region region	未显式赋值	模型属性；通过对应 getter/setter 访问。
cameraBound	CameraBound cameraBound	未显式赋值	模型属性；通过对应 getter/setter 访问。
timeout	long timeout	45000	重连时，最大重连尝试时间，单位：毫秒，默认 45 秒。
disableEraseImage	boolean disableEraseImage	false	模型属性；通过对应 getter/setter 访问。
disableDeviceInputs	boolean disableDeviceInputs	false	模型属性；通过对应 getter/setter 访问。
disableOperations	boolean disableOperations	false	模型属性；通过对应 getter/setter 访问。
disableCameraTransform	boolean disableCameraTransform	false	禁止设备输入引发的视角变化；不会禁止程序调用支持的视角接口。
disableBezier	boolean disableBezier	false	模型属性；通过对应 getter/setter 访问。
disableNewPencil	boolean disableNewPencil	true	模型属性；通过对应 getter/setter 访问。
userPayload	Object userPayload	未显式赋值	模型属性；通过对应 getter/setter 访问。
undoCacheScenesCount	Integer undoCacheScenesCount	未显式赋值	撤销/重做保留的场景缓存数量；在入房前配置，未设置时交由内嵌 Web SDK 决定。
windowParams	WindowParams windowParams	未显式赋值	多窗口属性
disableTextOperations	boolean disableTextOperations	false	是否关闭 <code>insertText</code><code> 与 </code><code>updateText</code> 操作权限
modulesOrigin	String modulesOrigin	未显式赋值	模型属性；通过对应 getter/setter 访问。
optimizeOptions	RoomOptimizeOptions optimizeOptions	未显式赋值	白板渲染优化配置项。
appliancePluginOptions	AppliancePluginOptions appliancePluginOptions	未显式赋值	本地绘制插件参数，extras 为配置嵌套层；与启用开关配合使用。
disableInitialStateCallback	boolean disableInitialStateCallback	false	是否禁止初始化时的回调

公开成员签名
	RoomParams (String uuid, String roomToken, String uid)
	RoomParams (String uuid, String roomToken, String uid, MemberInformation memberInfo)
	RoomParams (String uuid, String roomToken, String uid, Object userPayload)
Region	getRegion ()
void	setRegion (Region region)
boolean	isWritable ()
void	setWritable (boolean writable)
boolean	getDisableEraseImage ()
void	setDisableEraseImage (boolean disableEraseImage)
void	setTimeout (long timeout, TimeUnit timeUnit)
boolean	isDisableDeviceInputs ()
void	setDisableDeviceInputs (boolean disableDeviceInputs)
boolean	isDisableOperations ()
void	setDisableOperations (boolean disableOperations)
boolean	isDisableBezier ()
void	setDisableBezier (boolean disableBezier)
boolean	isDisableCameraTransform ()
void	setDisableCameraTransform (boolean disableCameraTransform)
boolean	isDisableNewPencil ()
void	setDisableNewPencil (boolean disableNewPencil)
CameraBound	getCameraBound ()
void	setCameraBound (CameraBound cameraBound)
Object	getUserPayload ()
void	setUserPayload (Object userPayload)
MemberInformation	getMemberInfo ()
void	setMemberInfo (MemberInformation memberInfo)
String	getUuid ()
void	setUuid (String uuid)
String	getRoomToken ()
void	setRoomToken (String roomToken)
Integer	getUndoCacheScenesCount ()
void	setUndoCacheScenesCount (Integer undoCacheScenesCount)
WindowParams	getWindowParams ()
void	setWindowParams (WindowParams windowParams)
boolean	isDisableTextOperations ()
void	setDisableTextOperations (boolean disableTextOperations)
boolean	isUseNativeWebSocket ()
void	setUseNativeWebSocket (boolean nativeWebSocket)
boolean	isUsingFloatBar ()
void	setUsingFloatBar (boolean floatBar)
String	getModulesOrigin ()
void	setModulesOrigin (String modulesOrigin)
RoomOptimizeOptions	getOptimizeOptions ()
void	setOptimizeOptions (RoomOptimizeOptions optimizeOptions)
boolean	isDisableInitialStateCallback ()
void	setDisableInitialStateCallback (boolean disableInitialStateCallback)
AppliancePluginOptions	getAppliancePluginOptions ()
void	setAppliancePluginOptions (AppliancePluginOptions appliancePluginOptions)

变量说明

uuid

String uuid

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

roomToken

String roomToken

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

region

Region region

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

cameraBound

CameraBound cameraBound

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

timeout

long timeout

源码初值：45000
重连时，最大重连尝试时间，单位：毫秒，默认 45 秒。

disableEraseImage

boolean disableEraseImage

源码初值：false
模型属性；通过对应 getter/setter 访问。

disableDeviceInputs

boolean disableDeviceInputs

源码初值：false
模型属性；通过对应 getter/setter 访问。

disableOperations

boolean disableOperations

源码初值：false
模型属性；通过对应 getter/setter 访问。

disableCameraTransform

boolean disableCameraTransform

源码初值：false
禁止设备输入引发的视角变化；不会禁止程序调用支持的视角接口。

disableBezier

boolean disableBezier

源码初值：false
模型属性；通过对应 getter/setter 访问。

disableNewPencil

boolean disableNewPencil

源码初值：true
模型属性；通过对应 getter/setter 访问。

userPayload

Object userPayload

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

undoCacheScenesCount

Integer undoCacheScenesCount

源码初值：未显式赋值
撤销/重做保留的场景缓存数量；在入房前配置，未设置时交由内嵌 Web SDK 决定。

windowParams

WindowParams windowParams

源码初值：未显式赋值
多窗口属性

disableTextOperations

boolean disableTextOperations

源码初值：false
是否关闭 `insertText``与``updateText` 操作权限

modulesOrigin

String modulesOrigin

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

optimizeOptions

RoomOptimizeOptions optimizeOptions

源码初值：未显式赋值
白板渲染优化配置项。

appliancePluginOptions

AppliancePluginOptions appliancePluginOptions

源码初值：未显式赋值
本地绘制插件参数，extras 为配置嵌套层；与启用开关配合使用。

disableInitialStateCallback

boolean disableInitialStateCallback

源码初值：false
是否禁止初始化时的回调

函数说明

RoomParams()

RoomParams(String uuid, String roomToken, String uid)

初始化房间配置参数。

参数

参数名	描述
uuid	房间 UUID， 即房间唯一标识符。传入的房间 UUID 必须和生成 Room Token 时填入的房间 UUID 一致。
roomToken	用于鉴权的 Room Token。
uid	自从 v2.15.0。用户唯一标识符，字符串格式，长度不能超过 1024 字节。如果你使用 2.15.0 及之后版本的 SDK，必须传入该参数。 请确保同一房间内每个用户 uid 的唯一性。

RoomParams()

RoomParams(String uuid, String roomToken, String uid, MemberInformation memberInfo)

初始化房间配置参数并传入用户信息。

弃用:

该方法已经废弃。请使用 RoomParams[3/3]。

参数

参数名	描述
uuid	房间 UUID， 即房间唯一标识符。传入的房间 UUID 必须和生成 Room Token 时填入的房间 UUID 一致。
roomToken	用于鉴权的 Room Token。
uid	自从 v2.15.0。用户唯一标识符，字符串格式，长度不能超过 1024 字节。如果你使用 2.15.0 及之后版本的 SDK，必须传入该参数。 请确保同一房间内每个用户 uid 的唯一性。
memberInfo	自定义用户信息，详见 MemberInformation。

RoomParams()

RoomParams(String uuid, String roomToken, String uid, Object userPayload)

初始化房间配置参数并传入自定义的用户信息。

自从

2.0.0

参数

参数名	描述
uuid	房间 UUID， 即房间唯一标识符。传入的房间 UUID 必须和生成 Room Token 时填入的房间 UUID 一致。
roomToken	用于鉴权的 Room Token。
uid	自从 v2.15.0。用户唯一标识符，字符串格式，长度不能超过 1024 字节。如果你使用 2.15.0 及之后版本的 SDK，必须传入该参数。 请确保同一房间内每个用户 uid 的唯一性。
userPayload	自定义用户信息，必须为 WhiteObject 子类。

getRegion()

Region getRegion()

获取设置的数据中心。

返回值

设置的数据中心，详见 Region。

setRegion()

void setRegion(Region region)

设置数据中心。

注解

• 该方法设置的数据中心必须与要加入的互动白板实时房间所在数据中心一致，否则无法加入房间。
• 该方法与 WhiteSdkConfiguration 类中的 setRegion 方法作用相同，两个方法只需要调用其中的一个。如果同时调用，该方法会覆盖 WhiteSdkConfiguration 类中的 setRegion。

参数

参数名	描述
region	数据中心，详见 Region。

isWritable()

boolean isWritable()

获取用户是否以互动模式加入白板房间。

返回值

用户是否以互动模式加入白板房间：

• true：以互动模式加入白板房间，即具有读写权限。
• false：以订阅模式加入白板房间，即具有只读权限。

setWritable()

void setWritable(boolean writable)

设置用户是否以互动模式加入白板房间。

用户可以以以下模式加入互动白板实时房间：

• 互动模式：对白板具有读写权限，会出现在房间的成员列表中，对其他用户可见。
• 订阅模式：对白板具有只读权限，不会出现在房间的成员列表中，对其他用户不可见。

参数

参数名	描述
writable	用户是否以互动模式加入白板房间： true：（默认）以互动模式加入白板房间。 false：以订阅模式加入白板房间。

getDisableEraseImage()

boolean getDisableEraseImage()

获取是否关闭橡皮擦擦除图片功能。

返回值

是否关闭橡皮擦擦除图片功能：

• true：橡皮擦不可以擦除图片。
• false：橡皮擦可以擦除图片。

setDisableEraseImage()

void setDisableEraseImage(boolean disableEraseImage)

设置是否关闭橡皮擦擦除图片功能。

默认情况下，橡皮擦可以擦除白板上的所有内容，包括图片。你可以调用 setDisableEraseImage(true) 设置橡皮擦不能擦除图片。

参数

参数名	描述
disableEraseImage	是否关闭橡皮擦擦除图片功能： true：橡皮擦不可以擦除图片。 false：（默认）橡皮擦可以擦除图片。

setTimeout()

void setTimeout(long timeout, TimeUnit timeUnit)

设置加入房间的超时时间。

参数

参数名	描述
timeout	超时时长，默认值为 45000 毫秒。
timeUnit	时长单位，默认值为毫秒 （MILLISECONDS），取值详见 TimeUnit。

isDisableDeviceInputs()

boolean isDisableDeviceInputs()

获取是否禁止白板工具响应用户输入。

返回值

是否禁止白板工具响应用户输入：

• true：禁止白板工具响应用户输入。
• false：允许白板工具响应用户输入。

setDisableDeviceInputs()

void setDisableDeviceInputs(boolean disableDeviceInputs)

开启/禁止白板工具响应用户输入。

自从

2.5.0

参数

参数名	描述
disableDeviceInputs	是否禁止白板工具响应用户输入： true：禁止白板工具响应用户输入。 false：（默认）允许白板工具响应用户输入。

isDisableOperations()

boolean isDisableOperations()

获取是否禁止白板响应用户的操作。

返回值

是否禁止白板响应用户的操作。

• true：禁止白板响应用户的操作。
• false：允许白板响应用户的操作。

setDisableOperations()

void setDisableOperations(boolean disableOperations)

允许/禁止白板响应用户任何操作。

自从

2.5.0

弃用:

该方法已废弃。请使用 setDisableDeviceInputs 和 setDisableCameraTransform。

禁止白板响应用户任何操作后，用户无法使用白板工具输入内容，也无法对白板进行视角缩放和视角移动。

参数

参数名	描述
disableOperations	是否禁止白板响应用户的操作： true：禁止白板响应用户的操作。 false：（默认）允许白板响应用户的操作。

isDisableBezier()

boolean isDisableBezier()

获取是否关闭贝塞尔曲线优化。

返回值

是否关闭贝塞尔曲线优化：

• true: 关闭贝塞尔曲线优化。
• false: 开启贝塞尔曲线优化。

setDisableBezier()

void setDisableBezier(boolean disableBezier)

设置是否关闭贝塞尔曲线优化。

自从

2.5.0

参数

参数名	描述
disableBezier	是否关闭贝塞尔曲线优化： true: 关闭贝塞尔曲线优化。 false: （默认）开启贝塞尔曲线优化。

isDisableCameraTransform()

boolean isDisableCameraTransform()

获取是否禁止本地用户操作白板视角。

返回值

是否禁止本地用户操作白板视角：

• true：禁止本地用户操作白板视角。
• false：允许本地用户操作白板视角。

setDisableCameraTransform()

void setDisableCameraTransform(boolean disableCameraTransform)

禁止/允许本地用户操作白板的视角，包括缩放和移动视角。

参数

参数名	描述
disableCameraTransform	是否禁止本地用户操作白板视角： true：禁止本地用户操作白板视角。 false：（默认）允许本地用户操作白板视角。

isDisableNewPencil()

boolean isDisableNewPencil()

获取是否关闭新铅笔工具。

返回值

是否关闭新铅笔工具：

• true: 关闭新铅笔工具。
• false: 开启新铅笔工具。

setDisableNewPencil()

void setDisableNewPencil(boolean disableNewPencil)

关闭/开启新铅笔工具。

自从

2.12.2

注解

• 在 2.12.2 版本中，setDisableNewPencil 的默认值为 false，自 2.12.3 版本起，setDisableNewPencil 的默认值改为 true。
• 为正常显示笔迹，在开启新铅笔工具前，请确保该房间内的所有用户使用如下 SDK：
  • Android SDK 2.12.3 版或之后
  • iOS SDK 2.12.3 版或之后
  • Web SDK 2.12.5 版或之后

参数

参数名	描述
disableNewPencil	是否关闭新铅笔工具： true: （默认）关闭新铅笔工具。关闭后，SDK 对铅笔工具（pencil）应用旧版笔迹平滑算法。 false: 开启新铅笔工具。开启后，SDK 对铅笔工具应用新版笔迹平滑算法，使书写笔迹更加流畅自然，并带有笔锋效果。

getCameraBound()

CameraBound getCameraBound()

获取视角边界。

返回值

视角边界。

setCameraBound()

void setCameraBound(CameraBound cameraBound)

设置本地用户的视角边界。

自从

2.5.0

参数

参数名	描述
cameraBound	视角边界，详见 CameraBound。

getUserPayload()

Object getUserPayload()

获取自定义用户信息。

返回值

自定义用户信息。

setUserPayload()

void setUserPayload(Object userPayload)

自定义用户信息。

自从

2.0.0

你可以在 userPayload 中传入自定义的用户信息，例如用户ID，昵称和头像，然后调用此方法将信息发送给应用程序。

注解

为确保传入的 userPayload 格式正确，必须为 WhiteObject 的子类。

参数

参数名	描述
userPayload	自定义的用户信息，必须为 key-value 结构，例如，"avatar", "https://example.com/user.png")。

getMemberInfo()

MemberInformation getMemberInfo()

获取自定义的用户信息。

弃用:

该方法已废弃。请使用 getUserPayload。

返回值

自定义用户信息，详见 MemberInformation。

setMemberInfo()

void setMemberInfo(MemberInformation memberInfo)

自定义用户信息。

弃用:

该方法已废弃。请使用 getUserPayload。

参数

参数名	描述
memberInfo	用户信息，详见 MemberInformation。

getUuid()

String getUuid()

获取房间 UUID。

返回值

房间 UUID，即房间的唯一标识符。

setUuid()

void setUuid(String uuid)

设置房间 UUID。

参数

参数名	描述
uuid	房间 UUID，即房间的唯一标识符。

getRoomToken()

String getRoomToken()

获取 Room Token。

返回值

Room Token。

setRoomToken()

void setRoomToken(String roomToken)

设置 Room Token。

参数

参数名	描述
roomToken	用于鉴权的 Room Token。生成该 Room Token 的房间 UUID 必须和上面传入的房间 UUID 一致。

getUndoCacheScenesCount()

Integer getUndoCacheScenesCount()

撤销/重做保留的场景缓存数量；在入房前配置，未设置时交由内嵌 Web SDK 决定。

setUndoCacheScenesCount()

void setUndoCacheScenesCount(Integer undoCacheScenesCount)

撤销/重做保留的场景缓存数量；在入房前配置，未设置时交由内嵌 Web SDK 决定。

getWindowParams()

WindowParams getWindowParams()

getWindowParams：com.herewhite.sdk.RoomParams 的公开成员。参数和返回类型见下方签名。

setWindowParams()

void setWindowParams(WindowParams windowParams)

setWindowParams：com.herewhite.sdk.RoomParams 的公开成员。参数和返回类型见下方签名。

isDisableTextOperations()

boolean isDisableTextOperations()

isDisableTextOperations：com.herewhite.sdk.RoomParams 的公开成员。参数和返回类型见下方签名。

setDisableTextOperations()

void setDisableTextOperations(boolean disableTextOperations)

setDisableTextOperations：com.herewhite.sdk.RoomParams 的公开成员。参数和返回类型见下方签名。

isUseNativeWebSocket()

boolean isUseNativeWebSocket()

获取是否开启全链路加速功能。

返回值

是否开启全链路加速功能：

• true：开启。
• false：关闭。

setUseNativeWebSocket()

void setUseNativeWebSocket(boolean nativeWebSocket)

开启全链路加速功能。

Agora 互动白板服务集成了 Agora 全链路加速（FPA）服务。 集成 Agora Whiteboard SDK 后，你只需调用 setUseNativeWebSocket(true)，即可在互动白板应用中开启全链路加速服务，提升传输质量。

参数

参数名	描述
nativeWebSocket	是否开启全链路加速： true：开启全链路加速。 false：（默认）关闭全链路加速。

isUsingFloatBar()

boolean isUsingFloatBar()

获取浮动条功能是否已开启。

返回值

浮动条功能是否已开启：

• true：开启。
• false：关闭。

setUsingFloatBar()

void setUsingFloatBar(boolean floatBar)

设置是否开启开启浮动条功能。

参数

参数名	描述
floatBar	是否开启浮动条： true：开启浮动条功能。 false：（默认）关闭浮动条功能。

getModulesOrigin()

String getModulesOrigin()

获取白板请求 modules 数据的地址。

返回值

方法调用成功时返回 modules 地址。

setModulesOrigin()

void setModulesOrigin(String modulesOrigin)

设置白板请求 modules 数据的地址。 配置后不会请求白板默认地址。

白板渲染优化配置项。详见 RoomOptimizeOptions。

参数

参数名	描述
modulesOrigin	modules 地址。示例 https://modules.example.com。

getOptimizeOptions()

RoomOptimizeOptions getOptimizeOptions()

getOptimizeOptions：com.herewhite.sdk.RoomParams 的公开成员。参数和返回类型见下方签名。

setOptimizeOptions()

void setOptimizeOptions(RoomOptimizeOptions optimizeOptions)

setOptimizeOptions：com.herewhite.sdk.RoomParams 的公开成员。参数和返回类型见下方签名。

isDisableInitialStateCallback()

boolean isDisableInitialStateCallback()

获取是否禁止初始化状态回调。

返回值

方法返回值，类型为 boolean。

setDisableInitialStateCallback()

void setDisableInitialStateCallback(boolean disableInitialStateCallback)

禁止初始化状态回调

参数

参数

参数名	描述
disableInitialStateCallback	- true：禁止。 - false：（默认）不禁止。

getAppliancePluginOptions()

AppliancePluginOptions getAppliancePluginOptions()

本地绘制插件参数，extras 为配置嵌套层；与启用开关配合使用。

setAppliancePluginOptions()

void setAppliancePluginOptions(AppliancePluginOptions appliancePluginOptions)

本地绘制插件参数，extras 为配置嵌套层；与启用开关配合使用。