PanoWhiteboard.h

浏览该文件的文档.

 
#pragma once
 
#include "PanoRtcDefs.h"
 
#include <stddef.h>
 
PANORTC_NS_BEGIN
 
enum class WBMode
{
    BOUNDLESS,
    FIXED_ASPECTRATIO
};
 
enum class WBRoleType
{
    ADMIN,
    ATTENDEE,
    VIEWER
};
 
enum class WBToolType
{
    NONE,
    SELECT,
    PATH,
    LINE,
    RECT,
    ELLIPSE,
    IMAGE,
    TEXT,
    DELETER,
    BRUSH,
    ARROW,
    POLYLINE,
    POLYGON,
    ARC,
    CURVE,
    LASER,
    STAMP,
};
 
enum class WBFillType
{
    NONE,
    COLOR,
};
 
enum class WBOrderType
{
    BACK,
    NORMAL,
    FRONT
};
 
struct WBPoint
{
    float x{ 0.f };
    float y{ 0.f };
};
 
struct WBSize
{
    float cx{ 0.f };
    float cy{ 0.f };
};
 
 
struct WBRect
{
    float left{ 0.f };
    float top{ 0.f };
    float right{ 0.f };
    float bottom{ 0.f };
};
 
struct WBColor
{
    float r{ 0.f };
    float g{ 0.f };
    float b{ 0.f };
    float a{ 0.f };
};
 
enum class WBFontStyle
{
    NORMAL,
    BOLD,
    ITALIC,
    BOLD_ITALIC,
};
 
struct WBTextFormat
{
    WBFontStyle style{ WBFontStyle::NORMAL };
    uint32_t size{ 12 };
    WBColor color;
};
 
struct WBStamp
{
    const char *stampId = nullptr;
    const char *path = nullptr;
    bool resizable = false;
};
 
using WBPageNumber = uint32_t;
const WBPageNumber kInvalidPageNumber = WBPageNumber(-1);
 
enum class WBImageState
{
    LOAD_START,
    LOAD_COMPLETE,
    LOAD_FAIL
};
 
enum class WBImageScalingMode
{
    FIT,
    AUTO_FILL,
    FILL_WIDTH,
    FILL_HEIGHT,
    FIT_CENTER,
};
 
enum class WBHtmlState
{
    LOAD_START,
    LOAD_COMPLETE,
    LOAD_TIMEOUT,
    RELOADED,
};
 
enum class WBClearType
{
    DRAWS               = 1,
    BACKGROUND_IMAGE    = 2,
    ALL                 = 255,
};
 
enum class WBDocType
{
    NORMAL             = 1,
    H5                 = 2,
    EXT_HTML           = 3,
    EXTERNAL           = 4,
    PDF                = 5,
};
 
enum class WBDocConvertType
{
    JPG                 = 1,
    PNG                 = 2,
    H5                  = 3,
    PDF                 = 4,
};
 
struct WBDocContents
{
    const char *name = nullptr;
    const char **urls = nullptr;
    size_t count{ 0 };
    const char **thumbUrls = nullptr;
    size_t thumbCount{ 0 };
    const char *docId = nullptr;
    WBDocType type{ WBDocType::NORMAL };
};
 
struct WBDocExtHtml
{
    const char *name = nullptr;
    const char *url = nullptr;
    const char **thumbUrls = nullptr;
    size_t thumbCount{ 0 };
};
 
struct WBDocExtContents
{
    const char *name = nullptr;
    size_t totalPages{ 1 };
    uint32_t width;
    uint32_t height;
};
 
struct WBDocConvertParam
{
    WBDocConvertType type{ WBDocConvertType::JPG };
    bool needThumb{ false };
    int lifeType{ -1 };
    const char *meta = nullptr;
};
 
struct WBDocInfo
{
    const char *fileId;
    const char *name;
    uint64_t creator;
    WBDocType type;
    const char *docId;
};
 
enum class WBSnapshotMode
{
    VIEW,
    ALL,
};
 
struct WBVisionConfig
{
    uint32_t width;
    uint32_t height;
    bool limited;
};
 
enum class WBDrawEventType
{
    DRAW_START,
    DRAW_END,
    TEXT_INPUT,
    TEXT_UPDATE,
};
 
struct WBDrawEvent
{
    WBDrawEventType type;
};
 
