IMP(低代码音视频工厂)SDK v1.5.0
IMP SDK API Reference Manual for Windows Platforms
IWhiteBoard Class Referenceabstract
Inheritance diagram for IWhiteBoard:
IPlugin

Public Member Functions

virtual void CreateWhiteBoard (const std::function< void(std::string doc_key)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &on_fail)=0
 创建白板 More...
 
virtual void DestroyWhiteBoard ()=0
 销毁白板
 
virtual void OpenWhiteBoard (void *hwnd, const std::string &config_data, const std::string &doc_data)=0
 打开白板 More...
 
virtual void CloseWhiteBoard ()=0
 关闭白板
 
virtual void InvokeWhiteBoardMethod (const std::string &method, const std::string &param, const std::function< void(const std::string &)> &cb)=0
 调用jsapi More...
 
virtual bool SetBoardViewPos (int x, int y, int width, int height)=0
 设置白板位置及大小,若为子窗口,x和y应该为0 More...
 
virtual void AddListener (void *ptr, const std::function< void(const std::string &, const std::string &)> &callback)=0
 添加白板事件监听 More...
 
virtual void RemoveListener (void *ptr)=0
 删除白板事件监听 More...
 
virtual void ShowDevTools ()=0
 显示调试窗口,白板容器内置的是CEF,会打开CEF的调试窗口
 
virtual void OpenWhiteBoardService (const std::function< void(const ::alibaba::wb::OpenWhiteboardRsp &rsp)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &on_fail)=0
 获取打开白板需要的参数,例如doc_key More...
 
virtual void ReportWhiteboardPageOperate (const ::alibaba::wb::ReportWhiteboardPageOperateReq &req, const std::function< void(const ::alibaba::wb::ReportWhiteboardPageOperateRsp &rsp)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &on_fail)=0
 更新白板ppt页数映射 More...
 
virtual void GetWhiteboardPageInfo (const ::alibaba::wb::GetWhiteboardPageInfoReq &req, const std::function< void(const ::alibaba::wb::GetWhiteboardPageInfoRsp &rsp)> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &on_fail)=0
 获取白板ppt也映射每一页详细信息 More...
 
virtual void StartRecord (const std::string &doc_key, const std::function< void()> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &on_fail)=0
 开始录制白板 More...
 
virtual void PauseRecord (const std::string &doc_key, const std::function< void()> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &on_fail)=0
 暂停录制白板 More...
 
virtual void ResumeRecord (const std::string &doc_key, const std::function< void()> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &on_fail)=0
 恢复录制白板 More...
 
virtual void StopRecord (const std::string &doc_key, const std::function< void()> &on_success, const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &on_fail)=0
 结束录制白板 More...
 
- Public Member Functions inherited from IPlugin
virtual PluginEnum GetPluginType ()=0
 获取插件类型 More...
 
virtual bool IsValid ()=0
 插件是否有效 More...
 

Member Function Documentation

◆ AddListener()

virtual void IWhiteBoard::AddListener ( void *  ptr,
const std::function< void(const std::string &, const std::string &)> &  callback 
)
pure virtual

添加白板事件监听

Parameters
ptr用于注册多个listener的key
callback事件回调

◆ CreateWhiteBoard()

virtual void IWhiteBoard::CreateWhiteBoard ( const std::function< void(std::string doc_key)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &  on_fail 
)
pure virtual

创建白板

Parameters
on_success成功回调,会返回文档的密钥
on_fail失败回调

◆ GetWhiteboardPageInfo()

virtual void IWhiteBoard::GetWhiteboardPageInfo ( const ::alibaba::wb::GetWhiteboardPageInfoReq req,
const std::function< void(const ::alibaba::wb::GetWhiteboardPageInfoRsp &rsp)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &  on_fail 
)
pure virtual

获取白板ppt也映射每一页详细信息

Parameters
req请求参数,参考::alibaba::wb::GetWhiteboardPageInfoReq
on_success成功回调,参考::alibaba::wb::GetWhiteboardPageInfoRsp
on_fail失败回调

◆ InvokeWhiteBoardMethod()

virtual void IWhiteBoard::InvokeWhiteBoardMethod ( const std::string &  method,
const std::string &  param,
const std::function< void(const std::string &)> &  cb 
)
pure virtual

调用jsapi

Parameters
method方法名
param调用参数

◆ OpenWhiteBoard()

virtual void IWhiteBoard::OpenWhiteBoard ( void *  hwnd,
const std::string &  config_data,
const std::string &  doc_data 
)
pure virtual

打开白板

Parameters
hwnd窗口句柄
config_data白板的设置, json,通过pop接口获取白板配置
doc_data文档数据,json,登录密钥等,这些信息可以通过OpenWhiteBoardService接口获取

◆ OpenWhiteBoardService()

virtual void IWhiteBoard::OpenWhiteBoardService ( const std::function< void(const ::alibaba::wb::OpenWhiteboardRsp &rsp)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &  on_fail 
)
pure virtual

获取打开白板需要的参数,例如doc_key

Parameters
on_success成功回调,参考::alibaba::wb::OpenWhiteboardRsp
on_fail失败回调

◆ PauseRecord()

virtual void IWhiteBoard::PauseRecord ( const std::string &  doc_key,
const std::function< void()> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &  on_fail 
)
pure virtual

暂停录制白板

Parameters
reqdoc_key
on_success成功回调
on_fail失败回调

◆ RemoveListener()

virtual void IWhiteBoard::RemoveListener ( void *  ptr)
pure virtual

删除白板事件监听

Parameters
ptr用于注册多个listener的key

◆ ReportWhiteboardPageOperate()

virtual void IWhiteBoard::ReportWhiteboardPageOperate ( const ::alibaba::wb::ReportWhiteboardPageOperateReq req,
const std::function< void(const ::alibaba::wb::ReportWhiteboardPageOperateRsp &rsp)> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &  on_fail 
)
pure virtual

更新白板ppt页数映射

Parameters
req请求参数,参考::alibaba::wb::ReportWhiteboardPageOperateReq
on_success成功回调,参考::alibaba::wb::ReportWhiteboardPageOperateRsp
on_fail失败回调

◆ ResumeRecord()

virtual void IWhiteBoard::ResumeRecord ( const std::string &  doc_key,
const std::function< void()> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &  on_fail 
)
pure virtual

恢复录制白板

Parameters
reqdoc_key
on_success成功回调
on_fail失败回调

◆ SetBoardViewPos()

virtual bool IWhiteBoard::SetBoardViewPos ( int  x,
int  y,
int  width,
int  height 
)
pure virtual

设置白板位置及大小,若为子窗口,x和y应该为0

Parameters
x左侧坐标
y上策坐标
width宽度
height高度

◆ StartRecord()

virtual void IWhiteBoard::StartRecord ( const std::string &  doc_key,
const std::function< void()> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &  on_fail 
)
pure virtual

开始录制白板

Parameters
doc_key文档key
on_success成功回调
on_fail失败回调

◆ StopRecord()

virtual void IWhiteBoard::StopRecord ( const std::string &  doc_key,
const std::function< void()> &  on_success,
const std::function< void(const ::alibaba::dps::DPSError &error_msg)> &  on_fail 
)
pure virtual

结束录制白板

Parameters
reqdoc_key
on_success成功回调
on_fail失败回调

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