WhiteBoardDefine

public class com.ss.video.byteboard.constant.WhiteBoardDefine
java

白板工具

EditType

public enum com.ss.video.byteboard.constant.WhiteBoardDefine.EditType
java

白板工具

枚举值

类型	说明
PEN(0)	画笔。画笔的设置接口如下。 + 调用 setPenSize 设置笔尖宽度。 + 调用 setPenColor 设置画笔颜色。
SHAPE_LINE(1)	形状：直线。形状的设置接口如下。 + 调用 setShapeSize 设置边框线条宽度。 + 调用 setShapeColor 设置边框线条颜色。
SHAPE_ARROW(2)	形状：箭头
SHAPE_RECT(3)	形状：矩形
SHAPE_CIRCLE(4)	形状：圆形
TEXT(5)	文本框。文本的设置接口如下。 + 调用 setTextFontSize 设置文字高度。 + 调用 setTextColor 设置文字颜色。
LASER_PEN(7)	激光笔
ERASER(100)	橡皮擦
SELECT(1000)	选择工具。选择图形后将出现选择框。如果默认的选择框样式无法满足你的需求，可以调用 setSelectionBoxStyle 更改选择框样式。
DRAG(1001)	拖拽工具，设置后SDK处理触摸事件实现缩放&平移操作

PlaybackState

public interface com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackState
java

白板录像回放状态

成员变量

类型	名称
int	INIT
int	PAUSE
int	START
int	END

变量说明

INIT

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackState.INIT = 0;
java

初始化

PAUSE

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackState.PAUSE = 1;
java

暂停播放

START

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackState.START = 2;
java

开始播放

END

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackState.END = 3;
java

停止播放

PlaybackReason

public interface com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackReason
java

白板录像回放状态原因

成员变量

类型	名称
int	DEFAULT
int	PREPARE_FOR_START
int	PREPARE_FOR_SEEK
int	FINISH
int	ERROR_DATA_EMPTY
int	ERROR_DATA_ERROR
int	ERROR_DOWNLOAD_FAIL

变量说明

DEFAULT

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackReason.DEFAULT = 0;
java

用户主动调用。

PREPARE_FOR_START

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackReason.PREPARE_FOR_START = 101;
java

正在加载资源

PREPARE_FOR_SEEK

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackReason.PREPARE_FOR_SEEK = 102;
java

为 seek 行为进度作数据准备。

FINISH

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackReason.FINISH = 601;
java

播放结束，停止播放

ERROR_DATA_EMPTY

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackReason.ERROR_DATA_EMPTY = 602;
java

播放数据为空

ERROR_DATA_ERROR

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackReason.ERROR_DATA_ERROR = 603;
java

播放数据错误

ERROR_DOWNLOAD_FAIL

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackReason.ERROR_DOWNLOAD_FAIL = 604;
java

播放数据下载失败

BoardStatus

public enum com.ss.video.byteboard.constant.WhiteBoardDefine.BoardStatus
java

白板状态

枚举值

类型	说明
kActive(0)	可用
kInActive(1)	不可用。房间中有用户调用 destroyRoom 关闭白板后，再次进房时，白板状态将为不可用。

ViewMode

public enum com.ss.video.byteboard.constant.WhiteBoardDefine.ViewMode
java

视角同步

枚举值

类型	说明
kBroadcast(0)	视角设置者，一个白板支持多个设置者
kFollow(1)	视角跟随者（默认值）
kFree(2)	自由模式

LockBoardReason

public enum com.ss.video.byteboard.constant.WhiteBoardDefine.LockBoardReason
java

白板锁定原因

枚举值

类型	说明
kBoardDataError(0)	数据错误
kNetworkCongestion(1)	网络阻塞
kNetworkDisconnect(2)	网络断开
kUnknown(3)	未知错误

ConnectionState

public enum com.ss.video.byteboard.constant.WhiteBoardDefine.ConnectionState
java

SDK 与 RTC 服务器连接状态。

枚举值

类型	说明
kConnectionStart(0)	进行连接前准备，锁定相关资源。
kConnectionStateDisconnected(1)	连接断开，且断开时长超过 12s，SDK 会自动重连。
kConnectionStateConnecting(2)	首次请求建立连接，正在连接中。
kConnectionStateConnected(3)	首次连接成功。
kConnectionStateReconnecting(4)	涵盖了以下情况： + 首次连接时，10秒连接不成功; + 连接成功后，断连 10 秒。自动重连中。
kConnectionStateReconnected(5)	连接断开后，重连成功。
kConnectionStateLost(6)	处于 `kConnectionStateDisconnected` 状态超过 10 秒，且期间重连未成功。SDK 仍将继续尝试重连。
kConnectionStateFailed(7)	连接失败，服务端状态异常。SDK 不会自动重连，请重新进房，或联系技术支持。

