Agora Interactive Whiteboard Java API Reference

2.16.134 当前 API

Whiteboard Android SDK2.16.134公共 API 参考。
内嵌运行时：white-web-sdk 2.16.59、window-manager 1.0.25、appliance-plugin 1.1.45、app-slide 0.2.108。

类型	说明
com.herewhite.sdk.AbstractCommonCallbacks	CommonCallbacks接口的缺省（空）实现。详见 CommonCallbacks。
com.herewhite.sdk.AbstractConverterCallbacks	空实现类由用户应用处理
com.herewhite.sdk.AbstractPlayerEventListener	PlayerEventListener接口的缺省（空）实现。详见 PlayerEventListener。
com.herewhite.sdk.AbstractRoomCallbacks	RoomCallbacks 接口的缺省（空）实现。
com.herewhite.sdk.AudioEffectBridge	音效桥接接口。
com.herewhite.sdk.AudioEffectImplement	音效桥接接口的实现类。
com.herewhite.sdk.AudioMixerBridge	AudioMixerBridge接口，用于桥接 Agora RTC SDK 的混音方法和白板 SDK。
com.herewhite.sdk.AudioMixerImplement	AudioMixerImplement类，用于实现混音。
com.herewhite.sdk.CommonCallback	CommonCallback，用于 SDK 向 app 发送回调事件通知。
com.herewhite.sdk.CommonCallbacks	通用回调，用于 SDK 向 app 发送回调事件通知
com.herewhite.sdk.Converter	文档转换类。
com.herewhite.sdk.Converter.ConvertType	文档转换类型。
com.herewhite.sdk.ConverterCallbacks	文档转换事件回调接口。
com.herewhite.sdk.Displayer	Displayer类。该类为 Room 类和 Player 类的父类。
com.herewhite.sdk.JsBridgeInterface	Java 与 JavaScript 之间的桥接接口。
com.herewhite.sdk.Player	Player类，用于操作白板的回放。
com.herewhite.sdk.PlayerEventListener	回放房间的事件回调接口。
com.herewhite.sdk.PlayerListener	白板回放的事件回调接口。
com.herewhite.sdk.ResultCaller	调用结果回调接口。
com.herewhite.sdk.Room	Room类，用于操作互动白板实时房间。
com.herewhite.sdk.RoomCallbacks	房间事件回调接口。
com.herewhite.sdk.RoomListener	房间事件回调接口。
com.herewhite.sdk.RoomParams	RoomParams类，用于配置实时房间的参数。
com.herewhite.sdk.SyncedStore	业务数据的同步存储类。
com.herewhite.sdk.SyncedStore.OnStateChangedListener	同步存储状态变化监听接口。
com.herewhite.sdk.WhiteSdk	WhiteSdk类。
com.herewhite.sdk.WhiteSdk.Builder	WhiteSdk 实例构建器。
com.herewhite.sdk.WhiteSdkConfiguration	WhiteSdk实例的配置。
com.herewhite.sdk.WhiteSdkConfiguration.RenderEngineType	白板上绘画的渲染模式。
com.herewhite.sdk.WhiteSdkConfiguration.PptParams	PptParams类，用于设置动态 PPT 参数。
com.herewhite.sdk.WhiteSdkConfiguration.SlideAppOptions	动态 PPT 播放器配置。
com.herewhite.sdk.WhiteboardView	WhiteboardView类，用于配置白板界面。
com.herewhite.sdk.WhiteboardViewOptions	WhiteboardViewOptions类，用于配置 WhiteboardView 的初始化选项。
com.herewhite.sdk.combinePlayer.NativePlayer	NativePlayer接口。
com.herewhite.sdk.combinePlayer.PlayerSyncManager	PlayerSyncManager类，用于同步NativePlayer和Player的状态。
com.herewhite.sdk.combinePlayer.PlayerSyncManager.Callbacks	Callbacks接口，用于监听PlayerSyncManager对象的事件。
com.herewhite.sdk.converter.ConvertType	文档转换类型。
com.herewhite.sdk.converter.ConverterV5	文档转换类，接入方式参见使用文档转换服务。
com.herewhite.sdk.converter.ConverterV5.Builder	文档转换实例构建器。
com.herewhite.sdk.converter.ImageFormat	文档转换输出的图片格式。
com.herewhite.sdk.converter.ProjectorQuery	文档转换任务查询类。
com.herewhite.sdk.converter.ProjectorQuery.ConversionStatus	转换任务状态。
com.herewhite.sdk.converter.ProjectorQuery.Image	转换结果的图片信息。
com.herewhite.sdk.converter.ProjectorQuery.Callback	转换任务查询回调接口。
com.herewhite.sdk.converter.ProjectorQuery.Builder	转换任务查询实例构建器。
com.herewhite.sdk.converter.ProjectorQuery.QueryResponse	转换任务查询结果。
com.herewhite.sdk.domain.AddPageParam	新增主白板页面的参数。
com.herewhite.sdk.domain.AkkoEvent	AkkoEvent类，用于设置自定义事件。
com.herewhite.sdk.domain.AnimationMode	移动或缩放视角时的动画模式。
com.herewhite.sdk.domain.AppState	窗口应用状态，包含焦点应用 ID 和应用 ID 列表。
com.herewhite.sdk.domain.Appliance	白板工具名称。
com.herewhite.sdk.domain.ApplianceInitLoadingChangeEvent	教具插件初始化进度事件。
com.herewhite.sdk.domain.AppliancePluginOptions	教具插件配置。
com.herewhite.sdk.domain.AssetsHttpsOptions	本地资源 HTTPS 加载配置。
com.herewhite.sdk.domain.BackgroundImageLoadEvent	背景图加载事件。
com.herewhite.sdk.domain.BackgroundImageLoadOptions	背景图加载及重试配置。
com.herewhite.sdk.domain.BroadcastState	视角状态，包含视角为主播模式的用户信息。
com.herewhite.sdk.domain.CameraBound	CameraBound类，用于设置视角边界。
com.herewhite.sdk.domain.CameraConfig	CameraConfig类，用于配置视角参数。
com.herewhite.sdk.domain.CameraState	CameraState类，描述视角状态。
com.herewhite.sdk.domain.ConnectionPrepareParam	ConnectionPrepareParam, 定义白板房间连接准备参数。
com.herewhite.sdk.domain.ContentModeConfig	ContentModeConfig类，设置视角边界的缩放模式和缩放比例。
com.herewhite.sdk.domain.ContentModeConfig.ScaleMode	视角边界的缩放模式。
com.herewhite.sdk.domain.ConversionInfo	文档转换信息。
com.herewhite.sdk.domain.ConversionInfo.ServerConversionStatus	服务端文档转换状态。
com.herewhite.sdk.domain.ConvertErrorCode	文档转换错误码。
com.herewhite.sdk.domain.ConvertException	文档转换异常。
com.herewhite.sdk.domain.ConvertedFiles	文档转换结果文件信息。
com.herewhite.sdk.domain.ConverterStatus	文档转换状态。
com.herewhite.sdk.domain.DeviceType	设备类型。
com.herewhite.sdk.domain.DispatchDocsEventResult	文档操作命令的接收结果，包含是否接收及拒绝原因。
com.herewhite.sdk.domain.EventEntry	EventEntry类，用于获取自定义事件。
com.herewhite.sdk.domain.EventListener	EventListener接口类，用于监听自定义事件。
com.herewhite.sdk.domain.FontFace	字体配置文件，与 CSS 中的 FontFace 属性对应。
com.herewhite.sdk.domain.FrameError	白板运行错误信息。
com.herewhite.sdk.domain.FrequencyEventListener	FrequencyEventListener接口类。该类包含你想要注册监听的高频事件回调。
com.herewhite.sdk.domain.GlobalState	房间全局状态类。
com.herewhite.sdk.domain.HasBackgroundImageParams	查询指定白板、场景和 URL 是否已有背景图。
com.herewhite.sdk.domain.ImageInformation	图片信息。
com.herewhite.sdk.domain.ImageInformationWithUrl	图片的位置和尺寸信息及图片的 URL 地址。
com.herewhite.sdk.domain.LinearTransformationDescription	线性变换参数。
com.herewhite.sdk.domain.LocalLogOptions	WebView 内本地日志配置。
com.herewhite.sdk.domain.LoggerOptions	输出日志选项。
com.herewhite.sdk.domain.LoggerOptions.Level	日志等级。
com.herewhite.sdk.domain.LoggerOptions.ReportMode	上报模式。
com.herewhite.sdk.domain.MemberInformation	MemberInformation类，用于自定义用户信息。
com.herewhite.sdk.domain.MemberState	MemberState类，用于设置互动白板实时房间的白板工具状态。
com.herewhite.sdk.domain.PageScaleRange	相对适配尺寸的页面缩放范围。
com.herewhite.sdk.domain.PageState	页面状态。
com.herewhite.sdk.domain.PlayerConfiguration	PlayerConfiguration类，用于配置白板回放房间实例。
com.herewhite.sdk.domain.PlayerObserverMode	白板回放的查看模式。
com.herewhite.sdk.domain.PlayerPhase	白板回放的阶段。
com.herewhite.sdk.domain.PlayerState	白板回放的状态。
com.herewhite.sdk.domain.PlayerTimeInfo	白板回放的播放时间信息。
com.herewhite.sdk.domain.Point	Point类，用于描述世界坐标系（以白板初始化时的中心点为原点的坐标系）中的点。
com.herewhite.sdk.domain.PptPage	PptPage类，用于配置待插入场景的图片或动态 PPT 页的参数。
com.herewhite.sdk.domain.PresentationAppOptions	Presentation 静态课件配置。
com.herewhite.sdk.domain.PresentationViewport	Presentation 视口的位置与尺寸。
com.herewhite.sdk.domain.Promise	异步回调接口。
com.herewhite.sdk.domain.RectangleConfig	RectangleConfig类，用于配置白板的视觉矩形。
com.herewhite.sdk.domain.Region	数据中心。
com.herewhite.sdk.domain.ReloadBackgroundImageParams	重新加载背景图的参数。
com.herewhite.sdk.domain.ReloadBackgroundImageResult	重新加载背景图的结果。
com.herewhite.sdk.domain.RemovePageParam	移除主白板页面的参数。
com.herewhite.sdk.domain.RoomMember	RoomMember类，用于获取实时房间内互动模式（具有读写权限）用户信息。
com.herewhite.sdk.domain.RoomOptimizeOptions	白板渲染优化配置项。
com.herewhite.sdk.domain.RoomPhase	房间连接状态。
com.herewhite.sdk.domain.RoomState	房间状态类。
com.herewhite.sdk.domain.SDKError	SDK 操作错误信息。
com.herewhite.sdk.domain.Scene	场景类。
com.herewhite.sdk.domain.SceneState	场景状态。
com.herewhite.sdk.domain.ShapeType	图形工具。
com.herewhite.sdk.domain.SlideErrorType	动态 PPT 错误类型。
com.herewhite.sdk.domain.SlideInvisibleBehavior	动态 PPT 不可见时的行为。
com.herewhite.sdk.domain.SlideNavigationButtonMode	Slide 底部前后导航按钮的行为，不影响其他翻页入口。
com.herewhite.sdk.domain.SlidePageState	动态 PPT 的页码和总页数。
com.herewhite.sdk.domain.SlideSyncEventQueuePolicy	动态 PPT 同步事件队列策略。
com.herewhite.sdk.domain.StrokeType	图形工具。
com.herewhite.sdk.domain.SyncedState	同步状态数据类。
com.herewhite.sdk.domain.UnifiedPageState	主白板或课件的统一页面状态。
com.herewhite.sdk.domain.UnifiedPageStateChange	统一页码、缩放状态变化或命令执行失败事件。
com.herewhite.sdk.domain.UrlInterrupter	该接口已废弃。请使用 CommonCallback 中的 urlInterrupter 方法。
com.herewhite.sdk.domain.ViewMode	视角模式。
com.herewhite.sdk.domain.WhiteDisplayerState	WhiteDisplayerState类，为互动白板实时房间和回放房间共有的状态类。
com.herewhite.sdk.domain.WhiteObject	提供 JSON 序列化能力的白板数据基类。
com.herewhite.sdk.domain.WhiteScenePathType	白板场景的路径类型。
com.herewhite.sdk.domain.WhiteSlideCustomLink	Slide 自定义链接
com.herewhite.sdk.domain.WindowAppParam	添加窗口应用的参数。
com.herewhite.sdk.domain.WindowAppParam.ProjectorOptions	文档窗口配置。
com.herewhite.sdk.domain.WindowAppParam.ProjectorAttributes	文档窗口属性。
com.herewhite.sdk.domain.WindowAppParam.Options	窗口应用配置。
com.herewhite.sdk.domain.WindowAppParam.Attributes	窗口应用属性。
com.herewhite.sdk.domain.WindowAppSyncAttrs	窗口应用同步属性。
com.herewhite.sdk.domain.WindowDocsEvent	统一文档操作命令。
com.herewhite.sdk.domain.WindowDocsEvent.Options	统一文档操作参数。
com.herewhite.sdk.domain.WindowOriginSize	主白板或课件的书写参考尺寸。
com.herewhite.sdk.domain.WindowPageStateOptions	指定主白板或具体课件应用的页面状态查询参数。
com.herewhite.sdk.domain.WindowParams	多窗口配置。
com.herewhite.sdk.domain.WindowPrefersColorScheme	窗口首选配色方案。
com.herewhite.sdk.domain.WindowRegisterAppParams	自定义窗口应用注册参数。
com.herewhite.sdk.window.SlideListener	动态 PPT 事件监听接口。
com.herewhite.sdk.window.UnifiedPageStateListener	统一页码、缩放状态及命令失败监听接口。

