Agora Interactive Whiteboard Java API Reference
Public Member Functions | List of all members
com.herewhite.sdk.domain.MemberState Class Reference
Inheritance diagram for com.herewhite.sdk.domain.MemberState:
com.herewhite.sdk.domain.WhiteObject

Public Member Functions

String getCurrentApplianceName ()
 
void setCurrentApplianceName (String currentApplianceName)
 
void setCurrentApplianceName (String currentApplianceName, ShapeType shapeType)
 
void setShapeType (ShapeType shapeType)
 
ShapeType getShapeType ()
 
int[] getStrokeColor ()
 
void setStrokeColor (int[] strokeColor)
 
double getStrokeWidth ()
 
void setStrokeWidth (double strokeWidth)
 
double getTextSize ()
 
void setTextSize (double textSize)
 
Boolean getTextCanSelectText ()
 
void setTextCanSelectText (Boolean textCanSelectText)
 
Boolean getDottedLine ()
 
void setDottedLine (Boolean dottedLine)
 
- Public Member Functions inherited from com.herewhite.sdk.domain.WhiteObject
String toString ()
 
JSONObject toJSON ()
 

Detailed Description

Created by buhe on 2018/8/11. Settings of the whiteboard tool in use.

Member Function Documentation

◆ getCurrentApplianceName()

String com.herewhite.sdk.domain.MemberState.getCurrentApplianceName ( )

Gets the name of the whiteboard tool currently in use.

Returns
The name of the whiteboard tool currently in use.

◆ setCurrentApplianceName() [1/2]

void com.herewhite.sdk.domain.MemberState.setCurrentApplianceName ( String  currentApplianceName)

Sets the whiteboard tool.

Parameters
currentApplianceNameThe whiteboard tool. See Appliance.

◆ setCurrentApplianceName() [2/2]

void com.herewhite.sdk.domain.MemberState.setCurrentApplianceName ( String  currentApplianceName,
ShapeType  shapeType 
)

Sets the whiteboard tool.

Parameters
currentApplianceNameThe whiteboard tool. See Appliance.
shapeTypeThe shape type. The default value is Triangle. See ShapeType.

◆ setShapeType()

void com.herewhite.sdk.domain.MemberState.setShapeType ( ShapeType  shapeType)

Sets the shape type.

Since
2.12.26
Parameters
shapeTypeThe shape type. See ShapeType.

◆ getShapeType()

ShapeType com.herewhite.sdk.domain.MemberState.getShapeType ( )

Gets the shape type.

Since
2.12.26
Returns
The shape type. See ShapeType

◆ getStrokeColor()

int[] com.herewhite.sdk.domain.MemberState.getStrokeColor ( )

Gets the stroke color.

Returns
The stroke color in RGB format, for example, 0, 0, 255 (blue).

◆ setStrokeColor()

void com.herewhite.sdk.domain.MemberState.setStrokeColor ( int[]  strokeColor)

Sets the stroke color.

Parameters
strokeColorThe stroke color in RGB format, for example, 0, 0, 255 (blue).

◆ getStrokeWidth()

double com.herewhite.sdk.domain.MemberState.getStrokeWidth ( )

Gets the stroke width.

Returns
The stroke width.

◆ setStrokeWidth()

void com.herewhite.sdk.domain.MemberState.setStrokeWidth ( double  strokeWidth)

Sets the stroke width.

Parameters
strokeWidthThe stroke width.

◆ getTextSize()

double com.herewhite.sdk.domain.MemberState.getTextSize ( )

Gets the font size of the text.

Returns
The font size of the text.

◆ setTextSize()

void com.herewhite.sdk.domain.MemberState.setTextSize ( double  textSize)

Sets the font size of the text.

Parameters
textSizeThe font size of the text. The Chrome browser automatically adjusts fonts smaller than 12 to 12.

◆ getTextCanSelectText()

Boolean com.herewhite.sdk.domain.MemberState.getTextCanSelectText ( )

Gets whether directly selecting and editing whiteboard text is allowed.

Returns
Whether directly selecting and editing whiteboard text is allowed.

◆ setTextCanSelectText()

void com.herewhite.sdk.domain.MemberState.setTextCanSelectText ( Boolean  textCanSelectText)

Sets whether to allow directly selecting and editing whiteboard text.

Parameters
textCanSelectTextWhether to allow directly selecting and editing whiteboard text:
  • true:Allow directly selecting and editing whiteboard text.
  • false:Do not allow directly selecting and editing whiteboard text.

◆ getDottedLine()

Boolean com.herewhite.sdk.domain.MemberState.getDottedLine ( )

Gets whether to support drawing dotted lines:

Returns
Whether to support drawing dotted lines:

◆ setDottedLine()

void com.herewhite.sdk.domain.MemberState.setDottedLine ( Boolean  dottedLine)

Sets whether to support drawing dotted lines: This feature only applies to NewPencil. You need to set disableNewPencil to false before joining the room.

Parameters
dottedLineWhether to support drawing dotted lines:
  • true:Support drawing dotted lines.
  • false:(Default) Do not support drawing dotted lines.