ImageLoadStatus

public enum com.ss.video.byteboard.constant.WhiteBoardDefine.ImageLoadStatus
java

图片加载状态。

枚举值

类型	说明
LOADING(0)	加载中。
END(1)	加载完成。
ERROR(2)	加载错误。

StatusType

public enum com.ss.video.byteboard.constant.WhiteBoardDefine.StatusType
java

当前白板是否可编辑

枚举值

类型	说明
Active(0)	可编辑
Inactive(1)	已关闭，不可编辑。如果开启了录像，在此状态下可以开始播放录像。不可用。房间中有用户调用 closeAllWhiteBoard 关闭白板后，再次进房时，白板状态将为已关闭。

BackgroundInfo

public class com.ss.video.byteboard.model.page.BackgroundInfo
java

背景信息

成员变量

类型	名称
int	BG_FILL_TYPE_FILL
int	BG_FILL_TYPE_CENTER
int	BG_FILL_TYPE_HIDDEN

静态函数

返回	名称
static BackgroundInfo	createBackgroundInfo

成员函数

返回	名称
int	getBkColor
void	setBkColor
String	getBkImage
void	setBkImage
ImageSize	getImageSize
void	setImageSize
int	getBkImageFillType
void	setBkImageFillType
HashMap<String, Object>	getMapParams

变量说明

BG_FILL_TYPE_FILL

public static final int com.ss.video.byteboard.model.page.BackgroundInfo.BG_FILL_TYPE_FILL = 0;
java

背景图片填充方式。平铺窗口，按照白板比例缩放图片进行填充。

BG_FILL_TYPE_CENTER

public static final int com.ss.video.byteboard.model.page.BackgroundInfo.BG_FILL_TYPE_CENTER = 1;
java

背景图片填充方式。居中放置，不缩放。

BG_FILL_TYPE_HIDDEN

public static final int com.ss.video.byteboard.model.page.BackgroundInfo.BG_FILL_TYPE_HIDDEN = 2;
java

背景图片填充方式。等比例缩放，如果画布和图片比例不一致，将对图片进行裁切。

函数说明

createBackgroundInfo

public static BackgroundInfo com.ss.video.byteboard.model.page.BackgroundInfo.createBackgroundInfo(
    String bkImage,
    ImageSize imageSize,
    int bkImageFillType,
    int bkColor)
java

初始化背景信息结构体。

传入参数

参数名	类型	说明
bkImage	String	背景图片资源 ID。
imageSize	ImageSize	背景图片尺寸。见 ImageSize。
bkImageFillType	int	背景图片填充方式。默认为 `1` 居中放置，不缩放。
bkColor	int	背景颜色。默认为 `0x00000000`。格式为 ARGB。

返回值
见 BackgroundInfo。

getBkColor

public int com.ss.video.byteboard.model.page.BackgroundInfo.getBkColor()
java

获取背景颜色。

返回值
背景颜色。

setBkColor

public void com.ss.video.byteboard.model.page.BackgroundInfo.setBkColor(
    int bkColor)
java

设置背景颜色。

传入参数

参数名	类型	说明
bkColor	int	背景颜色。默认为 `0x00000000`。格式为 ARGB。

getBkImage

public String com.ss.video.byteboard.model.page.BackgroundInfo.getBkImage()
java

获取背景图片资源 ID。

返回值
背景图片资源 ID。

setBkImage

public void com.ss.video.byteboard.model.page.BackgroundInfo.setBkImage(
    String bkImage)
java

设置背景图片。

传入参数

参数名	类型	说明
bkImage	String	背景图片资源 ID。

getImageSize

public ImageSize com.ss.video.byteboard.model.page.BackgroundInfo.getImageSize()
java

获取图片大小。

返回值
图片大小。

setImageSize

public void com.ss.video.byteboard.model.page.BackgroundInfo.setImageSize(
    ImageSize imageSize)
java

设置图片大小。

传入参数

参数名	类型	说明
imageSize	ImageSize	图片大小。见 ImageSizebkImageSize 。

getBkImageFillType

public int com.ss.video.byteboard.model.page.BackgroundInfo.getBkImageFillType()
java

获取图片填充方式。

返回值
图片填充方式。

setBkImageFillType

public void com.ss.video.byteboard.model.page.BackgroundInfo.setBkImageFillType(
    int bkImageFillType)
