EditConfig

public class com.ss.video.byteboard.config.EditConfig

编辑设置

成员函数

返回	名称
boolean	isBoardEditEnable
boolean	isBoardLocked
void	setBoardLocked
WhiteBoardDefine.EditMode	getEditMode
void	setEditMode
WhiteBoardDefine.EditType	getEditType
void	setEditType
int	getPenColor
void	setPenColor
float	getPenWidth
void	setPenWidth
int	getShapeColor
void	setShapeColor
float	getShapeWidth
void	setShapeWidth
int	getTextColor
void	setTextColor
float	getTextSize
void	setTextSize

函数说明

isBoardEditEnable

public boolean com.ss.video.byteboard.config.EditConfig.isBoardEditEnable()

是否可编辑

返回值 可编辑状态

isBoardLocked

public boolean com.ss.video.byteboard.config.EditConfig.isBoardLocked()

是否锁定

返回值 锁定状态

setBoardLocked

public void com.ss.video.byteboard.config.EditConfig.setBoardLocked(
    boolean boardLocked)

锁定/解锁白板

传入参数

参数名	类型	说明
boardLocked	boolean	锁定状态

getEditMode

public WhiteBoardDefine.EditMode com.ss.video.byteboard.config.EditConfig.getEditMode()

获取编辑模式

返回值 编辑模式

setEditMode

public void com.ss.video.byteboard.config.EditConfig.setEditMode(
    WhiteBoardDefine.EditMode editMode)

设置白板编辑模式

传入参数

参数名	类型	说明
editMode	WhiteBoardDefine.EditMode	编辑模式

getEditType

public WhiteBoardDefine.EditType com.ss.video.byteboard.config.EditConfig.getEditType()

获取编辑类型

返回值 编辑类型

setEditType

public void com.ss.video.byteboard.config.EditConfig.setEditType(
    WhiteBoardDefine.EditType editType)

设置白板编辑类型

传入参数

参数名	类型	说明
editType	WhiteBoardDefine.EditType	编辑类型

getPenColor

public int com.ss.video.byteboard.config.EditConfig.getPenColor()

获取画笔颜色

setPenColor

public void com.ss.video.byteboard.config.EditConfig.setPenColor(
    int penColor)

设置画笔颜色

传入参数

参数名	类型	说明
penColor	int	画笔颜色

getPenWidth

public float com.ss.video.byteboard.config.EditConfig.getPenWidth()

获取画笔宽度

setPenWidth

public void com.ss.video.byteboard.config.EditConfig.setPenWidth(
    float penWidth)

设置画笔宽度

传入参数

参数名	类型	说明
penWidth	float	画笔宽度

getShapeColor

public int com.ss.video.byteboard.config.EditConfig.getShapeColor()

获取形状颜色

setShapeColor

public void com.ss.video.byteboard.config.EditConfig.setShapeColor(
    int shapeColor)

设置形状边框颜色

传入参数

参数名	类型	说明
shapeColor	int	形状边框颜色

getShapeWidth

public float com.ss.video.byteboard.config.EditConfig.getShapeWidth()

获取形状边框宽度

setShapeWidth

public void com.ss.video.byteboard.config.EditConfig.setShapeWidth(
    float shapeWidth)

设置形状边框宽度

传入参数

参数名	类型	说明
shapeWidth	float	形状边框宽度

getTextColor

public int com.ss.video.byteboard.config.EditConfig.getTextColor()

获取文本颜色

setTextColor

public void com.ss.video.byteboard.config.EditConfig.setTextColor(
    int textColor)

设置文本颜色

传入参数

参数名	类型	说明
textColor	int	文本颜色

getTextSize

public float com.ss.video.byteboard.config.EditConfig.getTextSize()

获取文本大小

setTextSize

public void com.ss.video.byteboard.config.EditConfig.setTextSize(
    float textSize)

设置文本大小

传入参数

参数名	类型	说明
textSize	float	文本大小

WhiteBoardDefine

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

白板工具

EditType

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

白板工具

枚举值

类型	说明
PEN(0)	画笔
SHAPE_LINE(1)	直线
SHAPE_ARROW(2)	箭头
SHAPE_RECT(3)	矩形
SHAPE_CIRCLE(4)	圆形
TEXT(5)	文本框
LASER_PEN(7)	激光笔
ERASER(100)	橡皮擦
SELECT(1000)	选择工具，选择图形并重新编辑

EditMode

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

是否可编辑

枚举值

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

PlaybackState

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

白板录像回放状态

成员变量

类型	名称
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;

空闲

PREPARING

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackState.PREPARING = 1; \/\/ 资源准备中

资源准备中

PREPARED

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackState.PREPARED = 2;  \/\/ 资源准备成功

资源下载成功，开始解析

STARTING

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackState.STARTING = 3;  \/\/ 开始播放状态

开始播放

PLAYING

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackState.PLAYING = 4;   \/\/ 播放状态

正在播放

PAUSE

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackState.PAUSE = 5;     \/\/ 暂停播放状态

暂停播放

STOPPED

int com.ss.video.byteboard.constant.WhiteBoardDefine.PlaybackState.STOPPED = 6;   \/\/ 停止状态

停止播放

PlaybackReason

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

白板录像回放状态原因

成员变量

类型	名称
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;

用户主动调用。

PREPARE_FOR_START

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

正在加载资源

PREPARE_FOR_SEEK

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

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

FINISH

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

播放结束，停止播放

ERROR_DATA_EMPTY

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

播放数据为空

ERROR_DATA_ERROR

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

播放数据错误

ERROR_DOWNLOAD_FAIL

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

播放数据下载失败

BoardStatus

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

白板状态

枚举值

类型	说明
kActive(0)	可用
kInActive(1)	不可用

LockBoardReason

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

白板锁定原因

枚举值

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

WindowConfig

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

窗口设置

成员变量

类型	名称
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;

充满

RENDER_MODE_FIT

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

适应

RENDER_MODE_HIDDEN

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

隐藏

whiteboardContainer

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

容器

renderMode

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

渲染模式

aspectRatio

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

宽高比

BackgroundInfo

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

背景信息

成员变量

类型	名称
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;

BG_FILL_TYPE_CENTER

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

BG_FILL_TYPE_HIDDEN

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

函数说明

createBackgroundInfo

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

BackgroundInfo

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

getBkColor

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

setBkColor

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

getBkImage

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

setBkImage

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

getImageSize

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

setImageSize

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

getBkImageFillType

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

setBkImageFillType

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