WhiteBoardDefine

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

白板工具

EditType

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

白板工具

枚举值

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

EditMode

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

是否可编辑

枚举值

类型	说明
READ(0)	只读
EDIT_ALL(2)	可编辑

PlaybackState

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

白板录像回放状态

成员变量

类型	名称
int	IDLE
int	PREPARING
int	PREPARED
int	STARTING
int	PLAYING
int	PAUSE
int	STOPPED

变量说明

IDLE

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

空闲

PREPARING

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

资源准备中

PREPARED

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

资源下载成功，开始解析

STARTING

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

开始播放

PLAYING

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackState.PLAYING = 4;
java

正在播放

PAUSE

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

暂停播放

STOPPED

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackState.STOPPED = 6;
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)	不可用。房间中有用户调用 closeWhiteBoard 关闭白板后，再次进房时，白板状态将为不可用。

ViewMode

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

视图缩放同步选项

枚举值

类型	说明
kBroadcast(0)	视图控制模式。本端的视图设置将同步给其他用户，设置为自由模式的用户除外。同一个白板可以有多个控制方，缩放设置为最近一次调用 API 传入的设置。
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 服务器连接状态。

枚举值

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

WindowConfig

public class com.ss.video.byteboard.model.WindowConfig
java

窗口设置

成员变量

类型	名称
int	RENDER_MODE_FILL
int	RENDER_MODE_FIT
int	RENDER_MODE_HIDDEN
ViewGroup	whiteboardContainer
int	renderMode
float	aspectRatio

变量说明

RENDER_MODE_FILL

public static final int com.ss.video.byteboard.model.WindowConfig.RENDER_MODE_FILL = 0;
java

充满

RENDER_MODE_FIT

public static final int com.ss.video.byteboard.model.WindowConfig.RENDER_MODE_FIT = 1;
java

适应

RENDER_MODE_HIDDEN

public static final int com.ss.video.byteboard.model.WindowConfig.RENDER_MODE_HIDDEN = 2;
java

隐藏

whiteboardContainer

public ViewGroup com.ss.video.byteboard.model.WindowConfig.whiteboardContainer;
java

容器

renderMode

public int com.ss.video.byteboard.model.WindowConfig.renderMode = RENDER_MODE_FILL;
java

渲染模式

aspectRatio

public float com.ss.video.byteboard.model.WindowConfig.aspectRatio = 16f \/ 9;
java

宽高比

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

成员函数

返回	名称
BackgroundInfo	BackgroundInfo
int	getBkColor
void	setBkColor
String	getBkImage
void	setBkImage
ImageSize	getImageSize
void	setImageSize
int	getBkImageFillType
void	setBkImageFillType

变量说明

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。

BackgroundInfo

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

背景信息构造函数

传入参数

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

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	图片大小。见 ImageSize 。

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` 居中放置，不缩放。

BoardInfo

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

白板信息结构体

静态函数

返回	名称
static BoardInfo	createBoardInfo

成员函数

返回	名称
long	getCreateTimestamp
int	getBoardId
String	getBoardName
WhiteBoardDefine.BoardStatus	getBoardStatus

函数说明

createBoardInfo

public static BoardInfo com.ss.video.byteboard.model.page.BoardInfo.createBoardInfo(
    int boardId,
    String boardName,
    int boardStatus,
    long createTimestamp)
java

创建白板信息结构体。

传入参数

参数名	类型	说明
boardId	int	白板 ID
boardName	String	白板名称
boardStatus	int	白板状态
createTimestamp	long	创建时间戳

返回值
返回白板信息结构体

getCreateTimestamp

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

获取白板创建时间戳。

返回值
创建时间戳

getBoardId

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

获取白板 ID。

返回值
白板 ID

getBoardName

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

获取白板名称。

返回值
白板名称

getBoardStatus

public WhiteBoardDefine.BoardStatus com.ss.video.byteboard.model.page.BoardInfo.getBoardStatus()
java

获取白板状态。

返回值
白板状态。详见 BoardStatus。

CursorInfo

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

光标样式

静态函数

返回	名称
static CursorInfo	create

成员函数

返回	名称
CursorInfo	CursorInfo
int	getWidth
void	setWidth
int	getHeight
void	setHeight
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,
    String filePath)
java

光标样式静态函数

传入参数

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

返回值
CursorInfo 结构体

CursorInfo

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

光标样式构造函数

传入参数

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

getWidth

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

获取光标宽度，单位为 px

返回值
光标宽度

setWidth

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

设置光标宽度，单位为 px

返回值
光标宽度

getHeight

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

获取光标高度，单位为 px

返回值
光标高度

setHeight

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

设置光标高度，单位为 px

返回值
光标高度

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(
    int filePath)
java

设置光标资源路径

返回值
光标资源路径

ImageSize

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

图片尺寸

成员变量

类型	名称
int	width
int	height

变量说明

width

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

宽度

height

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

高度

ShapeStyle

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

选择框样式

成员变量

类型	名称
int	MOTION_RECT
int	MOTION_CIRCLE

成员函数

返回	名称
ShapeStyle	ShapeStyle
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)
java

设置选择框样式。

传入参数

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

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

函数说明

create

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

创建页面信息结构体。

传入参数

参数名	类型	说明
pageId	String	页面 ID
extra	String	设置信息
backgroundInfo	BackgroundInfo	页面背景设置。详见 BackgroundInfo。

返回值
返回页面信息结构体

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

获取页面 ID。

返回值
页面 ID

setPageId

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

设置页面 ID。

传入参数

参数名	类型	说明
pageId	String	页面 ID

getExtra

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

获取页面 ID 和背景以外的页面信息。

返回值
Extra 页面信息

setExtra

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

UserCursorInfo

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

光标信息

CursorType

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

光标信息

成员变量

类型	名称
int	kArrow
int	kPen
int	kShape
int	kText
int	kErase
int	kLaserPen

变量说明

kArrow

int com.ss.video.byteboard.model.page.UserCursorInfo.CursorType.kArrow = 0;
java

选择工具

kPen

int com.ss.video.byteboard.model.page.UserCursorInfo.CursorType.kPen = 2;
java

画笔工具

kShape

int com.ss.video.byteboard.model.page.UserCursorInfo.CursorType.kShape = 3;
java

形状绘制工具

kText

int com.ss.video.byteboard.model.page.UserCursorInfo.CursorType.kText = 4;
java

文本工具

kErase

int com.ss.video.byteboard.model.page.UserCursorInfo.CursorType.kErase = 5;
java

橡皮擦工具

kLaserPen

int com.ss.video.byteboard.model.page.UserCursorInfo.CursorType.kLaserPen = 6;
java

激光笔工具