java

设置背景图片填充方式。

传入参数

参数名	类型	说明
bkImageFillType	int	背景图片填充方式。默认为 `1` 居中放置，不缩放。

getMapParams

public HashMap<String, Object> com.ss.video.byteboard.model.page.BackgroundInfo.getMapParams()
java

BoardInfo

public class com.ss.video.byteboard.model.page.BoardInfo
java

白板配置信息

成员函数

返回	名称
int	getBoardId
void	setBoardId
String	getBoardName
void	setBoardName
List	getPages
void	setPages
String	getCurrentPageId
int	getCreateTimestamp
BackgroundInfo	getBkInfo
void	setBkInfo
int	getStatus

函数说明

getBoardId

public int com.ss.video.byteboard.model.page.BoardInfo.getBoardId()
java

获取白板 ID

返回值
白板 ID

setBoardId

public void com.ss.video.byteboard.model.page.BoardInfo.setBoardId(
    int boardId)
java

getBoardName

public String com.ss.video.byteboard.model.page.BoardInfo.getBoardName()
java

获取白板名称

返回值
白板名称

setBoardName

public void com.ss.video.byteboard.model.page.BoardInfo.setBoardName(
    String boardName)
java

getPages

public List<PageInfo> com.ss.video.byteboard.model.page.BoardInfo.getPages()
java

返回值
详见 PageInfo

setPages

public void com.ss.video.byteboard.model.page.BoardInfo.setPages(
    List<PageInfo> pages)
java

传入参数

参数名	类型	说明
pages	List	详见 PageInfo

getCurrentPageId

public String com.ss.video.byteboard.model.page.BoardInfo.getCurrentPageId()
java

getCreateTimestamp

public int com.ss.video.byteboard.model.page.BoardInfo.getCreateTimestamp()
java

返回值
当前白板创建时间，为精确到毫秒的 UNIX 时间戳

getBkInfo

public BackgroundInfo com.ss.video.byteboard.model.page.BoardInfo.getBkInfo()
java

返回值
详见 BackgroundInfo

setBkInfo

public void com.ss.video.byteboard.model.page.BoardInfo.setBkInfo(
    BackgroundInfo bkInfo)
java

传入参数

参数名	类型	说明
bkInfo	BackgroundInfo	详见 BackgroundInfo

getStatus

public int com.ss.video.byteboard.model.page.BoardInfo.getStatus()
java

返回值

0: 可用
1: 不可用

CursorInfo

public class com.ss.video.byteboard.model.page.CursorInfo
java

光标样式

静态函数

返回	名称
static CursorInfo	create

成员函数

返回	名称
HashMap<String, Object>	optionMap
int	getCenterX
void	setCenterX
int	getCenterY
void	setCenterY
String	getFilePath
void	setFilePath

函数说明

create

public static CursorInfo com.ss.video.byteboard.model.page.CursorInfo.create(
    int width,
    int height,
    int centerX,
    int centerY,
    int filePath)
java

光标样式静态函数

传入参数

参数名	类型	说明
width	int	光标宽度
height	int	光标高度
centerX	int	中心点 X 坐标
centerY	int	中心点 Y 坐标
filePath	int	光标资源路径

返回值
CursorInfo 结构体

optionMap

public HashMap<String, Object> com.ss.video.byteboard.model.page.CursorInfo.optionMap(
    Context context)
java

getCenterX

public int com.ss.video.byteboard.model.page.CursorInfo.getCenterX()
java

获取中心点 X 坐标

返回值
中心点 X 坐标

setCenterX

public void com.ss.video.byteboard.model.page.CursorInfo.setCenterX(
    int centerX)
java

设置中心点 X 坐标

返回值
中心点 X 坐标

getCenterY

public int com.ss.video.byteboard.model.page.CursorInfo.getCenterY()
java

获取中心点 Y 坐标

返回值
中心点 Y 坐标

setCenterY

public void com.ss.video.byteboard.model.page.CursorInfo.setCenterY(
    int centerY)
java

设置中心点 Y 坐标

返回值
中心点 Y 坐标

getFilePath

public String com.ss.video.byteboard.model.page.CursorInfo.getFilePath()
java

获取光标资源路径

返回值
光标资源路径

setFilePath

public void com.ss.video.byteboard.model.page.CursorInfo.setFilePath(
    String filePath)
java

设置光标资源路径

返回值
光标资源路径

ImageSize

public class com.ss.video.byteboard.model.page.ImageSize
java

图片尺寸

成员变量

类型	名称
int	width
int	height

静态函数

返回	名称
static ImageSize	create