声网通过全球部署的虚拟网络，提供可以灵活搭配的 API 组合，提供稳定可靠、功能丰富的实时互动白板。

• WhiteSdk类提供初始化互动白板 SDK、加入互动白板实时房间、创建白板回放的主要方法。

• Room类提供管理互动白板实时房间的方法。

• Player类提供控制白板回放的方法。

• Displayer类为Room类和Player类的父类。Room和Player实例都可以调用该类中的方法。

SDK 初始化

方法	描述
WhiteSdk[1/4]	初始化WhiteSdk实例
WhiteSdk[2/4]	初始化WhiteSdk实例（设置回调）
WhiteSdk[4/4]	初始化WhiteSdk实例（设置回调和混音）
setCommonCallbacks	设置通用事件回调
joinRoom[1/2]	加入互动白板实时房间
joinRoom[2/2]	加入互动白板实时房间并设置房间事件回调
createPlayer[1/2]	创建互动白板回放房间
createPlayer[2/2]	创建互动白板回放房间并设置回放事件回调
isPlayable	查看房间是否有回放数据
setupFontFaces	声明在本地白板中可用的字体
loadFontFaces	声明并预加载在本地白板中可用的字体
updateTextFont	设置在本地白板中输入文字时使用的字体
releaseRoom[2/2]	释放互动白板实时房间实例并删除RoomListener回调。
releasePlayer[1/2]	释放回放房间实例并删除PlayerListener回调。
Version	查询 SDK 版本号

