ByteWhiteBoardConnectionState

typedef NS_ENUM(NSInteger, ByteWhiteBoardConnectionState)
objectivec

SDK 与 RTC 服务器连接状态。

枚举值

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

ByteWhiteBoardShapeType

typedef NS_ENUM(NSInteger, ByteWhiteBoardShapeType)
objectivec

光标和画笔类型

枚举值

类型	值	说明
ByteWhiteBoardShapeTypePen	0	普通画笔
ByteWhiteBoardShapeTypeLine	1	直线
ByteWhiteBoardShapeTypeArrow	2	箭头
ByteWhiteBoardShapeTypeRect	3	矩形
ByteWhiteBoardShapeTypeCircle	4	圆
ByteWhiteBoardShapeTypeText	5	文本框
ByteWhiteBoardShapeTypeLaserPen	7	激光笔
ByteWhiteBoardShapeTypeFluorescentPen	8	荧光笔
ByteWhiteBoardShapeTypeMagicPen	9	魔法画笔
ByteWhiteBoardShapeTypeErase	100	橡皮擦
ByteWhiteBoardShapeTypeSelect	1000	选择模式
ByteWhiteBoardShapeTypeDrag	1001	拖拽工具，屏幕触摸事件触发平移操作，缩放手势事件触发视图缩放。

ByteWhiteBoardFillType

typedef NS_ENUM(NSInteger, ByteWhiteBoardFillType)
objectivec

背景图片填充方式。

枚举值

类型	值	说明
ByteWhiteBoardFillTypeFill	0	平铺窗口，按照白板比例缩放图片进行填充。
ByteWhiteBoardFillTypeCenter	1	居中放置，不缩放。
ByteWhiteBoardFillTypeHidden	2	等比例缩放，如果画布和图片比例不一致，将对图片进行裁切。

ByteWhiteBoardEditMode

typedef NS_ENUM(NSInteger, ByteWhiteBoardEditMode)
objectivec

编辑权限

枚举值

类型	值	说明
ByteWhiteBoardEditModeReadOnly	0	只读
ByteWhiteBoardEditModeEditSelf	1	仅当前用户可编辑
ByteWhiteBoardEditModeEditAll	2	所有人可编辑

ByteWhiteBoardLockBoardReason

typedef NS_ENUM(NSInteger, ByteWhiteBoardLockBoardReason)
objectivec

锁定原因

枚举值

类型	值	说明
ByteWhiteBoardLockBoardReasonBoardDataError	0	数据错误
ByteWhiteBoardLockBoardReasonNetworkCongestion	1	网络阻塞
ByteWhiteBoardLockBoardReasonNetworkDisconnect	2	网络断开

ByteWhiteBoardBoardStatus

typedef NS_ENUM(NSInteger, ByteWhiteBoardBoardStatus)
objectivec

白板状态

枚举值

类型	值	说明
ByteWhiteBoardBoardStatusActive	0	可用
ByteWhiteBoardBoardStatusInActive	1	不可用。房间中有用户调用 closeWhiteBoard: 关闭白板后，再次进房时，白板状态将为不可用。

ByteWhiteBoardWindowConfigRenderMode

typedef NS_ENUM(NSInteger, ByteWhiteBoardWindowConfigRenderMode)
objectivec

渲染方式

枚举值

类型	值	说明
ByteWhiteBoardWindowConfigRenderModeFill	0	填满窗口
ByteWhiteBoardWindowConfigRenderModeFit	1	按比例缩放，可能填充不满
ByteWhiteBoardWindowConfigRenderModeHidden	2	按比例缩放，填充满，白板可能被裁剪

ByteWhiteBoardCursorType

typedef NS_ENUM(NSInteger, ByteWhiteBoardCursorType)
objectivec

自定义光标类型

枚举值