成员函数

返回	名称
int	getWidth
void	setWidth
int	getHeight
void	setHeight
HashMap<String, Object>	getMapParams

变量说明

width

public int com.ss.video.byteboard.model.page.ImageSize.width;
java

宽度，单位为屏幕宽度万分之一

height

public int com.ss.video.byteboard.model.page.ImageSize.height;
java

高度，单位为屏幕宽度万分之一

函数说明

create

public static ImageSize com.ss.video.byteboard.model.page.ImageSize.create(
    int width,
    int height)
java

getWidth

public int com.ss.video.byteboard.model.page.ImageSize.getWidth()
java

setWidth

public void com.ss.video.byteboard.model.page.ImageSize.setWidth(
    int width)
java

getHeight

public int com.ss.video.byteboard.model.page.ImageSize.getHeight()
java

setHeight

public void com.ss.video.byteboard.model.page.ImageSize.setHeight(
    int height)
java

getMapParams

public HashMap<String, Object> com.ss.video.byteboard.model.page.ImageSize.getMapParams()
java

ShapeStyle

public class com.ss.video.byteboard.model.page.ShapeStyle
java

选择框样式

成员变量

类型	名称
int	MOTION_RECT
int	MOTION_CIRCLE

成员函数

返回	名称
ShapeStyle	ShapeStyle
HashMap<String, Object>	getMapParams
int	getMotionType
int	getMotionSize
int	getMotionBorderWidth
int	getMotionBorderColor
int	getMotionFillColor
int	getBorderWidth
int	getBorderColor
int	getRotateImage
int	getRotateDistance

变量说明

MOTION_RECT

public static int com.ss.video.byteboard.model.page.ShapeStyle.MOTION_RECT = 0;
java

锚点为矩形

MOTION_CIRCLE

public static int com.ss.video.byteboard.model.page.ShapeStyle.MOTION_CIRCLE = 1;
java

锚点为圆形

函数说明

ShapeStyle

public com.ss.video.byteboard.model.page.ShapeStyle.ShapeStyle(
    int motionType,
    int motionSize,
    int motionBorderWidth,
    int motionBorderColor,
    int motionFillColor,
    int borderWidth,
    int borderColor,
    int rotateDistance,
    int rotateImage,
    boolean motionTransparent)
java

设置选择框样式。

传入参数

参数名	类型	说明
motionType	int	锚点形状。默认为 `0`，矩形。 • 矩形：`MOTION_RECT = 0` • 圆形：`MOTION_CIRCLE = 1`
motionSize	int	锚点宽度。默认为 `20`，单位为画布宽度的万分之一。
motionBorderWidth	int	锚点边框线条宽度。默认为 `10`，单位为画布宽度的万分之一。
motionBorderColor	int	锚点边框颜色。默认为 `0xFF000000`。格式为 ARGB。
motionFillColor	int	锚点填充颜色。默认为 `0xFF000000`。格式为 ARGB。
borderWidth	int	选择框宽度。默认为 `3`，单位为画布宽度的万分之一。
borderColor	int	选择框颜色。默认为 `0xFF000000`。格式为 ARGB。
rotateDistance	int	旋转手柄距离选择框顶点的距离。默认为 `-50`，单位为画布宽度的万分之一。
rotateImage	int	旋转手柄图标资源 ID。在项目 App 中上传资源后可以得到相应的资源 ID。默认为圆形。
motionTransparent	boolean	锚点是否透明。默认为 `False` 不透明。

getMapParams

public HashMap<String, Object> com.ss.video.byteboard.model.page.ShapeStyle.getMapParams(
    Context context)
java

getMotionType

public int com.ss.video.byteboard.model.page.ShapeStyle.getMotionType()
java

获取锚点形状

返回值
锚点形状

getMotionSize

public int com.ss.video.byteboard.model.page.ShapeStyle.getMotionSize()
java

获取锚点宽度

返回值
锚点宽度

getMotionBorderWidth

public int com.ss.video.byteboard.model.page.ShapeStyle.getMotionBorderWidth()
java

获取锚点边框线条宽度

返回值
锚点边框线条宽度

getMotionBorderColor

public int com.ss.video.byteboard.model.page.ShapeStyle.getMotionBorderColor()
java

获取锚点边框颜色

返回值
锚点边框颜色

getMotionFillColor

public int com.ss.video.byteboard.model.page.ShapeStyle.getMotionFillColor()
java

获取锚点填充颜色

返回值
锚点填充颜色

getBorderWidth

public int com.ss.video.byteboard.model.page.ShapeStyle.getBorderWidth()
java

