You need to enable JavaScript to run this app.
文档中心
实时音视频

实时音视频

请输入
  • 文档首页
    • 实时音视频互动白板客户端 API 参考iOS类型详情
复制全文
下载 pdf
我的收藏
iOS
类型详情
复制全文
下载 pdf
我的收藏
类型详情

ByteWhiteBoardAddImage 
typedef NS_ENUM(
    NSInteger,
    ByteWhiteBoardAddImage
)

添加图片返回枚举类型。

枚举值

类型值说明
ByteWhiteBoardAddImageFailure0添加失败。
ByteWhiteBoardAddImageSuccess1添加成功。

ByteWhiteBoardAddMedia 
typedef NS_ENUM(
    NSInteger,
    ByteWhiteBoardAddMedia
)

添加媒体资源返回枚举类型。

枚举值

类型值说明
ByteWhiteBoardAddMediaFailure0添加失败。
ByteWhiteBoardAddMediaSuccess1添加成功。

ByteWhiteBoardConnectionState 
typedef NS_ENUM(
    NSInteger,
    ByteWhiteBoardConnectionState
)

SDK 与 RTC 服务器连接状态。

枚举值

类型值说明
ByteWhiteBoardConnectionStateDisconnected1连接断开，且断开时长超过 12s，SDK 会自动重连。
ByteWhiteBoardConnectionStateConnecting2首次请求建立连接，正在连接中。
ByteWhiteBoardConnectionStateConnected3首次连接成功。
ByteWhiteBoardConnectionStateReconnecting4涵盖了以下情况：
  • 首次连接时，10 秒内未连接成功;
  • 连接成功后，断连 10 秒。自动重连中。
ByteWhiteBoardConnectionStateReconnected5连接断开后，重连成功。
ByteWhiteBoardConnectionStateLost6处于 CONNECTION_STATE_DISCONNECTED 状态超过 10 秒，且期间重连未成功。SDK 仍将继续尝试重连。
ByteWhiteBoardConnectionStateFailed7连接失败，服务端状态异常。SDK 不会自动重连，请重新进房，或联系技术支持。

ByteWhiteBoardShapeType 
typedef NS_ENUM(
    NSInteger,
    ByteWhiteBoardShapeType
)

光标和画笔类型

枚举值

类型值说明
ByteWhiteBoardShapeTypePen0普通画笔
ByteWhiteBoardShapeTypeLine1直线
ByteWhiteBoardShapeTypeArrow2箭头
ByteWhiteBoardShapeTypeRect3矩形
ByteWhiteBoardShapeTypeCircle4圆
ByteWhiteBoardShapeTypeText5文本框
ByteWhiteBoardShapeTypeLaserPen7激光笔
ByteWhiteBoardShapeTypeFluorescentPen8荧光笔
ByteWhiteBoardShapeTypeMagicPen9魔法画笔
ByteWhiteBoardShapeTypeErase100橡皮擦
ByteWhiteBoardShapeTypeSelect1000选择模式
ByteWhiteBoardShapeTypeDrag1001拖拽工具，设置后SDK处理触摸事件实现缩放&平移操作
ByteWhiteBoardFileArrow1002PPT 操作工具。选择这个工具后，可以对 PPT 进行翻页、播放页面上的多媒体等操作。

ByteWhiteBoardFillType 
typedef NS_ENUM(
    NSInteger,
    ByteWhiteBoardFillType
)

背景图片填充方式。

枚举值

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

ByteWhiteBoardEditMode 
typedef NS_ENUM(
    NSInteger,
    ByteWhiteBoardEditMode
)

编辑权限

枚举值

类型值说明
ByteWhiteBoardEditModeReadOnly0只读
ByteWhiteBoardEditModeEditAll1所有人可编辑

ByteWhiteBoardLockBoardReason 
typedef NS_ENUM(
    NSInteger,
    ByteWhiteBoardLockBoardReason
)

锁定原因

枚举值

类型值说明
ByteWhiteBoardLockBoardReasonBoardDataError0数据错误
ByteWhiteBoardLockBoardReasonNetworkCongestion1网络阻塞
ByteWhiteBoardLockBoardReasonNetworkDisconnect2网络断开

ByteWhiteBoardLockBoardElementReason 
typedef NS_ENUM(
    NSInteger,
    ByteWhiteBoardLockBoardElementReason
)

图片加载状态

枚举值

类型值说明
ByteWhiteBoardLockBoardElementReasonLock0元素被锁

ByteWhiteBoardImageLoadStatus 
typedef NS_ENUM(
    NSInteger,
    ByteWhiteBoardImageLoadStatus
)

图片加载状态

枚举值