类型	值	说明
ByteWhiteBoardCursorTypeNormal	0	鼠标选择工具
ByteWhiteBoardCursorTypePen	2	画笔工具。画笔的设置接口如下。 + 调用 setPenSize: 设置笔尖宽度。 + 调用 setPenColor: 设置画笔颜色。
ByteWhiteBoardCursorTypeShape	3	形状绘制工具。形状的设置接口如下。 + 调用 setShapeWidth: 设置边框线条宽度。 + 调用 setShapeColor: 设置边框线条颜色。
ByteWhiteBoardCursorTypeText	4	文本工具。文本的设置接口如下。 + 调用 setTextFontSize: 设置文字高度。 + 调用 setTextColor: 设置文字颜色。
ByteWhiteBoardCursorTypeErase	5	橡皮擦工具
ByteWhiteBoardCursorTypeLaser	6	激光笔工具

ByteWhiteBoardMotionType

typedef NS_ENUM(NSInteger, ByteWhiteBoardMotionType)
objectivec

锚点形状

枚举值

类型	值	说明
ByteWhiteBoardMotionTypeRect	0	矩形
ByteWhiteBoardMotionTypeCircle	1	圆形

ByteWhiteBoardViewMode

typedef NS_ENUM(NSInteger, ByteWhiteBoardViewMode)
objectivec

视图缩放同步选项

枚举值

类型	值	说明
ByteWhiteBoardViewModeCast	0	视图控制模式。本端的视图设置将同步给其他用户，设置为自由模式的用户除外。同一个白板可以有多个控制方，缩放设置为最近一次调用 API 传入的设置。
ByteWhiteBoardViewModeFollow	1	视图跟随模式
ByteWhiteBoardViewModeFree	2	自由模式，不跟随其他用户的视图缩放设置。同时本地的视图缩放设置也不会影响到设置为跟随的用户。

ByteWhiteBoardWindowConfig

@interface ByteWhiteBoardWindowConfig : NSObject
objectivec

窗口配置

成员变量

类型	名称
UIView*	view
ByteWhiteBoardWindowConfigRenderMode	renderMode
float	aspectRatio

变量说明

view

@property (nonatomic, strong) UIView * view;
objectivec

视图

renderMode

@property (nonatomic, assign) ByteWhiteBoardWindowConfigRenderMode renderMode;
objectivec

渲染方式

aspectRatio

@property (nonatomic, assign) float aspectRatio;
objectivec

显示比例(长/宽)

ByteWhiteBoardBackgroundInfo

@interface ByteWhiteBoardBackgroundInfo : NSObject
objectivec

页面配置

成员变量

类型	名称
UIColor*	bkColor
NSString*	bkImage
CGSize	bkImageSize
ByteWhiteBoardFillType	bkImageFillType

变量说明

bkColor

@property (nonatomic, strong) UIColor* bkColor;
objectivec

背景颜色

bkImage

@property (nonatomic, strong) NSString * bkImage;
objectivec

背景图片

bkImageSize

@property (nonatomic, assign) CGSize bkImageSize;
objectivec

背景图片尺寸

bkImageFillType

@property (nonatomic, assign) ByteWhiteBoardFillType bkImageFillType;
objectivec

背景图片填充方式。详见 ByteWhiteBoardFillType。

ByteWhiteBoardZoomInfo

@interface ByteWhiteBoardZoomInfo : NSObject
objectivec

屏幕信息

成员变量

类型	名称
CGFloat	zoom
int	centerX
int	centerY

变量说明

zoom

@property (nonatomic, assign) CGFloat zoom;
objectivec

放大倍数

centerX

@property (nonatomic, assign) int centerX;
objectivec

距离原点X方向上的偏移（以白板右方为正方向）

centerY

@property (nonatomic, assign) int centerY;
objectivec

距离原点Y方向上的偏移（以白板下方为正方向）

ByteWhiteBoardPageInfo

@interface ByteWhiteBoardPageInfo : NSObject
objectivec

页面信息

成员变量

类型	名称
NSString*	pageID
ByteWhiteBoardBackgroundInfo*	bkInfo
NSString*	extraMsg

变量说明

pageID