enum class WBOption
{
    FILE_CACHE_PATH     = 1, // type: char *
    ENABLE_UI_RESPONSE         = 2, // type: bool
    ENABLE_SHOW_DRAWS          = 3, // type: bool
    ENABLE_SCALE_MOVE  = 4, // type: bool
    ENABLE_AUTO_SELECTED = 5, // type: bool
    ENABLE_CURSORPOS_SYNC = 6, // type: bool
    ENABLE_SHOW_REMOTE_CURSOR = 7, // type: bool
    ENABLE_PC_UA_EXTHTML = 8, // type: bool
    ENABLE_UIEVENT_FORWARD = 9, // type: bool
 
};
 
// Values are platform-specific for Window type:
//   - On Windows: HWND.
using WBWindowID = uintptr_t;
 
class RtcWhiteboard
{
public:
 
    using EnumFileCallback = bool(*) (void *context, const char *fileId);
 
    class Callback
    {
    public:
        virtual void onStatusSynced() {}
 
        virtual void onPageNumberChanged(WBPageNumber curPage, size_t totalPages) {}
 
        virtual void onImageStateChanged(const char *url, WBImageState state) {}
 
        virtual void onHtmlStateChanged(const char *fileId, const char *url, WBHtmlState state) {}
 
        virtual void onViewScaleChanged(float scale) {}
 
        virtual void onRoleTypeChanged(WBRoleType newRole) {}
 
        virtual void onContentUpdated() {}
 
        virtual void onSnapshotComplete(QResult result, const char *filename) {}
 
        virtual void onMessage(uint64_t userId, const char *msg, size_t size) {}
 
        virtual void onAddBackgroundImages(QResult result, const char *fileId) {}
 
        virtual void onAddH5File(QResult result, const char *fileId) {}
 
        virtual void onDocTranscodeStatus(QResult result,
                                           const char *fileId,
                                           uint32_t progress,
                                           uint32_t totalPage) {}
 
        virtual void onCreateDoc(QResult result, const char *fileId) {}
 
        virtual void onDeleteDoc(QResult result, const char *fileId) {}
 
        virtual void onSwitchDoc(QResult result, const char *fileId) {}
 
        virtual void onSaveDoc(QResult result, const char *fileId, const char *outputDir) {}
 
        virtual void onSaveDocProgress(const char *fileId, uint32_t current, uint32_t total) {}
 
        virtual void onDocThumbnailReady(const char *fileId, const char **urls, size_t count) {}
 
        virtual void onPreloadDocResult(QResult result, const char *docId, int32_t succNum, int32_t totalNum) {}
 
        virtual void onExternalHtmlMessageReceived(const char *fileId, const char *msg, size_t length) {}
 
        virtual void onDrawRectUpdate(WBPoint offset, WBSize viewSize, WBSize maxSize) {}
 
        virtual void onVisionShareStarted(uint64_t userId) {}
 
        virtual void onVisionShareStopped(uint64_t userId) {}
 
        virtual void onUserJoined(uint64_t userId, const char *userName) {}
 
        virtual void onUserLeft(uint64_t userId) {}
 
        virtual void onRenderWindowCreated(WBWindowID windowId)  {}
 
        virtual void onRenderWindowDestroyed(WBWindowID windowId) {}
 
        virtual void onUndoStatusChanged(bool canUndo) {}
 
        virtual void onRedoStatusChanged(bool canRedo) {}
 
        virtual void onDrawEvent(WBDrawEvent event) {}
 
        virtual ~Callback() = default;
    };
 
    virtual QResult setCallback(Callback *callback) = 0;
 
    virtual QResult setRoleType(WBRoleType type) = 0;
    virtual QResult open(void *window) = 0;
    virtual QResult close() = 0;
 
    virtual QResult leave() = 0;
 
    virtual QResult stop() = 0;
 
    virtual QResult importFrom(const char *filename) = 0;
 
    virtual QResult exportTo(const char *filename) = 0;
 
    virtual QResult addToolboxView(void *window) = 0;
 
    virtual QResult removeToolboxView(void *window) = 0;
 
    virtual const char* getCurrentWhiteboardId() = 0;
 
    virtual WBToolType getToolType() = 0;
 
    virtual WBPageNumber getCurrentPageNumber() = 0;
 
    virtual size_t getTotalNumberOfPages() = 0;
 
    virtual float getCurrentScaleFactor() = 0;
 
    virtual QResult setCurrentScaleFactor(float scale) = 0;
 
    virtual float getCurrentMinScaleFactor() = 0;
 
    virtual float getCurrentMaxScaleFactor() = 0;
 
    virtual QResult scrollView(float dx, float dy) = 0;
 
    virtual QResult setBackgroundImage(const char *imageUrl) = 0;
 
    virtual QResult setBackgroundImage(const char *imageUrl, WBPageNumber pageNo) = 0;
 