通用事件

事件	描述
throwError	出现未捕获的全局错误回调
urlInterrupter	拦截图片 URL 回调
onPPTMediaPlay	动态 PPT 中的音视频开始播放回调
onPPTMediaPause	动态 PPT 中的音视频暂停播放回调
onMessage	接收到网页发送的消息回调
sdkSetupFail	SDK 初始化失败回调

实时房间管理

方法	描述
getObserverId	获取用户 ID
setWritable	设置用户是否为互动模式
disableOperations	允许/禁止白板响应用户任何操作
disconnect	断开连接
setGlobalState	修改房间的全局状态
getDisconnectedBySelf	获取用户是否主动断开连接
getWritable	获取用户是否为互动模式
getGlobalState[1/2]	获取房间的全局状态（同步方法）
getGlobalState[2/2]	获取房间的全局状态（异步方法）
getRoomMembers[1/2]	获取房间的用户列表（同步方法）
getRoomMembers[2/2]	获取房间的用户列表（异步方法）
getRoomPhase[1/2]	获取房间的连接状态（同步方法）
getRoomPhase[2/2]	获取房间的连接状态（异步方法）
getRoomState[1/2]	获取房间的所有状态（同步方法）
getRoomState[2/2]	获取房间的所有状态（异步方法）

白板工具设置

