Interface NERoomWhiteboardController
-
- All Implemented Interfaces:
-
com.netease.yunxin.kit.roomkit.api.NEBaseController
public interface NERoomWhiteboardController implements NEBaseController
白板控制器
-
-
Method Summary
Modifier and Type Method Description abstract IntegersetEnableDraw(Boolean enable)设置白板是否可绘制 abstract IntegersetCanvasBackgroundColor(String color)设置白板背景颜色,只对当前客户端有影响 abstract IntegerlockCameraWithContent(Integer width, Integer height)将白板和被标注物的坐标绑定 abstract IntegersetupWhiteboardCanvas(NEWhiteboardView view)设置白板视图 abstract IntegersetupWhiteboardCanvas(NEWhiteboardView view, NEWhiteboardAppConfig appConfig)设置白板视图 abstract IntegerresetWhiteboardCanvas(NEWhiteboardView view)重置白板视图 abstract UnitstartWhiteboardShare(NECallback<Unit> callback)开启本端白板共享 abstract UnitstartWhiteboardShare(Boolean stopCurrentShare, NECallback<Unit> callback)开启本端白板共享如果 stopCurrentShare 为 true,则会尝试抢占当前其他成员的屏幕共享, 服务端会校验 当前成员是否有权限抢占共享,校验通过,则抢占成功;否则,抢占失败。 如果 stopCurrentShare 为 false,则不会进行抢占,此时如果房间内已经有其他成员正在共享,则该接口失败。注意:该接口不支持抢占其他成员的白板共享。abstract UnitstopWhiteboardShare(NECallback<Unit> callback)停止本端白板共享 abstract UnitstopMemberWhiteboardShare(String userUuid, NECallback<Unit> callback)尝试关闭房间内成员的白板共享,会进行权限校验。 abstract StringgetWhiteboardSharingUserUuid()查询白板共享者的userUuid -
-
Method Detail
-
setEnableDraw
abstract Integer setEnableDraw(Boolean enable)
设置白板是否可绘制
- Parameters:
enable- 是否允许绘制
-
setCanvasBackgroundColor
abstract Integer setCanvasBackgroundColor(String color)
设置白板背景颜色,只对当前客户端有影响
- Parameters:
color- 白板背景颜色,如"rgb(255, 255, 255)","rgba(255, 255, 255, 0)"
-
lockCameraWithContent
abstract Integer lockCameraWithContent(Integer width, Integer height)
将白板和被标注物的坐标绑定
- Parameters:
width- 被标注物的宽度(一般为视频画面宽度)height- 被标注物的高度(一般为视频画面高度度)
-
setupWhiteboardCanvas
abstract Integer setupWhiteboardCanvas(NEWhiteboardView view)
设置白板视图
- Parameters:
view- 白板视图
-
setupWhiteboardCanvas
abstract Integer setupWhiteboardCanvas(NEWhiteboardView view, NEWhiteboardAppConfig appConfig)
设置白板视图
- Parameters:
view- 白板视图appConfig- 白板配置
-
resetWhiteboardCanvas
abstract Integer resetWhiteboardCanvas(NEWhiteboardView view)
重置白板视图
- Parameters:
view- 当前白板视图或传入null强制重置
-
startWhiteboardShare
abstract Unit startWhiteboardShare(NECallback<Unit> callback)
开启本端白板共享
- Parameters:
callback- 回调
-
startWhiteboardShare
abstract Unit startWhiteboardShare(Boolean stopCurrentShare, NECallback<Unit> callback)
开启本端白板共享
如果 stopCurrentShare 为 true,则会尝试抢占当前其他成员的屏幕共享, 服务端会校验
当前成员是否有权限抢占共享,校验通过,则抢占成功;否则,抢占失败。 如果 stopCurrentShare 为 false,则不会进行抢占,此时如果房间内已经有其他成员正在共享,则该接口失败。注意:该接口不支持抢占其他成员的白板共享。
- Parameters:
stopCurrentShare- 是否停止当前其他成员的共享callback- 回调
-
stopWhiteboardShare
abstract Unit stopWhiteboardShare(NECallback<Unit> callback)
停止本端白板共享
- Parameters:
callback- 回调
-
stopMemberWhiteboardShare
abstract Unit stopMemberWhiteboardShare(String userUuid, NECallback<Unit> callback)
尝试关闭房间内成员的白板共享,会进行权限校验。
- Parameters:
userUuid- 成员账号Idcallback- 回调
-
getWhiteboardSharingUserUuid
abstract String getWhiteboardSharingUserUuid()
查询白板共享者的userUuid
-
-
-
-