    virtual QResult setBackgroundImageScalingMode(WBImageScalingMode mode) = 0;
 
    virtual QResult setToolType(WBToolType type) = 0;
 
    virtual QResult setLineWidth(int size) = 0;
    virtual QResult setFillType(WBFillType type) = 0;
    virtual QResult setFillColor(WBColor color) = 0;
    virtual QResult setForegroundColor(WBColor color) = 0;
    virtual QResult setBackgroundColor(WBColor color) = 0;
    virtual QResult setFontStyle(WBFontStyle style) = 0;
    virtual QResult setFontSize(int size) = 0;
    virtual QResult addStamp(WBStamp stamp) = 0;
    virtual QResult setStamp(const char *stampId) = 0;
 
    virtual QResult undo() = 0;
    virtual QResult redo() = 0;
 
    virtual QResult addPage(bool autoSwitch) = 0;
    virtual QResult insertPage(WBPageNumber pageNo, bool autoSwitch) = 0;
    virtual QResult removePage(WBPageNumber pageNo) = 0;
    virtual QResult removePage(WBPageNumber pageNo, bool switchNext) = 0;
    virtual QResult gotoPage(WBPageNumber pageNo) = 0;
    virtual QResult nextPage() = 0;
    virtual QResult prevPage() = 0;
    virtual QResult nextStep() = 0;
    virtual QResult prevStep() = 0;
 
    virtual QResult addImageFile(const char *imageUrl) = 0;
 
    virtual QResult addAudioFile(const char *mediaUrl) = 0;
    
    virtual QResult addVideoFile(const char *mediaUrl) = 0;
 
    virtual const char* addBackgroundImages(const char **urls, size_t count) = 0;
    virtual const char* addH5File(const char *url, const char *downloadUrl) = 0;
    virtual const char* addDoc(WBDocContents contents) = 0;
    virtual const char* addDoc(WBDocExtHtml contents) = 0;
    virtual const char* addDoc(WBDocExtContents contents) = 0;
 
    virtual const char* createDoc(const char **imageUrls, size_t count) = 0;
    virtual const char* createDoc(const char *filePath) = 0;
    virtual const char* createDoc(const char *filePath, WBDocConvertParam param) = 0;
    virtual QResult deleteDoc(const char *fileId) = 0;
    virtual QResult switchDoc(const char *fileId) = 0;
    virtual QResult saveDocToImages(const char *fileId, const char *outputDir) = 0;
    virtual QResult preloadDoc(WBDocContents contents) = 0;
 
    virtual QResult enumerateFiles(EnumFileCallback cb, void *context) = 0;
    virtual const char* getCurrentFileId() = 0;
    virtual WBDocInfo* getFileInfo(const char *fileId) = 0;
 
    virtual QResult sendMessageToExternalHtml(const char *fileId, const char *msg, size_t length) = 0;
 
    virtual QResult clearContents(bool curPage, WBClearType type) = 0;
    virtual QResult clearUserContents(uint64_t userId, bool curPage, WBClearType type) = 0;
    virtual QResult clearDocContents(const char *fileId, WBClearType type) = 0;
 
    virtual QResult snapshot(WBSnapshotMode mode, const char *outputDir) = 0;
 
    virtual QResult refresh() = 0;
 
    virtual QResult initVision(WBVisionConfig config) = 0;
    virtual QResult resetVision() = 0;
    virtual QResult startShareVision() = 0;
    virtual QResult stopShareVision() = 0;
    virtual QResult startFollowVision() = 0;
    virtual QResult stopFollowVision() = 0;
    virtual QResult syncVision() = 0;
 
    virtual QResult sendMessage(uint64_t userId, const char *msg, size_t size) = 0;
 
    virtual QResult broadcastMessage(const char *msg, size_t size) = 0;
 
    virtual QResult setOption(WBOption option, void *param, size_t size) = 0;
 
protected:
    virtual ~RtcWhiteboard() {}
};
 
class PanoWhiteboard
{
public:
    class Callback;
 
    virtual QResult setCallback(Callback *callback) = 0;
    virtual RtcWhiteboard* getCurrentWhiteboard() = 0;
    virtual QResult switchWhiteboard(const char *whiteboardId) = 0;
 
    class Callback
    {
    public:
        virtual void onWhiteboardStarted(const char *whiteboardId) {}
        virtual void onWhiteboardStopped(const char *whiteboardId) {}
 
        virtual ~Callback() {};
    };
 
protected:
    virtual ~PanoWhiteboard() {}
};
 
PANORTC_NS_END