方法	描述
setMemberState	修改房间的白板工具状态
getMemberState[1/2]	获取白板工具状态（同步方法）
getMemberState[2/2]	获取白板工具状态（异步方法）
copy	复制选中内容
paste	粘贴复制的内容
duplicate	复制并粘贴选中的内容
deleteOperation	删除选中的内容
disableSerialization	开启/禁止本地序列化
redo	重做
undo	撤销上一步操作
disableEraseImage	关闭/开启橡皮擦擦除图片功能
disableDeviceInputs	禁止/允许用户操作白板工具

视角操作

方法	描述
setViewMode	切换视角模式
setCameraBound	设置视角边界
disableCameraTransform	禁止/允许用户调整视角
moveCamera	调整视角
moveCameraToContainer	调整视角以完整显示视觉矩形中的内容
scalePptToFit	调整视角以完整显示 PPT 的内容（渐变模式）
scalePptToFit	调整视角以完整显示 PPT 的内容（指定动画模式）
scaleIframeToFit	调整视角以完整显示 H5 课件的内容
disableCameraTransform	禁止/允许用户调整（移动或缩放）视角
getBroadcastState[1/2]	获取用户的视角状态（同步方法）
getBroadcastState[2/2]	获取用户的视角状态（异步方法）

场景管理

