NERoomWhiteboardController

@objcMembers
public class NERoomWhiteboardController : NERoomWhiteBoardBaseController

白板控制器

————————- Public method ————————–

  • 功能是否支持

    Declaration

    Swift

    override public var isSupported: Bool { get }

  • 设置白板是否可绘制

    Declaration

    Swift

    @discardableResult
public func setEnableDraw(enable: Bool) -> Int

    Return Value

    0 代表成功，否则失败

  • 设置白板

    Declaration

    Swift

    @discardableResult
public func setupWhiteboardCanvas(view: NEWhiteboardView) -> Int

    Parameters

    view

    白板视图

    Return Value

    0 代表成功，否则失败

  • 设置白板

    Declaration

    Swift

    @discardableResult
public func setupWhiteboardCanvas(view: NEWhiteboardView, appConfig: NEWhiteboardAppConfig? = nil) -> Int

    Parameters

    view

    白板视图
    appConfig

    白板初始化配置

    Return Value

    0 代表成功，否则失败

  • 重置白板

    Declaration

    Swift

    @discardableResult
public func resetWhiteboardCanvas(view: NEWhiteboardView?) -> Int

    Parameters

    view

    白板视图

    Return Value

    0 代表成功，否则失败

  • 开启本端白板共享

    Declaration

    Swift

    public func startWhiteboardShare(callback: NECallback<AnyObject>? = nil)

    Parameters

    callback

    开启结果回调

  • 开启本端白板共享

    Declaration

    Swift

    public func startWhiteboardShare(stopCurrentShare: Bool, callback: NECallback<AnyObject>? = nil)

    Parameters

    stopCurrentShare

    是否停止当前其他成员的共享
    callback

    开启结果回调

  • 停止本端白板共享

    Declaration

    Swift

    public func stopWhiteboardShare(callback: NECallback<AnyObject>? = nil)

    Parameters

    callback

    关闭结果回调

  • 关闭成员白板

    Declaration

    Swift

    public func stopMemberWhiteboardShare(userUuid: String,
                                      callback: NECallback<AnyObject>?)

    Parameters

    userUuid

    成员ID
    callback

    回调

  • 获取正在白板分享的成员Id

    Declaration

    Swift

    @discardableResult
public func getWhiteboardSharingUserUuid() -> String?

    Return Value

    成员Id

  • 设置白板背景颜色，只对当前客户端有影响

    Declaration

    Swift

    @discardableResult
public func setCanvasBackgroundColor(_ color: String) -> Int

    Parameters

    color

    白板背景色 如: ‘rgb(255, 255, 255)'、'rgba(255, 255, 255, 0)’ 等

    Return Value

    0 代表成功，否则失败

  • 将白板和被标注物的坐标绑定

    Declaration

    Swift

    @discardableResult
public func lockCameraWithContent(width: Int, height: Int) -> Int

    Parameters

    width

    被标注物的宽度(一般为视频画面宽度)
    height

    被标注物的高度(一般为视频画面高度度)

    Return Value

    0 代表成功，否则失败

  • 更新自己的白板共享状态

    Declaration

    Swift

    func updateWhiteboardState(open: Bool, queries: [String: String]?,
                           completion: @escaping ([String: Any]?, Error?) -> Void)

  • 更新成员白板共享状态

    Declaration

    Swift

    func updateWhiteboardState(userUuid: String,
                           open: Bool, queries: [String: String]?,
                           completion: @escaping ([String: Any]?, Error?) -> Void)

    Parameters

    userUuid

    成员ID
    openValue

    状态 1: 打开 0: 关闭
    completion

    回调