com.herewhite.sdk.RoomParams class 参考

  • Android

更新时间不可用

详细描述

适用版本:Whiteboard Android SDK 2.16.134。

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

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

父类:WhiteObject;继承接口详见父类。

属性与 JSON 字段

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

字段声明源码初值说明
uuidString uuid未显式赋值

模型属性;通过对应 getter/setter 访问。

roomTokenString roomToken未显式赋值

模型属性;通过对应 getter/setter 访问。

regionRegion region未显式赋值

模型属性;通过对应 getter/setter 访问。

cameraBoundCameraBound cameraBound未显式赋值

模型属性;通过对应 getter/setter 访问。

timeoutlong timeout45000

重连时,最大重连尝试时间,单位:毫秒,默认 45 秒。

disableEraseImageboolean disableEraseImagefalse

模型属性;通过对应 getter/setter 访问。

disableDeviceInputsboolean disableDeviceInputsfalse

模型属性;通过对应 getter/setter 访问。

disableOperationsboolean disableOperationsfalse

模型属性;通过对应 getter/setter 访问。

disableCameraTransformboolean disableCameraTransformfalse

禁止设备输入引发的视角变化;不会禁止程序调用支持的视角接口。

disableBezierboolean disableBezierfalse

模型属性;通过对应 getter/setter 访问。

disableNewPencilboolean disableNewPenciltrue

模型属性;通过对应 getter/setter 访问。

userPayloadObject userPayload未显式赋值

模型属性;通过对应 getter/setter 访问。

undoCacheScenesCountInteger undoCacheScenesCount未显式赋值

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

windowParamsWindowParams windowParams未显式赋值

多窗口属性

disableTextOperationsboolean disableTextOperationsfalse

是否关闭 insertText与updateText 操作权限

modulesOriginString modulesOrigin未显式赋值

模型属性;通过对应 getter/setter 访问。

optimizeOptionsRoomOptimizeOptions optimizeOptions未显式赋值

白板渲染优化配置项。

appliancePluginOptionsAppliancePluginOptions appliancePluginOptions未显式赋值

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

disableInitialStateCallbackboolean disableInitialStateCallbackfalse

是否禁止初始化时的回调

表格内容超出当前宽度,可横向滚动查看更多列。
公开成员签名
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)
RegiongetRegion ()
voidsetRegion (Region region)
booleanisWritable ()
voidsetWritable (boolean writable)
booleangetDisableEraseImage ()
voidsetDisableEraseImage (boolean disableEraseImage)
voidsetTimeout (long timeout, TimeUnit timeUnit)
booleanisDisableDeviceInputs ()
voidsetDisableDeviceInputs (boolean disableDeviceInputs)
booleanisDisableOperations ()
voidsetDisableOperations (boolean disableOperations)
booleanisDisableBezier ()
voidsetDisableBezier (boolean disableBezier)
booleanisDisableCameraTransform ()
voidsetDisableCameraTransform (boolean disableCameraTransform)
booleanisDisableNewPencil ()
voidsetDisableNewPencil (boolean disableNewPencil)
CameraBoundgetCameraBound ()
voidsetCameraBound (CameraBound cameraBound)
ObjectgetUserPayload ()
voidsetUserPayload (Object userPayload)
MemberInformationgetMemberInfo ()
voidsetMemberInfo (MemberInformation memberInfo)
StringgetUuid ()
voidsetUuid (String uuid)
StringgetRoomToken ()
voidsetRoomToken (String roomToken)
IntegergetUndoCacheScenesCount ()
voidsetUndoCacheScenesCount (Integer undoCacheScenesCount)
WindowParamsgetWindowParams ()
voidsetWindowParams (WindowParams windowParams)
booleanisDisableTextOperations ()
voidsetDisableTextOperations (boolean disableTextOperations)
booleanisUseNativeWebSocket ()
voidsetUseNativeWebSocket (boolean nativeWebSocket)
booleanisUsingFloatBar ()
voidsetUsingFloatBar (boolean floatBar)
StringgetModulesOrigin ()
voidsetModulesOrigin (String modulesOrigin)
RoomOptimizeOptionsgetOptimizeOptions ()
voidsetOptimizeOptions (RoomOptimizeOptions optimizeOptions)
booleanisDisableInitialStateCallback ()
voidsetDisableInitialStateCallback (boolean disableInitialStateCallback)
AppliancePluginOptionsgetAppliancePluginOptions ()
voidsetAppliancePluginOptions (AppliancePluginOptions appliancePluginOptions)
表格内容超出当前宽度,可横向滚动查看更多列。

变量说明

uuid

Text
String uuid

源码初值:未显式赋值

模型属性;通过对应 getter/setter 访问。

roomToken

Text
String roomToken

源码初值:未显式赋值

模型属性;通过对应 getter/setter 访问。

region

Text
Region region

源码初值:未显式赋值

模型属性;通过对应 getter/setter 访问。

cameraBound

Text
CameraBound cameraBound

源码初值:未显式赋值

模型属性;通过对应 getter/setter 访问。

timeout

Text
long timeout

源码初值:45000

重连时,最大重连尝试时间,单位:毫秒,默认 45 秒。

disableEraseImage

Text
boolean disableEraseImage

源码初值:false

模型属性;通过对应 getter/setter 访问。

disableDeviceInputs

Text
boolean disableDeviceInputs

源码初值:false

模型属性;通过对应 getter/setter 访问。

disableOperations

Text
boolean disableOperations

源码初值:false

模型属性;通过对应 getter/setter 访问。

disableCameraTransform

Text
boolean disableCameraTransform

源码初值:false

禁止设备输入引发的视角变化;不会禁止程序调用支持的视角接口。

disableBezier

Text
boolean disableBezier

源码初值:false

模型属性;通过对应 getter/setter 访问。

disableNewPencil

Text
boolean disableNewPencil

源码初值:true

模型属性;通过对应 getter/setter 访问。

userPayload

Text
Object userPayload

源码初值:未显式赋值

模型属性;通过对应 getter/setter 访问。

undoCacheScenesCount

Text
Integer undoCacheScenesCount

源码初值:未显式赋值

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

windowParams

Text
WindowParams windowParams

源码初值:未显式赋值

多窗口属性

disableTextOperations

Text
boolean disableTextOperations

源码初值:false

是否关闭 insertText与updateText 操作权限

modulesOrigin

Text
String modulesOrigin

源码初值:未显式赋值

模型属性;通过对应 getter/setter 访问。

optimizeOptions

Text
RoomOptimizeOptions optimizeOptions

源码初值:未显式赋值

白板渲染优化配置项。

appliancePluginOptions

Text
AppliancePluginOptions appliancePluginOptions

源码初值:未显式赋值

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

disableInitialStateCallback

Text
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 数据的地址。 配置后不会请求白板默认地址。

参数
参数名描述
modulesOrigin

modules 地址。示例 https://modules.example.com。

表格内容超出当前宽度,可横向滚动查看更多列。

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

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 为配置嵌套层;与启用开关配合使用。

这个页面有帮助吗?