获取选择框宽度

返回值
选择框宽度

getBorderColor

public int com.ss.video.byteboard.model.page.ShapeStyle.getBorderColor()
java

获取选择框颜色

返回值
选择框颜色

getRotateImage

public int com.ss.video.byteboard.model.page.ShapeStyle.getRotateImage()
java

获取旋转手柄图标资源地址

返回值
旋转手柄图标资源地址

getRotateDistance

public int com.ss.video.byteboard.model.page.ShapeStyle.getRotateDistance()
java

获取旋转手柄距离选择框顶点的距离

返回值
旋转手柄距离选择框顶点的距离

PageInfo

public class com.ss.video.byteboard.model.page.PageInfo
java

白板页面配置信息

静态函数

返回	名称
static PageInfo	create

成员函数

返回	名称
BackgroundInfo	getBackgroundInfo
void	setBackgroundInfo
String	getPageId
void	setPageId
String	getExtra
void	setExtra
HashMap<String, Object>	getMapParams

函数说明

create

public static PageInfo com.ss.video.byteboard.model.page.PageInfo.create(
    String pageId,
    String extra,
    BackgroundInfo backgroundInfo)
java

getBackgroundInfo

public BackgroundInfo com.ss.video.byteboard.model.page.PageInfo.getBackgroundInfo()
java

返回值
详见 BackgroundInfo

setBackgroundInfo

public void com.ss.video.byteboard.model.page.PageInfo.setBackgroundInfo(
    BackgroundInfo backgroundInfo)
java

传入参数

参数名	类型	说明
backgroundInfo	BackgroundInfo	详见 BackgroundInfo

getPageId

public String com.ss.video.byteboard.model.page.PageInfo.getPageId()
java

setPageId

public void com.ss.video.byteboard.model.page.PageInfo.setPageId(
    String pageId)
java

getExtra

public String com.ss.video.byteboard.model.page.PageInfo.getExtra()
java

setExtra

public void com.ss.video.byteboard.model.page.PageInfo.setExtra(
    String extra)
java

传入参数

参数名	类型	说明
extra	String	附加信息，最大 512 字节

getMapParams

public HashMap<String, Object> com.ss.video.byteboard.model.page.PageInfo.getMapParams()
java

UserCursorInfo

public class com.ss.video.byteboard.model.page.UserCursorInfo
java

光标信息

成员函数

返回	名称
int	getShowState
int	getCursorType

函数说明

getShowState

public int com.ss.video.byteboard.model.page.UserCursorInfo.getShowState()
java

获取光标显示状态

返回值

0: 隐藏
1: 显示

getCursorType

public int com.ss.video.byteboard.model.page.UserCursorInfo.getCursorType()
java

获取光标类型

返回值
详见 CursorType。

CursorType

public enum com.ss.video.byteboard.model.page.UserCursorInfo.CursorType
java

光标信息

枚举值

类型	说明
kArrow(0)	选择工具
kPen(2)	画笔工具
kShape(3)	形状绘制工具
kText(4)	文本工具
kErase(5)	橡皮擦工具
kLaserPen(6)	激光笔工具
kZoom(9)	放大缩小工具，光标不同步此类型，仅 Web 端本地用

CursorShowState

public enum com.ss.video.byteboard.model.page.UserCursorInfo.CursorShowState
java

光标显示

枚举值

类型	说明
kHide(0)	隐藏
kShow(1)	显示
kSimulate(2)	接收端本地模拟

ZoomInfo

public class com.ss.video.byteboard.model.page.ZoomInfo
java

视图缩放信息

成员函数

返回	名称
double	getZoom
void	setZoom
double	getOffsetX
void	setOffsetX
double	getOffsetY
void	setOffsetY

函数说明

getZoom

public double com.ss.video.byteboard.model.page.ZoomInfo.getZoom()
java

返回值
放大倍数

setZoom

public void com.ss.video.byteboard.model.page.ZoomInfo.setZoom(
    double zoom)
java

getOffsetX

public double com.ss.video.byteboard.model.page.ZoomInfo.getOffsetX()
java

返回值
距离原点 X 方向上的偏移，白板右方为正方向

setOffsetX

public void com.ss.video.byteboard.model.page.ZoomInfo.setOffsetX(
    double offsetX)
java

getOffsetY

public double com.ss.video.byteboard.model.page.ZoomInfo.getOffsetY()
java

返回值
距离原点 Y 方向上的偏移，白板下方为正方向

setOffsetY

public void com.ss.video.byteboard.model.page.ZoomInfo.setOffsetY(
    double offsetY)
java