类型值说明
ByteWhiteBoardImageLoadStatusLoading0加载中。
ByteWhiteBoardImageLoadStatusEnd1加载完成。
ByteWhiteBoardImageLoadStatusError2加载错误。

ByteWhiteBoardBoardStatus 
typedef NS_ENUM(
    NSInteger,
    ByteWhiteBoardBoardStatus
)

白板状态

枚举值

类型值说明
ByteWhiteBoardBoardStatusActive0可用
ByteWhiteBoardBoardStatusInActive1不可用。房间中有用户调用 destroyRoom 关闭白板后，再次进房时，白板状态将为不可用。

ByteWhiteBoardRoomStatus 
typedef NS_ENUM(
    NSInteger,
    ByteWhiteBoardRoomStatus
)

房间状态

枚举值

类型值说明
ByteWhiteBoardRoomStatusActive0正在上课状态
ByteWhiteBoardRoomStatusInActive1下课状态。房间中有用户调用 destroyRoom 下课后，再次进房时，房间状态将为不可用。

ByteWhiteBoardWindowConfigRenderMode 
typedef NS_ENUM(
    NSInteger,
    ByteWhiteBoardWindowConfigRenderMode
)

渲染方式

枚举值

类型值说明
ByteWhiteBoardWindowConfigRenderModeFill0填满窗口
ByteWhiteBoardWindowConfigRenderModeFit1按比例缩放，可能填充不满
ByteWhiteBoardWindowConfigRenderModeHidden2按比例缩放，填充满，白板可能被裁剪

ByteWhiteBoardCursorType 
typedef NS_ENUM(
    NSInteger,
    ByteWhiteBoardCursorType
)

自定义光标类型

枚举值

类型值说明
ByteWhiteBoardCursorTypePointer0鼠标选择工具
ByteWhiteBoardCursorTypePen2画笔工具。画笔的设置接口如下。
ByteWhiteBoardCursorTypeShape3形状绘制工具。形状的设置接口如下。
ByteWhiteBoardCursorTypeText4文本工具。文本的设置接口如下。
ByteWhiteBoardCursorTypeErase5橡皮擦工具
ByteWhiteBoardCursorTypeLaser6激光笔工具

ByteWhiteBoardMotionType 
typedef NS_ENUM(
    NSInteger,
    ByteWhiteBoardMotionType
)

锚点形状

枚举值

类型值说明
ByteWhiteBoardMotionTypeRect0矩形
ByteWhiteBoardMotionTypeCircle1圆形

ByteWhiteBoardWindowConfig 
WHITE_BOARD_EXPORT @interface ByteWhiteBoardWindowConfig : NSObject

窗口配置

成员变量

类型名称
UIView*view
ByteWhiteBoardWindowConfigRenderModerenderMode
floataspectRatio

变量说明

view 

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

视图

renderMode 

@property (nonatomic, assign) ByteWhiteBoardWindowConfigRenderMode renderMode;

渲染方式

aspectRatio 

@property (nonatomic, assign) float aspectRatio;

显示比例(长/宽)

ByteWhiteBoardViewMode 
typedef NS_ENUM(
    NSInteger,
    ByteWhiteBoardViewMode
)

视图模式

枚举值

类型值说明
ByteWhiteBoardViewModeCast0视角设置者
ByteWhiteBoardViewModeFollow1视角跟随者
ByteWhiteBoardViewModeFree2自由模式

ByteWhiteBoardBackgroundInfo 
WHITE_BOARD_EXPORT @interface ByteWhiteBoardBackgroundInfo : NSObject

页面配置

成员变量

类型名称
UIColor*bkColor
NSString*bkImage
CGSizebkImageSize
ByteWhiteBoardFillTypebkImageFillType

变量说明

bkColor 

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

背景颜色

bkImage 

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

背景图片

bkImageSize 

@property (nonatomic, assign) CGSize bkImageSize;

背景图片尺寸

bkImageFillType 

@property (nonatomic, assign) ByteWhiteBoardFillType bkImageFillType;

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

ByteWhiteBoardZoomInfo 
WHITE_BOARD_EXPORT @interface ByteWhiteBoardZoomInfo : NSObject

视图缩放信息

成员变量

类型名称
CGFloatzoom
intcenterX
intcenterY

变量说明

zoom 

@property (nonatomic, assign) CGFloat zoom;

放大倍数

centerX 

@property (nonatomic, assign) int centerX;

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

centerY 

@property (nonatomic, assign) int centerY;

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

ByteWhiteBoardPageInfo 
WHITE_BOARD_EXPORT @interface ByteWhiteBoardPageInfo : NSObject

页面信息

成员变量

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

变量说明

pageID 

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

页面唯一标识。传空值时，将自动生成 ID。

