com.aliyun.roompaas.whiteboard.exposable.WhiteboardService Interface Reference

Inheritance diagram for com.aliyun.roompaas.whiteboard.exposable.WhiteboardService:

Public Member Functions
void	crateWhiteBoard (CreateWhiteboardCb callback)
String	getWhiteboardId ()
void	initWhiteBoard (String docInfo)
void	initWhiteBoard (String docInfo, WhiteBoardOption option)
void	openWhiteBoard (Callback< View > callback)
void	onPauseWhiteBoard ()
void	onResumeWhiteBoard ()
void	onDestroyWhiteBoard ()
void	setToolbarOrientation (ToolbarOrientation orientation)
void	setToolbarVisibility (int visibility)
void	openWhiteboardService (String docKey, Callback< OpenWhiteboardRsp > callback)
void	getWhiteboardPageInfo (String docKey, Callback< GetWhiteboardPageInfoRsp > callback)
void	startWhiteboardRecording (Callback< StartWhiteboardRecordingRsp > callback)
void	stopWhiteboardRecording (Callback< Void > callback)
void	pauseWhiteboardRecording (Callback< Void > callback)
void	resumeWhiteboardRecording (Callback< Void > callback)
void	start ()
void	pause ()
void	stepTo (long utcTime, Callback< Void > callback)
void	addBackgroundImage (String url)
void	addScenesSyncWithBackgroundUrls (List< String > urlList)
void	addScenesSyncWithBackgroundUrls (String targetDocId, List< String > urlList)
void	refreshDocUrlList (List< String > urlList)
void	setAddDocumentAction (@Nullable Runnable action)
Public Member Functions inherited from com.aliyun.roompaas.base.exposable.PluginService< EH >
String	getPluginId ()
String	getInstanceId ()
void	onLeaveRoom (boolean existPage)
void	onSyncEvent (RoomNotificationModel model)
Public Member Functions inherited from com.aliyun.roompaas.base.exposable.IEventHandlerManager< EH >
void	addEventHandler (EH eventHandler)
void	removeEventHandler (EH eventHandler)
void	removeAllEventHandler ()

Detailed Description

Author

puke

Version

2021/6/21

Member Function Documentation

addBackgroundImage()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.addBackgroundImage

(

String

url

)

设置当前白板页的背景图

Parameters

url

pic

addScenesSyncWithBackgroundUrls() [1/2]

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.addScenesSyncWithBackgroundUrls

(

List< String >

urlList

)

设置一批背景urlList，同时从当前页创建白板 已弃用：需要同时传递docId，以便建立文档关联关系

Parameters

urlList

addScenesSyncWithBackgroundUrls() [2/2]

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.addScenesSyncWithBackgroundUrls	(	String	targetDocId,
		List< String >	urlList
	)

设置一批背景urlList，同时从当前页创建白板

Parameters

targetDocId	转码结果目标docId
urlList

crateWhiteBoard()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.crateWhiteBoard

(

CreateWhiteboardCb

callback

)

创建白板

Parameters

callback

回调

getWhiteboardId()

String com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.getWhiteboardId

(

)

获取白板id

Returns

id

getWhiteboardPageInfo()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.getWhiteboardPageInfo	(	String	docKey,
		Callback< GetWhiteboardPageInfoRsp >	callback
	)

查询白板页码信息

Parameters

docKey	白板id
callback	处理结果回调，异步

initWhiteBoard() [1/2]

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.initWhiteBoard

(

String

docInfo

)

白板初始化

Parameters

docInfo

配置信息

initWhiteBoard() [2/2]

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.initWhiteBoard	(	String	docInfo,
		WhiteBoardOption	option
	)

白板初始化

Parameters

docInfo
option

onDestroyWhiteBoard()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.onDestroyWhiteBoard

(

)

白板依附的页面销毁

onPauseWhiteBoard()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.onPauseWhiteBoard

(

)

白板依附的页面离开

onResumeWhiteBoard()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.onResumeWhiteBoard

(

)

白板依附的页面展示

openWhiteBoard()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.openWhiteBoard

(

Callback< View >

callback

)

打开白板

Parameters

callback

回调信息

openWhiteboardService()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.openWhiteboardService	(	String	docKey,
		Callback< OpenWhiteboardRsp >	callback
	)

打开白板服务

Parameters

docKey	白板id
callback	处理结果回调，异步

pause()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.pause

(

)

从播放状态暂停

pauseWhiteboardRecording()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.pauseWhiteboardRecording

(

Callback< Void >

callback

)

暂停白板录制

refreshDocUrlList()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.refreshDocUrlList

(

List< String >

urlList

)

刷新文档对应的url列表

Parameters

urlList

文档url列表

resumeWhiteboardRecording()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.resumeWhiteboardRecording

(

Callback< Void >

callback

)

恢复白板录制

setAddDocumentAction()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.setAddDocumentAction

(

@Nullable Runnable

action

)

设置白板添加文档按钮点击回调

setToolbarOrientation()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.setToolbarOrientation

(

ToolbarOrientation

orientation

)

设置白板toolbar方向

Parameters

orientation

ToolbarOrientation

setToolbarVisibility()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.setToolbarVisibility

(

int

visibility

)

设置白板toolbar visibility

Parameters

visibility

start()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.start

(

)

从当前位置开始播放

startWhiteboardRecording()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.startWhiteboardRecording

(

Callback< StartWhiteboardRecordingRsp >

callback

)

开始白板录制

stepTo()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.stepTo	(	long	utcTime,
		Callback< Void >	callback
	)

跳转到录制时间轴

Parameters

utcTime

stopWhiteboardRecording()

void com.aliyun.roompaas.whiteboard.exposable.WhiteboardService.stopWhiteboardRecording

(

Callback< Void >

callback

)

结束白板录制

---

The documentation for this interface was generated from the following file:

• /Users/puke/AndroidStudioProjects/room-paas-android/export_api/whiteboard/src/main/java/com/aliyun/roompaas/whiteboard/exposable/WhiteboardService.java