Public Member Functions | |
void | setRegion (Region region) |
Region | getRegion () |
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) |
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) | |
MemberInformation | getMemberInfo () |
void | setMemberInfo (MemberInformation memberInfo) |
String | getUuid () |
void | setUuid (String uuid) |
String | getRoomToken () |
void | setRoomToken (String roomToken) |
Public Member Functions inherited from com.herewhite.sdk.domain.WhiteObject | |
String | toString () |
JSONObject | toJSON () |
Configurations for a Room instance.
com.herewhite.sdk.RoomParams.RoomParams | ( | String | uuid, |
String | roomToken, | ||
String | uid | ||
) |
Initializes a RoomParams
instance.
uuid | The unique identifier of the room. Ensure that the room UUID is the same as the one you use to generate the Room Token. |
roomToken | The Room Token for authentication. |
uid | Since v2.15.0. The unique identifier of a user in a string format. The maximum length is 1024 bytes. If you upgrade the SDK to v2.15.0 or later, this parameter is required. Ensure that the uid of each user in the same room is unique. |
com.herewhite.sdk.RoomParams.RoomParams | ( | String | uuid, |
String | roomToken, | ||
String | uid, | ||
MemberInformation | memberInfo | ||
) |
Initializes a RoomParams
instance with customized user information.
uuid | The unique identifier of the room. Ensure that the room UUID is the same as the one you use to generate the Room Token. |
roomToken | The Room Token for authentication. |
uid | Since v2.15.0. The unique identifier of a user in a string format. The maximum length is 1024 bytes. If you upgrade the SDK to v2.15.0 or later, this parameter is required. Ensure that the uid of each user in the same room is unique. |
memberInfo | Customized user information. See MemberInformation. |
com.herewhite.sdk.RoomParams.RoomParams | ( | String | uuid, |
String | roomToken, | ||
String | uid, | ||
Object | userPayload | ||
) |
Initializes a RoomParams
instance with customized user information.
uuid | The unique identifier of the room. Ensure that the room UUID is the same as the one you use to generate the Room Token. |
roomToken | The Room Token for authentication. |
uid | Since v2.15.0. The unique identifier of a user in a string format. The maximum length is 1024 bytes. If you upgrade the SDK to v2.15.0 or later, this parameter is required. Ensure that the uid of each user in the same room is unique. |
userPayload | Customized user information, which must be a subclass of WhiteObject to ensure the data format is correct. |
void com.herewhite.sdk.RoomParams.setRegion | ( | Region | region | ) |
Sets the data center.
WhiteSdkConfiguration
class to set the data center. If you call both,this method overrides the setRegion method.region | The data center. See Region. |
Region com.herewhite.sdk.RoomParams.getRegion | ( | ) |
Gets the data center.
boolean com.herewhite.sdk.RoomParams.isWritable | ( | ) |
Gets whether the user joins the whiteboard room in interactive mode.
true
: The user joins the whiteboard room in interactive mode.false
: The user joins the whiteboard room in subscription mode. void com.herewhite.sdk.RoomParams.setWritable | ( | boolean | writable | ) |
Sets whether a user joins the whiteboard room in interactive mode.
Users can join a live Interactive Whiteboard room in one of the following modes:
writable | Whether to join the room in interactive mode:
|
boolean com.herewhite.sdk.RoomParams.getDisableEraseImage | ( | ) |
Gets whether the eraser is disabled from erasing images on the whiteboard.
true
: The eraser is disabled from erasing images.false
: The eraser is enabled to erase images. void com.herewhite.sdk.RoomParams.setDisableEraseImage | ( | boolean | disableEraseImage | ) |
Sets whether to disable the eraser from erasing images on the whiteboard.
By default, the eraser can erase everything on the whiteboard, including images. You can call setDisableEraseImage(true)
to set the eraser to not erase the images.
disableEraseImage | Whether to disable the eraser from erasing images on the whiteboard:
|
void com.herewhite.sdk.RoomParams.setTimeout | ( | long | timeout, |
TimeUnit | timeUnit | ||
) |
Sets the timeout for joining a room.
timeout | The time duration. The default value is 45000. |
timeUnit | The unit of the timeout parameter. The default value is MILLISECONDS . For all supported values, see TimeUnit. |
boolean com.herewhite.sdk.RoomParams.isDisableDeviceInputs | ( | ) |
Gets whether the whiteboard tools are disabled from responding to users' inputs.
true
:The whiteboard tools are disabled from responding to users' inputs.false
:The whiteboard tools are enabled to respond to users' inputs. void com.herewhite.sdk.RoomParams.setDisableDeviceInputs | ( | boolean | disableDeviceInputs | ) |
Disables the whiteboard tools from responding to users' inputs.
disableDeviceInputs | Whether to disable the whiteboard tools from responding to users' inputs:
|
boolean com.herewhite.sdk.RoomParams.isDisableOperations | ( | ) |
Gets whether the whiteboard is disabled from responding to users' operations.
true
: The whiteboard is disabled from responding to users' operations.false
: The whiteboard is enabled to respond to users' operations. void com.herewhite.sdk.RoomParams.setDisableOperations | ( | boolean | disableOperations | ) |
Disables the whiteboard from responding to users' operations.
After calling setDisableOperations(true)
, the users can neither use the whiteboard tools nor adjust the view of the whiteboard.
disableOperations | Whether to disable the whiteboard from responding to users' operations:
|
boolean com.herewhite.sdk.RoomParams.isDisableBezier | ( | ) |
Gets whether the Bézier curve optimization is disabled.
true
: The Bézier curve optimization is disabled.false
:The Bézier curve optimization is enabled. void com.herewhite.sdk.RoomParams.setDisableBezier | ( | boolean | disableBezier | ) |
Disables/Enables the Bézier curve optimization.
disableBezier | Whether to disable the Bézier curve optimization:
|
boolean com.herewhite.sdk.RoomParams.isDisableCameraTransform | ( | ) |
Gets whether adjusting the view of the whiteboard by the local user is disabled.
true
: The local user can adjust the view of the whiteboard.false
: The local user can adjust the view of the whiteboard. void com.herewhite.sdk.RoomParams.setDisableCameraTransform | ( | boolean | disableCameraTransform | ) |
Disables the local user from adjusting the view of the whiteboard, including moving and zooming the view.
disableCameraTransform | Whether to disable the local user from adjusting the view of the whiteboard:
|
boolean com.herewhite.sdk.RoomParams.isDisableNewPencil | ( | ) |
Gets whether the stroke effect is disabled.
void com.herewhite.sdk.RoomParams.setDisableNewPencil | ( | boolean | disableNewPencil | ) |
Disables/Enables the stroke effect of the pencil.
disableNewPencil
as false
; as of v2.12.3, the SDK changes the default value of disableNewPencil
to true
.disableNewPencil | Whether to disable the handwriting effect of the pencil:
|
CameraBound com.herewhite.sdk.RoomParams.getCameraBound | ( | ) |
Gets the boundary of the local user's view.
void com.herewhite.sdk.RoomParams.setCameraBound | ( | CameraBound | cameraBound | ) |
Sets the boundary of the local user's view.
cameraBound | The boundary of the view. See CameraBound. |
Object com.herewhite.sdk.RoomParams.getUserPayload | ( | ) |
Gets the customized user information.
void com.herewhite.sdk.RoomParams.setUserPayload | ( | Object | userPayload | ) |
Sets the customized user information.
You can pass in customized user information, such as user ID, nickname, and avatar, in the userPayload
and call this method to send the information to the application.
userPayload
must extend the WhiteObject class.userPayload | Customized user information in key-value pairs, for example, "avatar", "https://example.com/user.png" . |
MemberInformation com.herewhite.sdk.RoomParams.getMemberInfo | ( | ) |
Gets customized user information.
void com.herewhite.sdk.RoomParams.setMemberInfo | ( | MemberInformation | memberInfo | ) |
Sets customized user information.
memberInfo | Customized user information. See MemberInformation. |
String com.herewhite.sdk.RoomParams.getUuid | ( | ) |
Gets the UUID of the room.
void com.herewhite.sdk.RoomParams.setUuid | ( | String | uuid | ) |
Sets the UUID of the room.
uuid | The unique identifier of the room. |
String com.herewhite.sdk.RoomParams.getRoomToken | ( | ) |