bkInfo 

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

背景设置，详见 ByteWhiteBoardBackgroundInfo

extraMsg 

@property (nonatomic, strong) NSString *_Nullable extraMsg; //(最大512字节)

附加信息，最大 512 字节

ByteWhiteBoardInfo 
WHITE_BOARD_EXPORT @interface ByteWhiteBoardInfo : NSObject

白板信息

成员变量

类型名称
NSIntegerboardID
NSString*boardName
NSArray<ByteWhiteBoardPageInfo*>*pageInfos
NSString*currentBoardID
ByteWhiteBoardBackgroundInfo*backgroundInfo
ByteWhiteBoardBoardStatusboradStatus
ByteWhiteBoardZoomInfo*zoomInfo
NSIntegercreateTime

变量说明

boardID 

@property (nonatomic, assign) NSInteger boardID;

白板 ID

boardName 

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

白板名字

pageInfos 

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

白板内所有页的信息

currentBoardID 

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

当前页ID

backgroundInfo 

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

当前白板背景信息

boradStatus 

@property (nonatomic, assign) ByteWhiteBoardBoardStatus boradStatus;

当前白板状态

zoomInfo 

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

视图缩放信息

createTime 

@property (nonatomic, assign) NSInteger createTime;

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

ByteWhiteBoardAnchor 
WHITE_BOARD_EXPORT @interface ByteWhiteBoardAnchor : NSObject

选择框样式

成员变量

类型名称
ByteWhiteBoardMotionTypetype
intanchorWidth
intanchorBorderWidth
intanchorBorderColor
intanchorFillColor
intborderWidth
intborderColor
NSString*rotateIcon
introtateDistance

变量说明

type 

@property (nonatomic, assign) ByteWhiteBoardMotionType type;

锚点形状

anchorWidth 

@property (nonatomic, assign) int anchorWidth;

锚点宽度

anchorBorderWidth 

@property (nonatomic, assign) int anchorBorderWidth;

锚点边框线条宽度

anchorBorderColor 

@property (nonatomic, assign) int  anchorBorderColor;

锚点边框颜色

anchorFillColor 

@property (nonatomic, assign) int  anchorFillColor;

锚点填充颜色

borderWidth 

@property (nonatomic, assign) int borderWidth;

选择框宽度

borderColor 

@property (nonatomic, assign) int borderColor;

选择框颜色

rotateIcon 

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

旋转手柄图标资源地址

rotateDistance 

@property (nonatomic, assign) int  rotateDistance;

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

ByteWhiteBoardCursorInfo 
WHITE_BOARD_EXPORT @interface ByteWhiteBoardCursorInfo : NSObject

光标样式

成员变量

类型名称
intcenterX
intcenterY
NSString*iconPath

变量说明

centerX 

@property (nonatomic, assign) int centerX;

光标中心点 X 坐标

centerY 

@property (nonatomic, assign) int centerY;

光标中心点 Y 坐标

iconPath 

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

icon 资源地址

ByteWhiteBoardImageRect 
WHITE_BOARD_EXPORT @interface ByteWhiteBoardImageRect : NSObject

图片位置信息

成员变量

类型名称
int*width
int*height
int*left
int*top

变量说明

width 

@property (nonatomic, assign) int *_Nullable width;

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

height 

@property (nonatomic, assign) int *_Nullable height;

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

left 

@property (nonatomic, assign) int *_Nullable left;

X 轴坐标

top 

@property (nonatomic, assign) int *_Nullable top;

Y 轴坐标

ByteWhiteBoardPptInfo 
WHITE_BOARD_EXPORT @interface ByteWhiteBoardPptInfo : NSObject

PPT 白板信息

成员变量

类型名称
NSString*fileId
NSString*title
NSString*customArgs

变量说明

fileId 

@property (nonatomic, strong) NSString * _Nonnull fileId;

PPT 的 ID。 在 Web 端调用 createTranscodeTask 或服务端调用 WbTranscodeCreate，传入 PPT 的 URL 地址，获取到 fileId。

title 

@property (nonatomic, strong) NSString * _Nonnull title;

PPT 的名称

customArgs 

@property (nonatomic, strong) NSString * _Nonnull customArgs;

业务层自定义参数

ByteWhiteBoardZoomOperation 
WHITE_BOARD_EXPORT @interface ByteWhiteBoardZoomOperation : NSObject

手势缩放拖拽配置信息

成员变量

类型名称
boolenableTouchZoom

变量说明

enableTouchZoom 

@property (nonatomic, assign) bool enableTouchZoom;

是否允许双指缩放，双指移动，默认 true

最近更新时间：2026.07.27 16:16:33
这个页面对您有帮助吗？
有用
有用
无用
无用