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

Classes

enum  ScaleMode
 

Public Member Functions

Double getScale ()
 
void setScale (Double scale)
 
Double getSpace ()
 
void setSpace (Double space)
 
ScaleMode getMode ()
 
void setMode (ScaleMode mode)
 
- Public Member Functions inherited from com.herewhite.sdk.domain.WhiteObject
String toString ()
 
JSONObject toJSON ()
 

Detailed Description

Configurations for the scale mode and scale factor of the viewable area.

Since
2.5.0

Member Function Documentation

◆ getScale()

Double com.herewhite.sdk.domain.ContentModeConfig.getScale ( )

Gets the scale factor of the viewable area.

Returns
The scale factor of the viewable area.

◆ setScale()

void com.herewhite.sdk.domain.ContentModeConfig.setScale ( Double  scale)

Sets the scale factor of the viewable area.

Parameters
scaleThe scale factor of the viewable area. The default value is 1.0, which means keeping the original size.
Note
This method takes effect only when the scale mode is set as one the following values:

◆ getSpace()

Double com.herewhite.sdk.domain.ContentModeConfig.getSpace ( )

Gets the space added around the viewable area.

Returns
The space (pixels) added around the viewable area.

◆ setSpace()

void com.herewhite.sdk.domain.ContentModeConfig.setSpace ( Double  space)

Adds the space around the viewable area.

Note
This method takes effect only when the scale mode is set as ScaleMode#CENTER_INSIDE_SPACE.
Parameters
spaceThe space (pixels) around the viewable area. The default value is 0.

◆ getMode()

ScaleMode com.herewhite.sdk.domain.ContentModeConfig.getMode ( )

Gets the scale mode of the viewable area.

Returns
The scale mode of the viewable area. See ScaleMode.

◆ setMode()

void com.herewhite.sdk.domain.ContentModeConfig.setMode ( ScaleMode  mode)

Sets the scale mode of the viewable area.

Parameters
modeThe scale mode of the viewable area. See ScaleMode.