方法	描述
insertImage[1/2]	插入图片占位符
completeImageUpload	展示图片
insertImage[2/2]	插入并展示图片
insertText	在指定位置插入文字
getScene	获取指定场景的信息
getSceneState[1/2]	获取当前场景目录下的场景状态（同步方法）
getSceneState[2/2]	获取当前场景目录下的场景状态（异步方法）
getScenes[1/2]	获取当前场景目录下的场景列表（同步方法）
getScenes[2/2]	获取当前场景目录下的场景列表（异步方法）
setScenePath[1/2]	切换至指定的场景（同步方法）
setScenePath[2/2]	切换至指定的场景（异步方法）
setSceneIndex[1/2]	切换至当前场景目录下的指定场景
putScenes	在指定场景目录下插入多个场景
moveScene	移动场景
removeScenes	删除场景或者场景目录
cleanScene	清除当前场景的所有内容
pptNextStep	播放动态 PPT 下一页
pptPreviousStep	返回动态 PPT 上一页
getScenePathType	查询场景路径类型
getEntireScenes	获取当前房间内所有场景的信息
getScenePreviewImage	获取指定场景的预览图
getSceneSnapshotImage	获取指定场景的截图

回放管理

方法	描述
setPlaybackSpeed	设置白板回放的倍速
play	开始白板回放
pause	暂停白板回放
stop	停止白板回放
seekToScheduleTime	设置白板回放的播放位置
setObserverMode	设置白板回放的查看模式
getPlaybackSpeed	获取白板回放的倍速（同步方法）
getPlaybackSpeed	获取白板回放的倍速（异步方法）
getPlayerPhase	获取白板回放的阶段（同步方法）
getPhase	获取白板回放的阶段（异步方法）
getPlayerState	获取白板回放的状态（同步方法）
getPlayerState	获取白板回放的状态（异步方法）
getPlayerTimeInfo	获取白板回放的时间信息（同步方法）
getPlayerTimeInfo	获取白板回放的时间信息（异步方法）
addPlayerListener	添加白板回放的回调
removePlayerListener	删除白板回放的回调

自定义事件

方法	描述
dispatchMagixEvent	发送自定义事件
addMagixEventListener	注册自定义事件监听
addHighFrequencyEventListener	注册高频自定义事件监听
removeMagixEventListener	移除自定义事件监听
dispatchDocsEvent	发送文档操作事件

iframe 插件交互

方法	描述
postIframeMessage	向 iframe 插件发送字符串信息
postIframeMessage	向 iframe 插件发送 key-value 格式的信息

其他方法

方法	描述
debugInfo	获取调试日志信息
setTimeDelay	设置白板同步延时
getTimeDelay	获取白板同步延时
convertToPointInWorld	转换白板上点的坐标
refreshViewSize	刷新白板的界面
prepareWhiteConnection	提前选择线路以加快首次加入白板房间时的连接速度。