程序包 rtc

类 MWhiteboard

java.lang.Object
rtc.Module
rtc.MWhiteboard
public class MWhiteboard extends Module
白板模块接口.

  • 方法详细资料

    • getWhiteboard

      public static MWhiteboard getWhiteboard(Room room)
      获取房间白板模块
      返回:
      返回白板模块接口指针。

    • getWhiteboardParams

      public MWhiteboard.Whiteboard getWhiteboardParams()
      获取白板结构对象
      返回:

    • hasWhiteboardShared

      public boolean hasWhiteboardShared()
      当前是否已显示共享的白板
      返回:

    • createLocalWhiteboard

      public String createLocalWhiteboard(String title, String desc, int color)
      创建本地白板
      参数:
      title - 白板标题
      desc - 白板描述
      color - 白板颜色
      返回:
      白板id

    • createLocalWhiteboard

      public String createLocalWhiteboard(String title, String desc, String remoteBgUrl, int color)
      参数:
      title - 白板标题
      desc - 白板描述
      remoteBgUrl - 白板背景图片存放目录
      color - color 白板颜色
      返回:
      白板id

    • hasLocalWhiteboardShared

      public boolean hasLocalWhiteboardShared()
      本地是否已发布白板
      返回:

    • isWhiteboardShared

      public boolean isWhiteboardShared(String boardId)
      查询指定的白板是否已发布
      参数:
      boardId - 指定的白板id
      返回:

    • rebuildLocalWhiteboard

      public void rebuildLocalWhiteboard()
      重新发布本地白板

    • onUserLeave

      @Deprecated public void onUserLeave(User user)
      已过时。

    • isVisible

      public boolean isVisible()
      白板当前是否可见
      返回:

    • isDrawToolVisible

      public boolean isDrawToolVisible()
      白板工具栏是否可见
      返回:

    • onAttachView

      public MWhiteboard onAttachView(WhiteboardView view)
      绑定白板的布局
      参数:
      view - 白板布局（WhiteboardView）
      返回:

    • getWhiteboardView

      public WhiteboardView getWhiteboardView()
      获取白板布局管理对象
      返回:

    • getAnnotation

      public MAnnotationInternal getAnnotation()
      获取白板注释管理对象
      返回:

    • createBoard

      public int createBoard(MWhiteboard.Whiteboard whiteboard)
      创建白板
      参数:
      whiteboard - 白板结构
      返回:

    • closeRemoteBoard

      public void closeRemoteBoard(String boardId)
      关闭远端白板（不显示远端白板）
      参数:
      boardId - 白板id

    • closeLocalBoard

      public void closeLocalBoard()
      关闭本地白板

    • getLocalWhiteboardId

      public String getLocalWhiteboardId()
      获取本地白板的id
      返回:

    • showWhiteboard

      public int showWhiteboard(String boardId)
      显示指定已发布的白板
      参数:
      boardId - 白板id
      返回:

    • showToolbar

      public MWhiteboard showToolbar(boolean isShow)
      显示白板工具栏
      参数:
      isShow - 是否显示
      返回:

    • removeBoard

      public void removeBoard(String id)
      移除白板（取消发布白板）
      参数:
      id - 白板id

    • getWhiteBoards

      public List<MWhiteboard.Whiteboard> getWhiteBoards()
      获取已创建的白板列表
      返回:

    • getSharedWhiteBoards

      public List<MWhiteboard.Whiteboard> getSharedWhiteBoards()
      获取房间已发布的白板列表
      返回:

    • setOnTouchEventListener

      public void setOnTouchEventListener(WhiteboardView.IOnTouchEventListener listener)
      WhiteboardView 触摸事件监听
      参数:
      listener -

    • setOnDrawToolVisibleListener

      public void setOnDrawToolVisibleListener(WhiteboardView.IDrawToolbarListener listener)
      WhiteboardView 触摸事件监听
      参数:
      listener -

    • setListener

      public boolean setListener(MWhiteboard.Listener listener)
      设置白板模块回调接口
      返回:
      返回错误代码。