@property (nonatomic, strong) NSString* pageID;
objectivec

页面 ID

bkInfo

@property (nonatomic, strong) ByteWhiteBoardBackgroundInfo* bkInfo;
objectivec

背景设置，详见 ByteWhiteBoardBackgroundInfo

extraMsg

@property (nonatomic, strong) NSString * extraMsg;
objectivec

附加信息，最大 512 字节

ByteWhiteBoardInfo

@interface ByteWhiteBoardInfo : NSObject
objectivec

白板信息

成员变量

类型	名称
NSInteger	boardID
NSString*	boardName
NSArray<ByteWhiteBoardPageInfo>**	pageInfos
NSString*	currentBoardID
ByteWhiteBoardBackgroundInfo*	backgroundInfo
ByteWhiteBoardBoardStatus	boradStatus
ByteWhiteBoardZoomInfo*	zoomInfo
NSInteger	createTimestamp

变量说明

boardID

@property (nonatomic, assign) NSInteger boardID;
objectivec

白板 ID

boardName

@property (nonatomic, strong) NSString* boardName;
objectivec

白板名字

pageInfos

@property (nonatomic, strong) NSArray<ByteWhiteBoardPageInfo *>* pageInfos;
objectivec

白板内所有页的信息

currentBoardID

@property (nonatomic, strong) NSString* currentBoardID;
objectivec

当前页面 ID

backgroundInfo

@property (nonatomic, strong) ByteWhiteBoardBackgroundInfo* backgroundInfo;
objectivec

当前白板背景信息

boradStatus

@property (nonatomic, assign) ByteWhiteBoardBoardStatus boradStatus;
objectivec

当前白板状态

zoomInfo

@property (nonatomic, strong) ByteWhiteBoardZoomInfo *zoomInfo;
objectivec

当前白板屏幕信息

createTimestamp

@property (nonatomic, assign) NSInteger createTimestamp;
objectivec

当前白板创建时间

ByteWhiteBoardAnchor

@interface ByteWhiteBoardAnchor : NSObject
objectivec

选择框样式

成员变量

类型	名称
ByteWhiteBoardMotionType	type
int	anchorWidth
int	anchorBorderWidth
int	anchorBorderColor
int	anchorFillColor
int	borderWidth
int	borderColor
NSString*	rotateIcon
int	rotateDistance

变量说明

type

@property (nonatomic, assign) ByteWhiteBoardMotionType type;
objectivec

锚点形状

anchorWidth

@property (nonatomic, assign) int anchorWidth;
objectivec

锚点宽度

anchorBorderWidth

@property (nonatomic, assign) int anchorBorderWidth;
objectivec

锚点边框线条宽度

anchorBorderColor

@property (nonatomic, assign) int  anchorBorderColor;
objectivec

锚点边框颜色

anchorFillColor

@property (nonatomic, assign) int  anchorFillColor;
objectivec

锚点填充颜色

borderWidth

@property (nonatomic, assign) int borderWidth;
objectivec

选择框宽度

borderColor

@property (nonatomic, assign) int borderColor;
objectivec

选择框颜色

rotateIcon

@property (nonatomic, strong) NSString * rotateIcon;
objectivec

旋转手柄图标资源地址

rotateDistance

@property (nonatomic, assign) int  rotateDistance;
objectivec

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

ByteWhiteBoardCursorInfo

@interface ByteWhiteBoardCursorInfo : NSObject
objectivec

光标样式

成员变量

类型	名称
int	width
int	height
int	centerX
int	centerY
NSString*	iconPath

变量说明

width

@property (nonatomic, assign) int width;
objectivec

光标宽度

height

@property (nonatomic, assign) int height;
objectivec

光标高度

centerX

@property (nonatomic, assign) int centerX;
objectivec

光标中心点 X 坐标

centerY

@property (nonatomic, assign) int centerY;
objectivec

光标中心点 Y 坐标

iconPath

@property (nonatomic, copy) NSString * iconPath;
objectivec

icon 资源地址